Class SBGWindowWidget#

This class describes a widget. More...

#include <SBGWindowWidget.hpp>

Inherits the following classes: QWidget

Inherited by the following classes: SBGApp, SBGAssistant, SBGDataGraphNodeFactory, SBGDataGraphNodeProperties, SBGEditor

Public Slots#

Type	Name
slot void	stopHighlighting

Public Signals#

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

Public Functions#

Type	Name
	SB_DECLARE_DATA (SBGWindowWidget)
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)
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)
virtual	~SBGWindowWidget () Destructor.

Protected Attributes#

Type	Name
SBGWindowWidgetData *	dataPointer

Protected Functions#

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

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.

Public Slots Documentation#

slot stopHighlighting#

void stopHighlighting;

Public Signals Documentation#

signal shown#

Emitted when the widget is shown or hidden.

void shown;

Public Functions Documentation#

function SB_DECLARE_DATA#

SBGWindowWidget::SB_DECLARE_DATA (
    SBGWindowWidget
)

function getCitation#

Returns the citation information.

virtual QString SBGWindowWidget::getCitation () const

function getDockWindow#

Returns the pointer to the embedding dock window, if any.

SBGWindowDock * SBGWindowWidget::getDockWindow () const

function getFormat#

Returns the format.

virtual int SBGWindowWidget::getFormat () const

function getHighlightingFlag#

Returns the highlighting flag.

bool SBGWindowWidget::getHighlightingFlag () const

function getLockedFlag#

Returns whether the widget is locked (on top)

bool SBGWindowWidget::getLockedFlag () const

function getLogo#

Returns the pixmap logo.

virtual QPixmap SBGWindowWidget::getLogo () const

function getName#

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

virtual QString SBGWindowWidget::getName () const

function getUUID#

Returns the widget UUID.

virtual SBUUID SBGWindowWidget::getUUID () const

function getWindow#

Returns the pointer to the embedding window, if any.

SBGWindow * SBGWindowWidget::getWindow () const

function highlight#

Highlights the widget for a moment.

void SBGWindowWidget::highlight (
    const SBQuantity::second & duration=SBQuantity::second (1.0)
)

function loadDefaultSettings#

Loads default settings.

void SBGWindowWidget::loadDefaultSettings ()

function loadSettings#

Loads settings .

virtual void SBGWindowWidget::loadSettings (
    SBGSettings * settings
)

function saveDefaultSettings#

Saves default settings.

void SBGWindowWidget::saveDefaultSettings ()

function saveSettings#

Saves settings .

virtual void SBGWindowWidget::saveSettings (
    SBGSettings * settings
)

function setHighlightingFlag#

Sets the highlighting flag.

void SBGWindowWidget::setHighlightingFlag (
    bool highlightingFlag
)

function setLockedFlag#

Sets whether the widget is locked (on top)

void SBGWindowWidget::setLockedFlag (
    bool lockedFlag
)

function ~SBGWindowWidget#

Destructor.

virtual SBGWindowWidget::~SBGWindowWidget ()

Protected Attributes Documentation#

variable dataPointer#

SBGWindowWidgetData* dataPointer;

Protected Functions Documentation#

function SBGWindowWidget [1/2]#

SBGWindowWidget::SBGWindowWidget ()

function SBGWindowWidget [2/2]#

SBGWindowWidget::SBGWindowWidget (
    SBGWindowWidgetData * dataPointer
)

function changeEvent#

void SBGWindowWidget::changeEvent (
    QEvent * event
)

function hideEvent#

void SBGWindowWidget::hideEvent (
    QHideEvent * event
)

function showEvent#

void SBGWindowWidget::showEvent (
    QShowEvent * event
)