Class SBDApp#

This class is the base class for apps. More...

#include <SBDApp.hpp>

Inherits the following classes: SBCReferenceTarget

Public Functions#

Type	Name
	SBDApp () Constructs an app.
	SB_DECLARE_DATA (SBDApp)
SBGApp *	getGUI () const Returns a pointer to the GUI of the app.
void	setGUI (SBGApp * gui) Sets the pointer to the GUI of the app.
virtual	~SBDApp () Destructs the app.

Public Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget ()
unsigned int	getMemoryFootprint () const
void	printReferencesToOwners () const
virtual	~SBCReferenceTarget ()

Protected Attributes inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer

Protected Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer)
void	removeAllReferenceOwners ()

Detailed Description#

This class is the base class for all apps in SAMSON.

Apps are classes that may provide any type of functionality to SAMSON users. An app may be e.g. a connector to an external executable or web service, may wrap previously developed code to integrate its functionality with SAMSON and other SAMSON Extensions, or provide entirely new functionality based on the SAMSON Application Programming Interface (API). When SAMSON loads an app during startup, it includes it in the app menu and the app toolbar. When users open an app from the app menu or app toolbar, the Graphical User Interface (GUI) of the app appears, and the user may start using it.

An app is typically implemented by writing two classes:

one that derives from the SBDApp class, to implement the core functionality of the app (i.e. the functions that may be exposed to SAMSON and SAMSON Extensions through the Introspection)
one that derives from the SBGApp class, to implement the GUI of the App (i.e. the widgets used to visually interact with the app).

Please refer to the documentation about the SAMSON Extension Generator and the Tutorials for more information about writing new apps for SAMSON.

Short name: SBApp

See also: SAMSON Extensions, Tutorials, SBGApp

Public Functions Documentation#

function SBDApp#

Constructs an app.

SBDApp::SBDApp ()

function SB_DECLARE_DATA#

SBDApp::SB_DECLARE_DATA (
    SBDApp
)

function getGUI#

Returns a pointer to the GUI of the app.

SBGApp * SBDApp::getGUI () const

function setGUI#

Sets the pointer to the GUI of the app.

void SBDApp::setGUI (
    SBGApp * gui
)

function ~SBDApp#

Destructs the app.

virtual SBDApp::~SBDApp ()