Class SBGApp#

This class is the base class for App's GUI.

#include <SBGApp.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
	SBGApp (SBDApp * app) Constructs a SBGApp instance associated with the given application.
SBDApp *	getApp () const Returns a pointer to the app.
virtual Qt::DockWidgetArea	getDockWidgetArea () const Returns the preferred dock widget area.
virtual QKeySequence	getShortcut () const Returns the shortcut.
virtual QString	getToolTip () const Returns the tool tip.
virtual SBCContainerUUID	getUUID () const = 0 Returns the app GUI UUID.
virtual bool	getVerticalSpacerFlag () const Returns whether the GUI should have a vertical spacer added.
void	setApp (SBDApp * app) Sets the pointer to the app.
virtual	~SBGApp () Destroys the SBGApp instance.

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 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.

Public Functions Documentation#

function SBGApp#

Constructs a SBGApp instance associated with the given application.

SBGApp::SBGApp (
    SBDApp * app
)

Parameters:

app Pointer to the SBDApp instance to associate with this GUI.

function getApp#

Returns a pointer to the app.

SBDApp * SBGApp::getApp () const

Returns a pointer to the associated SBDApp instance.

Returns:

Pointer to the SBDApp associated with this GUI.

function getDockWidgetArea#

Returns the preferred dock widget area.

virtual Qt::DockWidgetArea SBGApp::getDockWidgetArea () const

Returns the preferred dock widget area for this application GUI.

Returns:

The Qt::DockWidgetArea indicating the preferred area.

function getShortcut#

Returns the shortcut.

virtual QKeySequence SBGApp::getShortcut () const

Returns the keyboard shortcut for this application GUI.

Returns:

A QKeySequence representing the shortcut.

function getToolTip#

Returns the tool tip.

virtual QString SBGApp::getToolTip () const

Returns the tooltip text for this application GUI.

Returns:

A QString containing the tooltip.

function getUUID#

Returns the app GUI UUID.

virtual SBCContainerUUID SBGApp::getUUID () const = 0

Implements SBGWindowWidget::getUUID

function getVerticalSpacerFlag#

Returns whether the GUI should have a vertical spacer added.

virtual bool SBGApp::getVerticalSpacerFlag () const

Indicates whether the GUI should have a vertical spacer added.

Returns:

true if a vertical spacer should be added; otherwise false.

function setApp#

Sets the pointer to the app.

void SBGApp::setApp (
    SBDApp * app
)

Sets the associated SBDApp instance for this GUI.

Parameters:

app Pointer to the SBDApp to associate.

function ~SBGApp#

Destroys the SBGApp instance.

virtual SBGApp::~SBGApp ()