ViewModeInterface.hh 8.09 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
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
*                           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/>.                                       *
*                                                                            *
Jan Möbius's avatar
Jan Möbius committed
33 34 35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36 37 38 39 40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
Jan Möbius's avatar
Jan Möbius committed
41 42 43 44 45
\*===========================================================================*/

#ifndef VIEWMODEINTERFACE_HH
#define VIEWMODEINTERFACE_HH

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
#include <QtGui>
#include <QMenuBar>
#include <QStringList>


/** \file ViewModeInterface.hh
*
* Specify own view modes setting which toolboxes/toolbars/context menus will be visible . \ref viewModeInterfacePage
*/


/** \brief Interface class for adding view modes to the ui.

\n
\ref viewModeInterfacePage "Detailed description"
\n

*/
Jan Möbius's avatar
Jan Möbius committed
64 65 66 67 68 69 70 71 72 73 74
class ViewModeInterface {

  private slots :

  public :

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

  signals :

75
    /** \brief Defines a ViewMode for the Toolboxes
Jan Möbius's avatar
Jan Möbius committed
76 77 78 79
    *
    * With this function you can define a set of toolboxes which should be visible 
    * for the specified view mode.
    * 
80 81
    * @param _mode        Name of the ViewMode
    * @param _usedWidgets List of used Widgets names
Jan Möbius's avatar
Jan Möbius committed
82
    */
83
    virtual void defineViewModeToolboxes(QString _mode, QStringList _usedWidgets){};
84 85 86 87 88 89
    
    /** \brief Defines a ViewMode for the Toolbars
    *
    * With this function you can define a set of toolbars which should be visible 
    * for the specified view mode.
    * 
90 91
    * @param _mode        Name of the ViewMode
    * @param _usedWidgets List of used toolbars
92
    */
93
    virtual void defineViewModeToolbars(QString _mode, QStringList _usedToolbars){};
94
    
95
    /** \brief Defines a ViewMode for the context menus
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
96 97 98 99
    *
    * With this function you can define a set of context menus which should be visible 
    * for the specified view mode.
    * 
100 101
    * @param _mode        Name of the ViewMode
    * @param _usedWidgets List of used context menus
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
102
    */
103
    virtual void defineViewModeContextMenus(QString _mode, QStringList _usedContextMenus){};
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
104
    
105 106 107
    /** \brief Defines an Icon for a ViewMode
    *
    * With this function you can define an Icon associated with this view mode
Jan Möbius's avatar
Jan Möbius committed
108
    * The Icon will be taken from the standard Icon path or in the OpenFlipper 
Jan Möbius's avatar
Jan Möbius committed
109 110
    * home directory.\n
    * The Icon should have a size of 150x150 pixels.
111
    * 
112 113
    * @param _mode     Name of the ViewMode
    * @param _iconName Filename of the Icon used for this view mode
114
    */
115
    virtual void defineViewModeIcon(QString _mode, QString _iconName){};
116 117 118

    /** \brief Set a ViewMode
    *
119
    * With this function you can switch to a viewMode
120 121
    * This will show all corresponding toolboxes/toolbars
    * 
122
    * @param _mode      Name of the ViewMode
123 124
    * @param _expandAll Expand all toolboxes
    */
125
    virtual void setViewMode(QString _mode, bool _expandAll = false){};
Jan Möbius's avatar
Jan Möbius committed
126 127 128

};

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171

/** \page viewModeInterfacePage View Mode Interface
\image html ViewModeInterface.png
\n

This Interface can be used to configure visible widgets and menus in the viewer. A given
view mode contains a list of toolbars, toolboxes and context menus which should
be visible if the mode is active. Therefore you can define a subset of the
full interface for special tasks.

\section ViewModeExample Example using custom view modes

%OpenFlipper comes along with a lot of plugins each offering a wide variety
of GUI elements such as toolboxes and toolbars. In order to constrain %OpenFlipper's
interface to a certain number of toolboxes and/or toolbar elements, the ViewModeInterface
offers means to filter these elements.

So, for example, if we only wanted the toolboxes of the Data Control and the
Selection plugin to be visible, we have to emit signal ViewModeInterface::defineViewModeToolboxes(QString, QStringList)
in order to hide out everything else:

\code
// In your plugin initialization, define the view modes:
void ExamplePlugin::pluginsInitialized() {

  // Generate the list of toolboxes to use:
  QStringList toolBoxes = QString("Data Control,Selection").split(",");

  // Define the view mode.
  emit defineViewModeToolboxes("My Custom View Mode", toolBoxes);

  //define the viewMode Toolbars
  QStringList toolBars;
  toolBars.push_back( "Selection" );

  emit defineViewModeToolbars("My Custom View Mode", toolBars);
}
\endcode

When the user selects "My Custom View Mode" out of the view modes menu, all
toolboxes except for Data Control and Selection will disappear.
This works analogously for toolbar elements via the signal ViewModeInterface::defineViewModeToolbars(QString, QStringList).

Jan Möbius's avatar
Jan Möbius committed
172 173 174 175 176
\section Defaults
The Main Toolbar and the Viewer Toolbar will always be included in the list of toolbars and will be the default when
you define a View Mode with only toolboxes and context menus.
If you do not define context menus for your View Mode, they will default to all.

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
\section Icons
Additionally, if we wanted the "My Custom View Mode" entry in the view modes menu
to appear with a fancy icon, we just have to call ViewModeInterface::defineViewModeIcon(QString, QString):

\code
  emit defineViewModeIcon("My Custom View Mode", "myIconFile.png");
\endcode

\section Usage
To use the ViewModeInterface:
<ul>
<li> include ViewModeInterface.hh in your plugins header file
<li> derive your plugin from the class ViewModeInterface
<li> add Q_INTERFACES(ViewModeInterface) to your plugin class
<li> And add the signals you want to use to your plugin class
</ul>

*/


Jan Möbius's avatar
Jan Möbius committed
197 198 199
Q_DECLARE_INTERFACE(ViewModeInterface,"OpenFlipper.ViewModeInterface/1.0")

#endif // VIEWMODEINTERFACE_HH