ViewModeInterface.hh 8.68 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                                   *
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
*                                                                            *
Jan Möbius's avatar
Jan Möbius committed
40 41 42
\*===========================================================================*/

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

#ifndef VIEWMODEINTERFACE_HH
#define VIEWMODEINTERFACE_HH

Matthias Möller's avatar
Matthias Möller committed
53 54 55

  #include <QtWidgets>

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
#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
73 74 75 76 77 78 79 80 81 82 83
class ViewModeInterface {

  private slots :

  public :

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

  signals :

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

    /** \brief Set a ViewMode
    *
128
    * With this function you can switch to a viewMode
129 130
    * This will show all corresponding toolboxes/toolbars
    * 
131
    * @param _mode      Name of the ViewMode
132 133
    * @param _expandAll Expand all toolboxes
    */
134
    virtual void setViewMode(QString _mode, bool _expandAll = false){};
Jan Möbius's avatar
Jan Möbius committed
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 172 173 174 175 176 177 178 179 180

/** \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
181 182 183 184 185
\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.

186 187 188 189 190 191 192 193
\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

Jan Möbius's avatar
Jan Möbius committed
194
\section view_mode_interface_usage Usage
195 196 197 198 199 200 201 202 203 204 205
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
206 207 208
Q_DECLARE_INTERFACE(ViewModeInterface,"OpenFlipper.ViewModeInterface/1.0")

#endif // VIEWMODEINTERFACE_HH