ViewModeInterface.hh 8.08 KB
 Jan Möbius committed Sep 30, 2009 1 /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 2 3 * * * OpenFlipper *  Martin Schultz committed Jul 16, 2015 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 committed Nov 25, 2010 39 * *  Jan Möbius committed Sep 30, 2009 40 41 \*===========================================================================*/  Jan Möbius committed Jan 08, 2019 42 #pragma once  Matthias Möller committed Jul 19, 2013 43   Jan Möbius committed Mar 16, 2011 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 #include /** \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 committed Sep 30, 2009 60 61 62 63 64 65 66 67 68 69 70 class ViewModeInterface { private slots : public : /// Destructor virtual ~ViewModeInterface() {}; signals :  Jan Möbius committed Sep 30, 2009 71  /** \brief Defines a ViewMode for the Toolboxes  Jan Möbius committed Sep 30, 2009 72 73 74 75  * * With this function you can define a set of toolboxes which should be visible * for the specified view mode. *  Jan Möbius committed Mar 16, 2011 76 77  * @param _mode Name of the ViewMode * @param _usedWidgets List of used Widgets names  Jan Möbius committed Sep 30, 2009 78  */  Jan Möbius committed Mar 16, 2011 79  virtual void defineViewModeToolboxes(QString _mode, QStringList _usedWidgets){};  Jan Möbius committed Sep 30, 2009 80 81 82 83 84 85  /** \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 committed Mar 20, 2012 86 87  * @param _mode Name of the ViewMode * @param _usedToolbars List of used toolbars  Jan Möbius committed Sep 30, 2009 88  */  Jan Möbius committed Mar 16, 2011 89  virtual void defineViewModeToolbars(QString _mode, QStringList _usedToolbars){};  Jan Möbius committed Sep 30, 2009 90   Jan Möbius committed Mar 16, 2011 91  /** \brief Defines a ViewMode for the context menus  Jan Möbius committed Mar 26, 2010 92 93 94 95  * * With this function you can define a set of context menus which should be visible * for the specified view mode. *  Jan Möbius committed Mar 20, 2012 96 97  * @param _mode Name of the ViewMode * @param _usedContextMenus List of used context menus  Jan Möbius committed Mar 26, 2010 98  */  Jan Möbius committed Mar 16, 2011 99  virtual void defineViewModeContextMenus(QString _mode, QStringList _usedContextMenus){};  Jan Möbius committed Mar 26, 2010 100   Jan Möbius committed Sep 30, 2009 101 102 103  /** \brief Defines an Icon for a ViewMode * * With this function you can define an Icon associated with this view mode  Jan Möbius committed Oct 01, 2009 104  * The Icon will be taken from the standard Icon path or in the OpenFlipper  Jan Möbius committed Oct 01, 2009 105 106  * home directory.\n * The Icon should have a size of 150x150 pixels.  Jan Möbius committed Sep 30, 2009 107  *  Jan Möbius committed Mar 16, 2011 108 109  * @param _mode Name of the ViewMode * @param _iconName Filename of the Icon used for this view mode  Jan Möbius committed Sep 30, 2009 110  */  Jan Möbius committed Mar 16, 2011 111  virtual void defineViewModeIcon(QString _mode, QString _iconName){};  Dirk Wilden committed Sep 01, 2010 112 113 114  /** \brief Set a ViewMode *  Jan Möbius committed Mar 16, 2011 115  * With this function you can switch to a viewMode  Dirk Wilden committed Sep 01, 2010 116 117  * This will show all corresponding toolboxes/toolbars *  Jan Möbius committed Mar 16, 2011 118  * @param _mode Name of the ViewMode  Dirk Wilden committed Sep 01, 2010 119 120  * @param _expandAll Expand all toolboxes */  Jan Möbius committed Mar 16, 2011 121  virtual void setViewMode(QString _mode, bool _expandAll = false){};  Jan Möbius committed Sep 30, 2009 122 123 124  };  Jan Möbius committed Mar 16, 2011 125 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  /** \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 committed Mar 16, 2011 168 169 170 171 172 \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.  Jan Möbius committed Mar 16, 2011 173 174 175 176 177 178 179 180 \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 committed Jun 16, 2014 181 \section view_mode_interface_usage Usage  Jan Möbius committed Mar 16, 2011 182 183 184 185 186 187 188 189 190 191 192 To use the ViewModeInterface:
*/  Jan Möbius committed Sep 30, 2009 193 194 Q_DECLARE_INTERFACE(ViewModeInterface,"OpenFlipper.ViewModeInterface/1.0")