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:
[legend]
Collaboration diagram for QGoPlugin:
[legend]

Public Member Functions

virtual std::vector< QAction * > Actions ()=0
 
virtual QWidgetAdditionalWidget ()=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 QDockWidgetDockWidget ()=0
 
QString GoFigureCompatibilityVersion () const
 return GoFigure version for compatibility with the plugin. More...
 
QString License () const
 return License of the plugin. More...
 
virtual QMenuMenu ()=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 QToolBarToolBar ()=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...
 
- Public Member Functions inherited from QObject
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 
virtual  ~QObject ()
 

Protected Member Functions

virtual void SetAllRequiredInformation ()=0
 Set all required information (name, version, license...). More...
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

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

Private Member Functions

 Q_DISABLE_COPY (QGoPlugin)
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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: