PluginInfo.hh 5.82 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2014 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33 34 35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36 37 38 39 40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41 42
\*===========================================================================*/

Jan Möbius's avatar
Jan Möbius committed
43

Dirk Wilden's avatar
Dirk Wilden committed
44 45 46 47 48 49 50 51 52 53 54 55 56
#ifndef PLUGININFO_HH
#define PLUGININFO_HH

#include <QString>
#include <QObject>
#include <QStringList>
#include <QList>
#include <QDockWidget>

struct KeyBinding{
  int                   key;
  Qt::KeyboardModifiers modifiers;
  QString               description;
Dirk Wilden's avatar
Dirk Wilden committed
57
  bool                  multiUse;
Dirk Wilden's avatar
Dirk Wilden committed
58
  bool                  slot;
Dirk Wilden's avatar
Dirk Wilden committed
59 60
};

61 62 63 64 65 66 67
struct SlotInfo{
  QString slotName;
  QString slotDescription;
  QStringList parameters;
  QStringList descriptions;
};

Dirk Wilden's avatar
Dirk Wilden committed
68
/** Type defining a currently loaded Plugin */
Jan Möbius's avatar
Jan Möbius committed
69 70 71 72
class PluginInfo{

  public :

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
  PluginInfo() :
  plugin(0),
  name(""),
  description(""),
  version(""),
  path(""),
  rpcName(""),
  optionsWidget(0),
  buildIn(true),
  status(FAILED)
  {
    rpcFunctions.clear();
    slotInfos.clear();
    keys.clear();
    toolboxWidgets.clear();
    toolboxIcons.clear();
    toolbars.clear();
    contextMenus.clear();
Jan Möbius's avatar
Jan Möbius committed
91 92 93 94
  }



95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
  PluginInfo( const PluginInfo& _i) :
      plugin(_i.plugin),
      name(_i.name),
      description(_i.description),
      version(_i.version),
      path(_i.path),
      rpcName(_i.rpcName),
      rpcFunctions(_i.rpcFunctions),
      slotInfos(_i.slotInfos),
      keys(_i.keys),
      toolboxWidgets(_i.toolboxWidgets),
      toolboxIcons(_i.toolboxIcons),
      toolbars(_i.toolbars),
      contextMenus(_i.contextMenus),
      optionsWidget(_i.optionsWidget),
      buildIn(_i.buildIn),
      status(_i.status)
  {

Jan Möbius's avatar
Jan Möbius committed
114
  }
Dirk Wilden's avatar
Dirk Wilden committed
115 116 117 118 119 120 121 122 123 124

  /// Pointer to the loaded plugin (Already casted when loading it)
  QObject*    plugin;

  /// Name of the plugin ( requested from the plugin on load)
  QString     name;

  /// Description of the plugin ( requested from the plugin on load)
  QString     description;

125 126 127
  /// Version of the plugin
  QString     version;

Dirk Wilden's avatar
Dirk Wilden committed
128 129 130 131 132 133 134 135 136
  /// Path to the plugin ( set on load )
  QString     path;

  /// Clean rpc name of the plugin
  QString     rpcName;

  /// List of exported rpc slots
  QStringList rpcFunctions;

137 138 139
  /// This list contains Descriptions about public slots if available
  QList< SlotInfo > slotInfos;

Dirk Wilden's avatar
Dirk Wilden committed
140 141 142
  /// List of registered keys with description
  QList< KeyBinding > keys;

143 144
  /// Pointer to plugins toolbox widget (if available)
  std::vector< std::pair< QString , QWidget* > > toolboxWidgets;
Dirk Wilden's avatar
Dirk Wilden committed
145 146 147

  /// Pointer to plugins toolbox widget icons (if available)
  std::vector< QIcon* > toolboxIcons;
148
  
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
149
  /// Pointer to plugins toolbars (if available)
150
  std::vector< std::pair< QString , QToolBar* > > toolbars;
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
151 152 153
  
  /// Pointer to plugins context menus (if available)
  std::vector< std::pair< QString , QAction* > > contextMenus;
Dirk Wilden's avatar
Dirk Wilden committed
154 155 156

  /// Pointer to plugins options widget (if available)
  QWidget* optionsWidget;
157 158 159 160 161 162 163 164 165 166 167 168 169 170

  /// Indicates, if the plugin is a built in Plugin (in Plugin directory)
  bool buildIn;

  /// current status of the plugin
  enum StatusType
  {
    LOADED = 0,
    BLOCKED,
    UNLOADED,
    FAILED
  }status;


Dirk Wilden's avatar
Dirk Wilden committed
171 172 173
};

#endif //PLUGININFO_HH