Syntalos::ModuleInfo

Syntalos::ModuleInfo

Static information about a module.

#include <moduleapi.h>

Public Functions

Protected Functions

Friends

Public Functions Documentation

function ModuleInfo

explicit ModuleInfo()

function ~ModuleInfo

virtual ~ModuleInfo()

function id

virtual QString id() const

Name of this module used internally as unique identifier.

function name

virtual QString name() const

Name of this module displayed to the user.

function summary

virtual QString summary() const

Very brief description of this module.

function description

virtual QString description() const

Long description of this module.

function authors

virtual QString authors() const

Developer(s) of this module, one developer name per line.

function license

virtual QString license() const

Additional licensing conditions that apply to this module.

function icon

virtual QIcon icon() const

Icon of this module.

function refreshIcon

virtual void refreshIcon()

Called when the icon should be reloaded or updated.

function color

virtual QColor color() const

The dominant color for this module.

function categories

virtual ModuleCategories categories() const

Categories this module belongs to.

function storageGroupName

virtual QString storageGroupName() const

Name of a storage group for modules of this type.

If this is left empty, modules will write into the main data storage group instead of a dedicated one.

function singleton

virtual bool singleton() const

Returns true if only one instance of this module can exist.

Return: True if singleton.

function createModule

virtual AbstractModule * createModule(
    QObject * parent =nullptr
) =0

Instantiate the actual module.

Return: A new module of this type.

function count

int count() const

function rootDir

QString rootDir() const

function setRootDir

void setRootDir(
    const QString & dir
)

Protected Functions Documentation

function setIcon

void setIcon(
    const QIcon & icon
)

Friends

friend Engine

friend class Engine(
    Engine 
);

Updated on 2024-09-05 at 17:39:59 +0000