RPluginInterface

Class in Core Module
Header: #include <src/core/RPluginInterface.h>
Inherited by: RDxfPlugin, RScriptsPlugin

Description

Interface for all C++ QCAD plugins.

Scriptable: This class is available in script environments.

Public Types

enum	InitStatus { GotSplashWindow, AddOnsInitialized, ActionsAdded, GotMainWindowBeforeShow, GotMainWindow, LoadedFiles, ScriptsExecuted, AllDone }

Public Functions

virtual	~RPluginInterface()
virtual bool	checkLicense()=0 = 0
virtual RPluginInfo	getPluginInfo()=0 = 0
virtual bool	init()=0 = 0 Called immediately after the plugin has been loaded, directly after starting the application.
virtual void	initScriptExtensions(QScriptEngine &engine)=0 = 0 Called whenever a new script engine is instantiated.
virtual void	initTranslations()=0 = 0 Called when the user chosen language changed.
virtual void	postInit(RPluginInterface::InitStatus status)=0 = 0 Called after the application has been fully loaded, directly before entering the main event loop.
virtual void	uninit(bool remove=false)=0 = 0 Called before a plugin is removed / unloaded.

Member Documentation

InitStatus

enum InitStatus

Value	Description
GotSplashWindow	Splashscreen showing.
AddOnsInitialized	Add ons are initialized, actions created but not added to widgets.
ActionsAdded	Actions have been added to widgets.
GotMainWindowBeforeShow	Main window created but not shown yet.
GotMainWindow	Main window with all tools and menus has been created.
LoadedFiles	Loaded files given on command line.
ScriptsExecuted	Executed scripts given on command line.
AllDone	Application is ready and idle.

~RPluginInterface

virtual RPluginInterface::~RPluginInterface()

virtual inline

checkLicense

virtual bool RPluginInterface::checkLicense()=0 = 0

pure virtual

Returns: True if the plugin license is valid.

Reimplemented in checkLicense, checkLicense.

getPluginInfo

virtual RPluginInfo RPluginInterface::getPluginInfo()=0 = 0

pure virtual

Returns: An RPluginInfo object with at least the following keys:

• ‘Version’ - Version string
• ‘Name’ - Plugin name
• ‘Description’ - Longer description of the plugin
• ‘License’ - Licensing information (e.g. ‘GPLv3’, ‘proprietary’, …)
• ‘URL’ - URL where more information about the plugin can be found

This is typically used by an about dialog or debugging / developer tools.

Reimplemented in getPluginInfo, getPluginInfo.

init

virtual bool RPluginInterface::init()=0 = 0

pure virtual

Called immediately after the plugin has been loaded, directly after starting the application.

Implementations typically perform plugin initialization, registration of file importers, exporter, etc.

Reimplemented in init, init.

initScriptExtensions

virtual void RPluginInterface::initScriptExtensions(QScriptEngine &engine)=0 = 0

pure virtual

Called whenever a new script engine is instantiated.

Implementations may register their own script extensions by making C / C++ code scriptable.

Non-Scriptable: This function is not available in script environments.

Reimplemented in initScriptExtensions, initScriptExtensions.

initTranslations

virtual void RPluginInterface::initTranslations()=0 = 0

pure virtual

Called when the user chosen language changed.

Non-Scriptable: This function is not available in script environments.

Reimplemented in initTranslations, initTranslations.

postInit

virtual void RPluginInterface::postInit(RPluginInterface::InitStatus status)=0 = 0

pure virtual

Called after the application has been fully loaded, directly before entering the main event loop.

Implementations typically perform initialization that depends on the application being up and running.

Reimplemented in postInit, postInit.

uninit

virtual void RPluginInterface::uninit(bool remove=false)=0 = 0

pure virtual

Called before a plugin is removed / unloaded.

Reimplemented in uninit, uninit.