radiant/pluginmanager.h

   1 /*
   2    Copyright (C) 1999-2006 Id Software, Inc. and contributors.
   3    For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    GtkRadiant is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #if !defined( INCLUDED_PLUGINMANAGER_H )
  23 #define INCLUDED_PLUGINMANAGER_H
  24
  25 #include <cstddef>
  26 #include <uilib/uilib.h>
  27
  28
  29 /*!
  30    \class IPlugin
  31    pure virtual interface for a plugin
  32    temporary solution for migration from old plugin tech to synapse plugins
  33  */
  34 class IPlugIn {
  35 public:
  36     IPlugIn()
  37     {}
  38
  39     virtual ~IPlugIn()
  40     {}
  41
  42     virtual const char *getMenuName() = 0;
  43
  44     virtual std::size_t getCommandCount() = 0;
  45
  46     virtual const char *getCommand(std::size_t) = 0;
  47
  48     virtual const char *getCommandTitle(std::size_t) = 0;
  49
  50     virtual void addMenuID(std::size_t) = 0;
  51
  52     virtual bool ownsCommandID(std::size_t n) = 0;
  53 };
  54
  55 class PluginsVisitor {
  56 public:
  57     virtual void visit(IPlugIn &plugin) = 0;
  58 };
  59
  60 class CPlugInManager {
  61 public:
  62     void Dispatch(std::size_t n, const char *p);
  63
  64     void Init(ui::Widget main_window);
  65
  66     void constructMenu(PluginsVisitor &menu);
  67
  68     void Shutdown();
  69 };
  70
  71 CPlugInManager &GetPlugInMgr();
  72
  73 #endif