GOFIGURE2  0.9.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
QGoPlugin Class Referenceabstract

Abstract class for any kind of plugins used by GoFigure2. More...

#include <Interfaces/QGoPlugin.h>

Inheritance diagram for QGoPlugin:
Inheritance graph
[legend]
Collaboration diagram for QGoPlugin:
Collaboration graph
[legend]

Public Member Functions

virtual std::vector< QAction * > Actions ()=0
 
virtual QWidget * AdditionalWidget ()=0
 
QString Copyright () const
 return Copyright of the plugin. More...
 
QString Description () const
 return Short description of the plugin. More...
 
QString Distributor () const
 return Distributor of the plugin. More...
 
virtual QDockWidget * DockWidget ()=0
 
QString GoFigureCompatibilityVersion () const
 return GoFigure version for compatibility with the plugin. More...
 
QString License () const
 return License of the plugin. More...
 
virtual QMenu * Menu ()=0
 
QString Name () const
 return Plugin Name of the plugin. More...
 
virtual void OnTabActivated (const int &)=0
 
virtual void OnTabClosed (const int &)=0
 
virtual void OnTabMoved (const int &, const int &)=0
 
 QGoPlugin (QObject *iParent=0x0)
 Default Constructor. More...
 
virtual void ReadSettings ()=0
 Read Settings for the plugin. More...
 
virtual std::list
< GoFigure::TabDimensionType
TabElementCompatibility () const =0
 
virtual QToolBar * ToolBar ()=0
 
QString Version () const
 return Plugin Version of the plugin. More...
 
virtual void WriteSettings ()=0
 Write Settings for the plugin. More...
 
virtual ~QGoPlugin ()
 Destructor. More...
 

Protected Member Functions

virtual void SetAllRequiredInformation ()=0
 Set all required information (name, version, license...). More...
 

Protected Attributes

PluginInformationBase m_Information
 contains all information related to the plugin. More...
 

Private Member Functions

 Q_DISABLE_COPY (QGoPlugin)
 

Detailed Description

Abstract class for any kind of plugins used by GoFigure2.

Definition at line 54 of file QGoPlugin.h.

Constructor & Destructor Documentation

QGoPlugin::QGoPlugin ( QObject *  iParent = 0x0)
explicit

Default Constructor.

Definition at line 36 of file QGoPlugin.cxx.

virtual QGoPlugin::~QGoPlugin ( )
inlinevirtual

Destructor.

Definition at line 62 of file QGoPlugin.h.

Member Function Documentation

virtual std::vector< QAction * > QGoPlugin::Actions ( )
pure virtual

Implemented in medianplugin.

virtual QWidget* QGoPlugin::AdditionalWidget ( )
pure virtual

Implemented in medianplugin.

QString QGoPlugin::Copyright ( ) const

return Copyright of the plugin.

Definition at line 59 of file QGoPlugin.cxx.

QString QGoPlugin::Description ( ) const

return Short description of the plugin.

Definition at line 69 of file QGoPlugin.cxx.

QString QGoPlugin::Distributor ( ) const

return Distributor of the plugin.

Definition at line 54 of file QGoPlugin.cxx.

virtual QDockWidget* QGoPlugin::DockWidget ( )
pure virtual

Implemented in medianplugin.

QString QGoPlugin::GoFigureCompatibilityVersion ( ) const

return GoFigure version for compatibility with the plugin.

Definition at line 49 of file QGoPlugin.cxx.

QString QGoPlugin::License ( ) const

return License of the plugin.

Definition at line 64 of file QGoPlugin.cxx.

virtual QMenu* QGoPlugin::Menu ( )
pure virtual

Implemented in medianplugin.

QString QGoPlugin::Name ( ) const

return Plugin Name of the plugin.

Definition at line 39 of file QGoPlugin.cxx.

virtual void QGoPlugin::OnTabActivated ( const int &  )
pure virtual

Implemented in medianplugin.

virtual void QGoPlugin::OnTabClosed ( const int &  )
pure virtual

Implemented in medianplugin.

virtual void QGoPlugin::OnTabMoved ( const int &  ,
const int &   
)
pure virtual

Implemented in medianplugin.

QGoPlugin::Q_DISABLE_COPY ( QGoPlugin  )
private
virtual void QGoPlugin::ReadSettings ( )
pure virtual

Read Settings for the plugin.

Implemented in medianplugin.

virtual void QGoPlugin::SetAllRequiredInformation ( )
protectedpure virtual

Set all required information (name, version, license...).

Note
This method MUST be called in the constructor of any plugin which inherits from QGoPlugin.

Implemented in medianplugin.

virtual std::list< GoFigure::TabDimensionType > QGoPlugin::TabElementCompatibility ( ) const
pure virtual

Implemented in medianplugin.

virtual QToolBar* QGoPlugin::ToolBar ( )
pure virtual

Implemented in medianplugin.

QString QGoPlugin::Version ( ) const

return Plugin Version of the plugin.

Definition at line 44 of file QGoPlugin.cxx.

virtual void QGoPlugin::WriteSettings ( )
pure virtual

Write Settings for the plugin.

Implemented in medianplugin.

Member Data Documentation

PluginInformationBase QGoPlugin::m_Information
protected

contains all information related to the plugin.

Todo:
it would not be a bad idea to use a xml file instead.

Definition at line 121 of file QGoPlugin.h.


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