QCAD
Open Source 2D CAD
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
RPluginInterface Class Reference

Interface for all C++ QCAD plugins. More...

#include <RPluginInterface.h>

Inheritance diagram for RPluginInterface:
RDxfPlugin

List of all members.

Public Types

enum  InitStatus {
  GotSplashWindow, GotMainWindow, LoadedFiles, ScriptsExecuted,
  AllDone
}

Public Member Functions

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

Detailed Description

Interface for all C++ QCAD plugins.

Scriptable:
This class is wrapped for script environments.

Member Enumeration Documentation

Enumerator:
GotSplashWindow 

Splashscreen showing.

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.


Constructor & Destructor Documentation

virtual RPluginInterface::~RPluginInterface ( )
inlinevirtual

Member Function Documentation

virtual RPluginInfo RPluginInterface::getPluginInfo ( )
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.

Implemented in RDxfPlugin.

virtual bool RPluginInterface::init ( )
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.

Implemented in RDxfPlugin.

virtual void RPluginInterface::initScriptExtensions ( QScriptEngine &  engine)
pure virtual

Called whenever a new script engine is instantiated.

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

   \par Non-Scriptable:

This function is not available in script environments.

Implemented in RDxfPlugin.

virtual void RPluginInterface::postInit ( RPluginInterface::InitStatus  status)
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.

Implemented in RDxfPlugin.

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

Called before a plugin is removed / unloaded.

Implemented in RDxfPlugin.


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