SAMSON.hpp File Reference

Classes

class  SAMSON
 This class is the main interface. More...
 

Macros

#define SB_ELEMENT_PATH
 Provides a std::string containing the path where the SAMSON Extension is installed. More...
 

Functions

 SB_REGISTER_TYPE (SAMSON, "SAMSON", "98679A42-87A7-2B49-25ED-449B803C5BDB")
 

Macro Definition Documentation

◆ SB_ELEMENT_PATH

#define SB_ELEMENT_PATH

This macro provides a std::string containing the path where the SAMSON Extension is installed.

When SAMSON is running, SAMSON Extensions are located at a specific location in the SAMSON installation folder. When a SAMSON Extension needs to retrieve a resource, (e.g. an icon), this macro may be used to easily locate the resource.

For example, for SAMSON Extensions generated by the SAMSON Extension generator, icons are located in the resource folder. When the SAMSON Extension needs to return an icon, the macro may be used as follows:

return QPixmap(QString::fromStdString(SB_ELEMENT_PATH + "/Resource/icons/logo.png"));
#define SB_ELEMENT_PATH
Provides a std::string containing the path where the SAMSON Extension is installed.
Definition: SAMSON.hpp:595