Class SBGApp

ClassList > SBGApp

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

• #include <SBGApp.hpp>

Inherits the following classes: SBGWindowWidget

Public Slots inherited from SBGWindowWidget

See SBGWindowWidget

Type	Name
slot void	stopHighlighting

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)
	SB_DECLARE_DATA (SBGApp)
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 ()

Public Functions inherited from SBGWindowWidget

See SBGWindowWidget

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 inherited from SBGWindowWidget

See SBGWindowWidget

Type	Name
SBGWindowWidgetData *	dataPointer

Protected Functions inherited from SBGWindowWidget

See SBGWindowWidget

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

Public Functions Documentation

function SBGApp

SBGApp::SBGApp (
    SBDApp * app
) 

---

function SB_DECLARE_DATA

SBGApp::SB_DECLARE_DATA (
    SBGApp
) 

---

function getApp

Returns a pointer to the app.

SBDApp * SBGApp::getApp () const

---

function getDockWidgetArea

Returns the preferred dock widget area.

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

---

function getShortcut

Returns the shortcut.

virtual QKeySequence SBGApp::getShortcut () const

---

function getToolTip

Returns the tool tip.

virtual QString SBGApp::getToolTip () const

---

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

---

function setApp

Sets the pointer to the app.

void SBGApp::setApp (
    SBDApp * app
) 

---

function ~SBGApp

virtual SBGApp::~SBGApp () 

---