Loading...
Searching...
No Matches
SBGWindowWidget Class Reference

This class describes a widget. More...

Constructors and destructors

SBGWindowWidgetData * dataPointer
 
 SBGWindowWidget ()
 
 SBGWindowWidget (SBGWindowWidgetData *dataPointer)
 
void hideEvent (QHideEvent *event)
 
void showEvent (QShowEvent *event)
 
void changeEvent (QEvent *event)
 

Constructor and destructor

virtual ~SBGWindowWidget ()
 Destructor.
 

Identity

virtual SBUUID getUUID () const
 Returns the widget UUID.
 
virtual QString getName () const
 Returns the widget name (used as a title for the embedding window)
 
virtual QPixmap getLogo () const
 Returns the pixmap logo.
 
virtual int getFormat () const
 Returns the format.
 
virtual QString getCitation () const
 Returns the citation information.
 

Embedding window

SBGWindowgetWindow () const
 Returns the pointer to the embedding window, if any.
 
SBGWindowDockgetDockWindow () const
 Returns the pointer to the embedding dock window, if any.
 

Settings

virtual void loadSettings (SBGSettings *settings)
 Loads settings.
 
virtual void saveSettings (SBGSettings *settings)
 Saves settings.
 
void loadDefaultSettings ()
 Loads default settings

 
void saveDefaultSettings ()
 Saves default settings

 

Locking

void setLockedFlag (bool lockedFlag)
 Sets whether the widget is locked (on top)
 
bool getLockedFlag () const
 Returns whether the widget is locked (on top)
 

Highlighting

void highlight (const SBQuantity::second &duration=SBQuantity::second(1.0))
 Highlights the widget for a moment.
 
bool getHighlightingFlag () const
 Returns the highlighting flag.
 
void setHighlightingFlag (bool highlightingFlag)
 Sets the highlighting flag.
 
 SB_DECLARE_DATA (SBGWindowWidget)
 
void stopHighlighting ()
 
void shown (bool)
 Emitted when the widget is shown or hidden.
 

Detailed Description

This class describes a widget that can be embedded into a window, to display it in SAMSON's GUI and ensure that it has the appropriate SAMSON style. SBGWindowWidget derives from QWidget. Many SAMSON GUI classes derive from SBGWindowWidget, and SAMSON Extensions implement GUIs by deriving directly or indirectly from it. For example, SAMSON Extensions implements GUIs of apps by deriving from the SBGApp class, which derives from SBGWindowWidget.

Member Function Documentation

◆ getFormat()

◆ getLogo()

◆ getName()

◆ getUUID()

◆ loadSettings()

◆ saveSettings()