ToolbarInterface.hh 5.89 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
#pragma once
43

44
#include <OpenFlipper/common/Types.hh>
Matthias Möller's avatar
Matthias Möller committed
45

46
#include <QToolBar>
47

Jan Möbius's avatar
Jan Möbius committed
48
/** \file ToolbarInterface.hh
Jan Möbius's avatar
Jan Möbius committed
49 50 51 52 53
*
* Interface for adding per plugin toolbars to OpenFlippers UI.\ref toolbarInterfacePage
*/


54
/** \brief Add a toolbox to OpenFlipper
Jan Möbius's avatar
Jan Möbius committed
55 56 57 58
 *
 * \ref toolbarInterfacePage "Detailed description"
 * \n
 *
59
 * This Interface should be used by plugins which will provide a toolbar.
Jan Möbius's avatar
Jan Möbius committed
60 61
 * Each Plugin can create own toolbars.
*/
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
class ToolbarInterface {

   private slots :

   public :

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

    signals :

      /** \brief Adds a Toolbar to the main widget
      *
      * To create your own Toolbar, emit this signal with a pointer to your Toolbar.
      * @param _toolbar Your Toolbar
      */
Jan Möbius's avatar
Jan Möbius committed
78
      virtual void addToolbar(QToolBar* _toolbar) {};
79 80


81 82 83 84
      /** \brief Remove a Toolbar from the main widget
      *
      * @param _toolbar Toolbar to be removed
      */
Jan Möbius's avatar
Jan Möbius committed
85
      virtual void removeToolbar(QToolBar* _toolbar) {};
86 87


88 89 90 91 92
      /** \brief Get a pointer to a Toolbar of the given name or 0 if it does not exist.
      *
      * @param _name Name of the Toolbar
      * @param _toolbar requested Toolbar or 0
      */
Jan Möbius's avatar
Jan Möbius committed
93
      virtual void getToolBar( QString _name, QToolBar*& _toolbar ) {};
94 95


96 97
};

Jan Möbius's avatar
Jan Möbius committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146


/** \page toolbarInterfacePage Toolbar Interface
\image html ToolbarInterface.png
\n
The ToolbarInterface can be used by plugins to add toolbars to OpenFlippers
UI. The toolbars are located above the GL viewer (See image).


To use the ToolbarInterface:
<ul>
<li> include ToolbarInterface in your plugins header file
<li> derive your plugin from the class ToolbarInterface
<li> add Q_INTERFACES(ToolbarInterface) to your plugin class
<li> And add the signals or slots you want to use to your plugin class (You don't need to implement all of them)
</ul>

Usually you should implement the BaseInterface::pluginsInitialized() function from BaseInterface. In this function you can setup
your toolbars.

The following code shows a simple example to create a simple toolbar.
\code
void ExamplePlugin::pluginsInitialized()
{

  // Create your toolbar
  QToolBar* toolbar = new QToolBar(tr("Example Toolbar"));

  // Create an action for the toolbar
  QAction* exampleAction = new QAction(tr("&Toolbar Button"), this);

  // Create an icon which is shown for the action
  exampleAction->setIcon(QIcon(OpenFlipper::Options::iconDirStr()+OpenFlipper::Options::dirSeparator()+"exampleIcon.png"));

  // Add the action to the toolbar
  toolbar->addAction(exampleAction);

  // Integrate the new toolbar into OpenFlipper
  emit addToolbar( toolbar );
}
\endcode

Signals and slots of your toolbar (e.g. from an action inside it) can be directly connected to signals and slots in
your plugin. Therefore the embedding of the toolbar is fully transparent.

*/



147
Q_DECLARE_INTERFACE(ToolbarInterface,"OpenFlipper.ToolbarInterface/1.1")
148