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 Element is installed. More...

Macro Definition Documentation

SB_ELEMENT_PATH

#define SB_ELEMENT_PATH

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

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

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

return QPixmap(QString::fromStdString(SB_ELEMENT_PATH + "/Resource/icons/logo.png"));