src/plugins/qgisplugin.h

Go to the documentation of this file.

/***************************************************************************
     qgisplugin.h
     --------------------------------------
    Date                 : Sun Sep 16 12:12:31 AKDT 2007
    Copyright            : (C) 2007 by Gary E. Sherman
    Email                : sherman at mrcc dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#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
       */
    enum PLUGINTYPE
    {
      UI = 1,                     /* user interface plug-in */
      MAPLAYER,                    /* map layer plug-in */
      RENDERER,                     /*a plugin for a new renderer class*/
      VECTOR_OVERLAY                /*an overlay plugin. Added in version 1.1*/
    };


    QgisPlugin( QString const & name = "",
                QString const & description = "",
                QString const & category = "",
                QString const & version = "",
                PLUGINTYPE const & type = MAPLAYER )
        : mName( name ),
        mDescription( description ),
        mCategory( category ),
        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;
    }

    QString const & category() const
    {
      return mCategory;
    }

    QString       & category()
    {
      return mCategory;
    }

    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 mCategory;

    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 QString category_t();

typedef int type_t();

typedef QString version_t();

typedef QString icon_t();


#endif //qgisplugin_h