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

#define SIP_NO_FILE


#include <QString>

class QgisInterface;

//#include "qgisplugingui.h"

class QgisPlugin
{
  public:

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

    @todo XXX this may be a hint that there should be subclasses
#endif

    enum PluginType
    {
      UI = 1,   
      MapLayer, 
      Renderer, 
    };


    QgisPlugin( QString const &name = "",
                QString const &description = "",
                QString const &category = "",
                QString const &version = "",
                PluginType type = MapLayer )
      : mName( name )
      , mDescription( description )
      , mCategory( category )
      , mVersion( version )
      , mType( type )
    {}

    virtual ~QgisPlugin() = default;

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

typedef QString experimental_t();

#endif // QGISPLUGIN_H