qgisplugin.h

Go to the documentation of this file.

#ifndef QGISPLUGIN_H
#define QGISPLUGIN_H


#include <QString>

class QgisInterface;

//#include "qgisplugingui.h"

class QgisPlugin
{
  public:

    //virtual QgisPluginGui *gui()=0;
    /* enum ELEMENTS {
       MENU,
       MENU_ITEM,
       TOOLBAR,
       TOOLBAR_BUTTON,
       };

       @todo XXX this may be a hint that there should be subclasses
       */
    typedef enum PLUGINTYPE
    {
      UI = 1,                     /* user interface plug-in */
      MAPLAYER,                    /* map layer plug-in */
      RENDERER                     /*a plugin for a new renderer class*/
    };


    QgisPlugin ( QString const & name = "", 
        QString const & description = "",
        QString const & version = "",
        PLUGINTYPE const & type = MAPLAYER )
      : mName(name), 
      mDescription(description),
      mVersion(version),
      mType(type)
      {}

    virtual ~QgisPlugin()
    {}

    QString const & name() const
    {
      return mName;
    }

    QString       & name() 
    {
      return mName;
    }

    QString const & version() const
    {
      return mVersion;
    }

    QString & version() 
    {
      return mVersion;
    }

    QString const & description() const
    { 
      return mDescription;
    }

    QString       & description()
    { 
      return mDescription;
    }

    QgisPlugin::PLUGINTYPE const & type() const
    {
      return mType;
    }


    QgisPlugin::PLUGINTYPE       & type() 
    {
      return mType;
    }

    virtual void initGui() = 0;

    virtual void unload() = 0;

  private:

    QString mName;

    QString mDescription;

    QString mVersion;


    PLUGINTYPE mType;

}; // class QgisPlugin


// Typedefs used by qgis main app

typedef QgisPlugin *create_t(QgisInterface *);

typedef void unload_t(QgisPlugin *);

typedef QString name_t();

typedef QString description_t();

typedef int type_t();

typedef QString version_t();


#endif //qgisplugin_h

---