ToolboxInterface.hh 3.32 KB
Newer Older
Jan Möbius's avatar
 
Jan Möbius committed
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 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
//=============================================================================
//
//                               OpenFlipper
//        Copyright (C) 2008 by Computer Graphics Group, RWTH Aachen
//                           www.openflipper.org
//
//-----------------------------------------------------------------------------
//
//                                License
//
//  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.
//
//  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 Lesser General Public License
//  along with OpenFlipper.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
//
//   $Revision$
//   $Author$
//   $Date$
//
//=============================================================================




//
// C++ Interface: BasePlugin
//
// Description:
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

#ifndef TOOLBOXINTERFACE_HH
#define TOOLBOXINTERFACE_HH

 #include <QtGui>
 #include <QMenuBar>
 #include <QStringList>
 #include <OpenFlipper/common/Types.hh>

 /**
 * This Interface should be used by plugins which will provide a toolbox widget.
 * Each Plugin can create own Widgets in the Toolbox area as long as they use the returned widget as their parent.
 * ToolboxInterface::initializeToolbox(QWidget*& _widget). You can create extra Signals and slots in your Plugin.
 * These can be connected between your toolbox and your plugin. Signals and slots across plugins are currently
 * not available but may be possible via an internal message system later.\n
 */
class ToolboxInterface {

   private slots :

   public :

      /// Destructor
      virtual ~ToolboxInterface() {};

      /**   \brief Initialize the Toolbar Widget
       *
       *  Initialize the toolbar (create a widget and return a pointer to it ) \n
       * \n
       *   Example : \n
       *  _widget = new QWidget();  \n
       *  \n
       * In the widget you can add anything you want.
       * @param _widget Pointer to the new Widget
       * @return Return true if a widget has been created
      */
Dirk Wilden's avatar
Dirk Wilden committed
79
      virtual bool initializeToolbox(QWidget*& /*_widget*/) = 0;
Jan Möbius's avatar
 
Jan Möbius committed
80 81 82 83 84 85

       /** \brief The Toolbox of this Widget is activated/deactivated
       *
       * Called, when the user selected this widgets toolbox
       * @param _active (when true, toolbox has been activated else deactivated)
       */
Dirk Wilden's avatar
Dirk Wilden committed
86
      virtual void toolboxActivated(bool /*_active*/ ) = 0;
Jan Möbius's avatar
 
Jan Möbius committed
87 88 89 90 91 92 93 94 95 96

    signals :

       /** \brief Defines a new ViewMode
       *
       * Slot defines a new ViewMode e.g. a mode where only useful widgets
       * are visible by default
       * @param _mode name of the ViewMode
       * @param _usedWidgets list of used Widgets names
       */
Dirk Wilden's avatar
Dirk Wilden committed
97
      virtual void defineViewMode(QString& /*_mode*/, QStringList& /*_usedWidgets*/){};
Jan Möbius's avatar
 
Jan Möbius committed
98 99 100 101 102 103 104


};

Q_DECLARE_INTERFACE(ToolboxInterface,"OpenFlipper.ToolboxInterface/1.0")

#endif // TOOLBOXINTERFACE_HH