Class SBGAssistant#
This class is the base class for an assistant GUI.
#include <SBGAssistant.hpp>
Inherits the following classes: SBGWindowWidget
Public Slots inherited from SBGWindowWidget#
See SBGWindowWidget
| Type | Name |
|---|---|
| slot void | stopHighlighting |
Public Signals#
| Type | Name |
|---|---|
| signal void | stepAdded (const QString & step) |
| signal void | thoughtAdded (const QString & thought) |
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 |
|---|---|
| SBGAssistant (SBDAssistant * app) |
|
| SB_DECLARE_DATA (SBGAssistant) |
|
| SBDAssistant * | getAssistant () const Returns a pointer to the assistant. |
| virtual SBCContainerUUID | getUUID () const = 0 Returns the assistant GUI UUID. |
| void | setAssistant (SBDAssistant * app) Sets the pointer to the assistant. |
| virtual | ~SBGAssistant () |
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 Signals Documentation#
signal stepAdded#
signal thoughtAdded#
Public Functions Documentation#
function SBGAssistant#
function SB_DECLARE_DATA#
function getAssistant#
Returns a pointer to the assistant.
function getUUID#
Returns the assistant GUI UUID.
Implements SBGWindowWidget::getUUID
function setAssistant#
Sets the pointer to the assistant.