pluginbase.h

Go to the documentation of this file.

#ifndef UPDRAFT_SRC_PLUGINBASE_H_
#define UPDRAFT_SRC_PLUGINBASE_H_

#include <QtGui>
#include <QStringList>

#include "coreinterface.h"
#include "tabinterface.h"
#include "menuinterface.h"

#define PLUGIN_API_VERSION 0

namespace Updraft {

#ifndef UPDRAFT_CORE
// Pointer to coreinterface, defined in each plugin.
// To access this pointer from any file of plugin, include pluginbase.h.
extern CoreInterface *g_core;
#endif

class EventInfo;

class PluginBase {
 public:
  PluginBase() {}
  virtual ~PluginBase() {}

  virtual QString getName() = 0;

  virtual unsigned getPluginApiVersion() { return PLUGIN_API_VERSION; }

  virtual void initialize(CoreInterface *coreInterface) = 0;

  virtual void deinitialize() = 0;

  virtual void fillContextMenu(MapObject* obj, MenuInterface* menu) {}

  virtual bool wantsToHandleClick(MapObject* obj) { return false; }

  virtual void handleClick(MapObject* obj, const EventInfo* evt) {}

  virtual bool fileOpen(const QString &filename, int roleId) {
    return false; }

 private:
  PluginBase(const PluginBase& other) {}
};

}  // namespace Updraft

Q_DECLARE_INTERFACE(Updraft::PluginBase, "Updraft_PluginBase")

#endif  // UPDRAFT_SRC_PLUGINBASE_H_