RScriptsPlugin
Class
Header: #include <src/scripts/RScriptsPlugin.h>
Inherits: QObject, RPluginInterface
Public Functions
Section titled “Public Functions”RScriptsPlugin() |
|
| virtual | ~RScriptsPlugin() |
| virtual bool | checkLicense() |
| virtual RPluginInfo | getPluginInfo() |
| virtual bool | init()Called immediately after the plugin has been loaded, directly after starting the application. |
| virtual void | initScriptExtensions(QScriptEngine &engine)Called whenever a new script engine is instantiated. |
| virtual void | initTranslations()Called when the user chosen language changed. |
| virtual void | postInit(InitStatus)Called after the application has been fully loaded, directly before entering the main event loop. |
| virtual void | uninit(bool)Called before a plugin is removed / unloaded. |
Member Documentation
Section titled “Member Documentation”RScriptsPlugin
Section titled “RScriptsPlugin”RScriptsPlugin::RScriptsPlugin()inline
~RScriptsPlugin
Section titled “~RScriptsPlugin”virtual RScriptsPlugin::~RScriptsPlugin()virtual inline
checkLicense
Section titled “checkLicense”virtual bool RScriptsPlugin::checkLicense()virtual inline
Returns: True if the plugin license is valid.
Reimplemented from checkLicense.
getPluginInfo
Section titled “getPluginInfo”virtual RPluginInfo RScriptsPlugin::getPluginInfo()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 from getPluginInfo.
virtual bool RScriptsPlugin::init()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 from init.
initScriptExtensions
Section titled “initScriptExtensions”virtual void RScriptsPlugin::initScriptExtensions(QScriptEngine &engine)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 from initScriptExtensions.
initTranslations
Section titled “initTranslations”virtual void RScriptsPlugin::initTranslations()virtual
Called when the user chosen language changed.
Non-Scriptable: This function is not available in script environments.
Reimplemented from initTranslations.
postInit
Section titled “postInit”virtual void RScriptsPlugin::postInit(InitStatus)virtual inline
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 from postInit.
uninit
Section titled “uninit”virtual void RScriptsPlugin::uninit(bool)virtual inline
Called before a plugin is removed / unloaded.
Reimplemented from uninit.