xentara-plugin v1.2.1
The Xentara Plugin Framework
Loading...
Searching...
No Matches
xentara::plugin::Plugin Class Referenceabstract

Base class for the Xentara plugin object. More...

#include <plugin/Plugin.hpp>

+ Inheritance diagram for xentara::plugin::Plugin:

Classes

class  Registry
 

Public Member Functions

virtual internal ~Plugin ()=0
 Virtual destructor.
 
virtual auto registerObjects (Registry &registry) -> void=0
 Called by the framework to regsiter all objects.
 

Detailed Description

Base class for the Xentara plugin object.

Each plugin must have a single plugin object derived from this class. The object must have static storage duration, meaning it must be a static member variable or a global variable.

See also
The Global Plugin Object

Constructor & Destructor Documentation

◆ ~Plugin()

xentara::plugin::Plugin::~Plugin ( )
pure virtualdefault

Virtual destructor.

Member Function Documentation

◆ registerObjects()

virtual auto xentara::plugin::Plugin::registerObjects ( Registry registry) -> void
pure virtual

Called by the framework to regsiter all objects.

Parameters
registryThe registry that should be used to register the objects