PluginInfo.hh

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           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.              *
*                                                                            *
\*===========================================================================*/
 
 
 
 
#ifndef PLUGININFO_HH
#define PLUGININFO_HH
 
#include <QString>
#include <QObject>
#include <QStringList>
#include <QList>
#include <QDockWidget>
#include <QToolBar>
 
struct KeyBinding{
  int                   key;
  Qt::KeyboardModifiers modifiers;
  QString               description;
  bool                  multiUse;
  bool                  slot;
};
 
struct SlotInfo{
  QString slotName;
  QString slotDescription;
  QStringList parameters;
  QStringList descriptions;
};
 
class PluginInfo{
 
  public :
 
  PluginInfo() :
  plugin(0),
  name(""),
  description(""),
  version(""),
  path(""),
  rpcName(""),
  errors(""),
  warnings(""),
  optionsWidget(0),
  buildIn(true),
  status(FAILED)
  {
    rpcFunctions.clear();
    slotInfos.clear();
    keys.clear();
    toolboxWidgets.clear();
    headerAreaWidgets.clear();
    toolboxIcons.clear();
    toolbars.clear();
    contextMenus.clear();
  }
 
  QObject*    plugin;
 
  QString     name;
 
  QString     description;
 
  QString     version;
 
  QString     path;
 
  QString     rpcName;
 
  QString     errors;
 
  QString     warnings;
 
  QStringList rpcFunctions;
 
  QList< SlotInfo > slotInfos;
 
  QList< KeyBinding > keys;
 
  std::vector< std::pair< QString , QWidget* > > toolboxWidgets;
 
  std::vector< std::pair< QString , QWidget* > > headerAreaWidgets;
 
  std::vector< QIcon* > toolboxIcons;
  
  std::vector< std::pair< QString , QToolBar* > > toolbars;
  
  std::vector< std::pair< QString , QAction* > > contextMenus;
 
  QWidget* optionsWidget;
 
  bool buildIn;
 
  enum StatusType
  {
    LOADED = 0,
    BLOCKED,
    UNLOADED,
    FAILED
  }status;
 
 
};
 
#endif //PLUGININFO_HH