NCL Composer  0.1.5
 All Classes Functions Variables Pages
composer::extension::IPluginFactory Class Referenceabstract

A Factory interface for building plugin instances. More...

#include <IPluginFactory.h>

Inheritance diagram for composer::extension::IPluginFactory:
Collaboration diagram for composer::extension::IPluginFactory:

Public Member Functions

virtual IPlugincreatePluginInstance ()=0
 Through this call the core is able to create a new plugin instance. More...
 
virtual void releasePluginInstance (IPlugin *)=0
 When an Project is closed by the user and it is no longer necessary, Composer Core will use this call to release the plugin instance. More...
 
virtual QString id () const =0
 
virtual QString name () const =0
 
virtual QIcon icon () const
 
virtual QWidget * getPreferencePageWidget ()
 
virtual void setDefaultValues ()
 
virtual void applyValues ()
 
virtual QList< LanguageType > getSupportedLanguages ()
 
virtual QString version ()
 
virtual QString compatVersion ()
 
virtual QString vendor ()
 
virtual QString copyright ()
 
virtual QString license ()
 
virtual QString description ()
 
virtual QString url ()
 
virtual QString category ()
 

Detailed Description

A Factory interface for building plugin instances.

This extension point is used by the core to build instances of an specific plugin. Each instance can be related to a different open project. Each plugin instance is binded with its project instance during the setup of this project. The whole process is transparent for plugin developers.

Definition at line 35 of file IPluginFactory.h.

Member Function Documentation

virtual IPlugin* composer::extension::IPluginFactory::createPluginInstance ( )
pure virtual

Through this call the core is able to create a new plugin instance.

Returns
The new plugin instance.

Implemented in PropertiesViewFactory, OutlineViewFactory, NCLTextualViewPluginFactory, DebugConsoleFactory, QnstComposerPluginFactory, and QnlyComposerPluginFactory.

virtual void composer::extension::IPluginFactory::releasePluginInstance ( IPlugin )
pure virtual

When an Project is closed by the user and it is no longer necessary, Composer Core will use this call to release the plugin instance.

When an Project is closed by the user and it is no longer necessary, Composer Core will use this call to release the plugin instance.that was associated with this Project. By default, the plugin developer should free all memory it is using. But, this is he/she choice, once his implementation can also share some data among all the plugins instances.

Parameters
Theplugin instance.

Implemented in PropertiesViewFactory, OutlineViewFactory, NCLTextualViewPluginFactory, DebugConsoleFactory, QnstComposerPluginFactory, and QnlyComposerPluginFactory.

Here is the caller graph for this function:


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