PluginInfo.hh 6.58 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
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
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40 41 42
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
43 44 45 46 47
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
48 49
\*===========================================================================*/

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

Dirk Wilden's avatar
Dirk Wilden committed
51 52 53 54 55 56 57 58
#ifndef PLUGININFO_HH
#define PLUGININFO_HH

#include <QString>
#include <QObject>
#include <QStringList>
#include <QList>
#include <QDockWidget>
59
#include <QToolBar>
Dirk Wilden's avatar
Dirk Wilden committed
60 61 62 63 64

struct KeyBinding{
  int                   key;
  Qt::KeyboardModifiers modifiers;
  QString               description;
Dirk Wilden's avatar
Dirk Wilden committed
65
  bool                  multiUse;
Dirk Wilden's avatar
Dirk Wilden committed
66
  bool                  slot;
Dirk Wilden's avatar
Dirk Wilden committed
67 68
};

69 70 71 72 73 74 75
struct SlotInfo{
  QString slotName;
  QString slotDescription;
  QStringList parameters;
  QStringList descriptions;
};

Dirk Wilden's avatar
Dirk Wilden committed
76
/** Type defining a currently loaded Plugin */
Jan Möbius's avatar
Jan Möbius committed
77 78 79 80
class PluginInfo{

  public :

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
  PluginInfo() :
  plugin(0),
  name(""),
  description(""),
  version(""),
  path(""),
  rpcName(""),
  optionsWidget(0),
  buildIn(true),
  status(FAILED)
  {
    rpcFunctions.clear();
    slotInfos.clear();
    keys.clear();
    toolboxWidgets.clear();
96
    headerAreaWidgets.clear();
97 98 99
    toolboxIcons.clear();
    toolbars.clear();
    contextMenus.clear();
Jan Möbius's avatar
Jan Möbius committed
100 101 102 103
  }



104 105 106 107 108 109 110 111 112 113 114
  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),
115
      headerAreaWidgets(_i.headerAreaWidgets),
116 117 118 119 120 121 122 123
      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
124
  }
Dirk Wilden's avatar
Dirk Wilden committed
125 126 127 128 129 130 131 132 133 134

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

135 136 137
  /// Version of the plugin
  QString     version;

Dirk Wilden's avatar
Dirk Wilden committed
138 139 140 141 142 143 144 145 146
  /// Path to the plugin ( set on load )
  QString     path;

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

  /// List of exported rpc slots
  QStringList rpcFunctions;

147 148 149
  /// This list contains Descriptions about public slots if available
  QList< SlotInfo > slotInfos;

Dirk Wilden's avatar
Dirk Wilden committed
150 151 152
  /// List of registered keys with description
  QList< KeyBinding > keys;

153 154
  /// Pointer to plugins toolbox widget (if available)
  std::vector< std::pair< QString , QWidget* > > toolboxWidgets;
Dirk Wilden's avatar
Dirk Wilden committed
155

156 157 158
  /// Pointer to plugins header area widgets (if available)
  std::vector< std::pair< QString , QWidget* > > headerAreaWidgets;

Dirk Wilden's avatar
Dirk Wilden committed
159 160
  /// Pointer to plugins toolbox widget icons (if available)
  std::vector< QIcon* > toolboxIcons;
161
  
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
162
  /// Pointer to plugins toolbars (if available)
163
  std::vector< std::pair< QString , QToolBar* > > toolbars;
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
164 165 166
  
  /// Pointer to plugins context menus (if available)
  std::vector< std::pair< QString , QAction* > > contextMenus;
Dirk Wilden's avatar
Dirk Wilden committed
167 168 169

  /// Pointer to plugins options widget (if available)
  QWidget* optionsWidget;
170 171 172 173 174 175 176 177 178 179 180 181 182 183

  /// 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
184 185 186
};

#endif //PLUGININFO_HH