PluginInfo.hh 5.41 KB
Newer Older
1 2 3 4 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 33 34 35 36 37 38 39 40 41 42
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           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/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
 *                                                                           *
\*===========================================================================*/

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 57
#ifndef PLUGININFO_HH
#define PLUGININFO_HH

#include <Qt>
#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
58
  bool                  multiUse;
Dirk Wilden's avatar
Dirk Wilden committed
59
  bool                  slot;
Dirk Wilden's avatar
Dirk Wilden committed
60 61
};

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

Dirk Wilden's avatar
Dirk Wilden committed
69
/** Type defining a currently loaded Plugin */
Jan Möbius's avatar
Jan Möbius committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83
class PluginInfo{

  public :

  PluginInfo() {
     plugin = 0;
     name = "";
     description = "";
     version = "";
     path = "";
     rpcName = "";
     rpcFunctions.clear();
     slotInfos.clear();
     keys.clear();
84 85
     toolboxWidgets.clear();
     toolbars.clear();
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
86
     contextMenus.clear();
Dirk Wilden's avatar
Dirk Wilden committed
87
     optionsWidget = 0;
Jan Möbius's avatar
Jan Möbius committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101
  }



  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;
102 103
     toolboxWidgets = _i.toolboxWidgets;
     toolbars = _i.toolbars;
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
104
     contextMenus = _i.contextMenus;
Dirk Wilden's avatar
Dirk Wilden committed
105
     optionsWidget = _i.optionsWidget;
Jan Möbius's avatar
Jan Möbius committed
106
  }
Dirk Wilden's avatar
Dirk Wilden committed
107 108 109 110 111 112 113 114 115 116

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

117 118 119
  /// Version of the plugin
  QString     version;

Dirk Wilden's avatar
Dirk Wilden committed
120 121 122 123 124 125 126 127 128
  /// Path to the plugin ( set on load )
  QString     path;

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

  /// List of exported rpc slots
  QStringList rpcFunctions;

129 130 131
  /// This list contains Descriptions about public slots if available
  QList< SlotInfo > slotInfos;

Dirk Wilden's avatar
Dirk Wilden committed
132 133 134
  /// List of registered keys with description
  QList< KeyBinding > keys;

135 136 137
  /// Pointer to plugins toolbox widget (if available)
  std::vector< std::pair< QString , QWidget* > > toolboxWidgets;
  
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
138
  /// Pointer to plugins toolbars (if available)
139
  std::vector< std::pair< QString , QToolBar* > > toolbars;
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
140 141 142
  
  /// Pointer to plugins context menus (if available)
  std::vector< std::pair< QString , QAction* > > contextMenus;
Dirk Wilden's avatar
Dirk Wilden committed
143 144 145

  /// Pointer to plugins options widget (if available)
  QWidget* optionsWidget;
Dirk Wilden's avatar
Dirk Wilden committed
146 147 148
};

#endif //PLUGININFO_HH