Class SBGDataGraphNodeProperties#

ClassList > SBGDataGraphNodeProperties

This class describes a widget that allows users to view and potentially edit properties of data graph nodes. More...

#include <SBGDataGraphNodeProperties.hpp>

Inherits the following classes: SBGWindowWidget

Public Slots inherited from SBGWindowWidget#

Type	Name
slot void	stopHighlighting Handles the stop highlighting.

Public Signals inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
signal void	shown (bool) Emitted when the widget is shown or hidden.

Public Functions#

Type	Name
virtual int	getFormat () override const Returns the format.
virtual QPixmap	getLogo () override const Returns the pixmap logo.
virtual QString	getName () override const Returns the widget name (used as a title for the embedding window)
virtual SBUUID	getUUID () override const Returns the widget UUID.
virtual void	loadSettings (SBGSettings * setting) override Loads `settings` .
virtual void	saveSettings (SBGSettings * setting) override Saves `settings` .
virtual bool	setup () Initializes the properties widget for the context menu.
virtual bool	setup (SBNode * node) Initializes the properties widget for a specific node.
virtual	~SBGDataGraphNodeProperties () Destructor.

Public Functions inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
virtual QString	getCitation () const Returns the citation information.
SBGWindowDock *	getDockWindow () const Returns the pointer to the embedding dock window, if any.
virtual int	getFormat () const Returns the format.
bool	getHighlightingFlag () const Returns the highlighting flag.
bool	getLockedFlag () const Returns whether the widget is locked (on top)
virtual QPixmap	getLogo () const Returns the pixmap logo.
virtual QString	getName () const Returns the widget name (used as a title for the embedding window)
SBUUID	getPreferencesUUID () const Returns the UUID of preferences (static attributes), if present.
virtual SBUUID	getUUID () const Returns the widget UUID.
SBGWindow *	getWindow () const Returns the pointer to the embedding window, if any.
void	highlight (const SBQuantity::second & duration=SBQuantity::second(1.0)) Highlights the widget for a moment.
void	loadDefaultSettings () Loads default settings.
virtual void	loadSettings (SBGSettings * settings) Loads `settings` .
void	saveDefaultSettings () Saves default settings.
virtual void	saveSettings (SBGSettings * settings) Saves `settings` .
void	setHighlightingFlag (bool highlightingFlag) Sets the highlighting flag.
void	setLockedFlag (bool lockedFlag) Sets whether the widget is locked (on top)
void	setPreferencesUUID (const SBUUID & preferencesUUID) Sets the UUID of preferences (static attributes), if present.
virtual	~SBGWindowWidget () Destructor.

Protected Attributes inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
SBGWindowWidgetData *	dataPointer A pointer to the private data.

Protected Functions#

Type	Name
	SBGDataGraphNodeProperties () Protected constructor.

Protected Functions inherited from SBGWindowWidget#

See SBGWindowWidget

Type	Name
	SBGWindowWidget () Protected constructor.
	SBGWindowWidget (SBGWindowWidgetData * dataPointer) Protected constructor.
void	changeEvent (QEvent * event) Handles events.
void	hideEvent (QHideEvent * event) Handles hide event.
void	showEvent (QShowEvent * event) Handles show event.

Detailed Description#

Short name: SBGNodeProperties

Public Functions Documentation#

function getFormat#

Returns the format.

virtual int SBGDataGraphNodeProperties::getFormat () override const

Returns the widget's format identifier.

This value indicates the widget's format type.

Returns:

The format value.

Implements SBGWindowWidget::getFormat

function getLogo#

Returns the pixmap logo.

virtual QPixmap SBGDataGraphNodeProperties::getLogo () override const

Returns the widget's logo pixmap.

The logo can be displayed in the user interface.

Returns:

The logo image.

Implements SBGWindowWidget::getLogo

function getName#

Returns the widget name (used as a title for the embedding window)

virtual QString SBGDataGraphNodeProperties::getName () override const

Returns the widget's name, used as a title for the embedding window.

The name provides a human-readable identifier for the widget.

Returns:

The name of the widget.

Implements SBGWindowWidget::getName

function getUUID#

Returns the widget UUID.

virtual SBUUID SBGDataGraphNodeProperties::getUUID () override const

Returns the widget's universally unique identifier.

This identifier can be used to distinguish the widget type.

Returns:

The UUID of the widget.

Implements SBGWindowWidget::getUUID

function loadSettings#

Loads settings .

virtual void SBGDataGraphNodeProperties::loadSettings (
    SBGSettings * setting
) override

Loads the widget's settings from the provided settings object.

This method populates the widget's state based on stored configuration.

Parameters:

setting The settings object to load from.

Implements SBGWindowWidget::loadSettings

function saveSettings#

Saves settings .

virtual void SBGDataGraphNodeProperties::saveSettings (
    SBGSettings * setting
) override

Saves the widget's settings to the provided settings object.

This method stores the widget's current configuration.

Parameters:

setting The settings object to save to.

Implements SBGWindowWidget::saveSettings

function setup [1/2]#

Initializes the properties widget for the context menu.

virtual bool SBGDataGraphNodeProperties::setup ()

This method prepares the widget for use in a generic context.

Returns:

true if initialization succeeded; otherwise false.

function setup [2/2]#

Initializes the properties widget for a specific node.

virtual bool SBGDataGraphNodeProperties::setup (
    SBNode * node
)

This method prepares the widget to display properties of the given node.

Parameters:

node The node for which to display properties.

Returns:

true if initialization succeeded; otherwise false.

function ~SBGDataGraphNodeProperties#

Destructor.

virtual SBGDataGraphNodeProperties::~SBGDataGraphNodeProperties ()

Destroys the SBGDataGraphNodeProperties widget.

The destructor releases any resources held by the widget.

Protected Functions Documentation#

function SBGDataGraphNodeProperties#

Protected constructor.

SBGDataGraphNodeProperties::SBGDataGraphNodeProperties ()

Constructs a new SBGDataGraphNodeProperties widget.

This constructor initializes the widget but does not perform any additional setup.