RScriptsPlugin Class Reference

#include <RScriptsPlugin.h>

Inheritance diagram for RScriptsPlugin:

Public Member Functions
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.
	RScriptsPlugin ()
virtual void	uninit (bool)
	Called before a plugin is removed / unloaded.
virtual	~RScriptsPlugin ()
Public Member Functions inherited from RPluginInterface
virtual	~RPluginInterface ()

Additional Inherited Members
Public Types inherited from RPluginInterface
enum	InitStatus {   GotSplashWindow , AddOnsInitialized , ActionsAdded , GotMainWindowBeforeShow ,   GotMainWindow , LoadedFiles , ScriptsExecuted , AllDone }

Constructor & Destructor Documentation

RScriptsPlugin()

RScriptsPlugin::RScriptsPlugin ( )

inline

~RScriptsPlugin()

virtual RScriptsPlugin::~RScriptsPlugin ( )

inlinevirtual

Member Function Documentation

checkLicense()

virtual bool RScriptsPlugin::checkLicense ( )

inlinevirtual

Returns

True if the plugin license is valid.

Implements RPluginInterface.

getPluginInfo()

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.

Implements RPluginInterface.

init()

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.

Implements RPluginInterface.

initScriptExtensions()

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:\nThis function is not available in script environments.\n

Implements RPluginInterface.

initTranslations()

void RScriptsPlugin::initTranslations ( )

virtual

Called when the user chosen language changed.

Non-Scriptable:\nThis function is not available in script environments.\n

Implements RPluginInterface.

postInit()

virtual void RScriptsPlugin::postInit ( InitStatus status )

inlinevirtual

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.

Implements RPluginInterface.

uninit()

virtual void RScriptsPlugin::uninit ( bool remove )

inlinevirtual

Called before a plugin is removed / unloaded.

Implements RPluginInterface.

---

The documentation for this class was generated from the following files:

• src/scripts/RScriptsPlugin.h
• src/scripts/RScriptsPlugin.cpp