ViewModeInterface.hh 8.17 KB
 Jan Möbius committed Sep 30, 2009 1 /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 2 3 * * * OpenFlipper *  Jan Möbius committed Feb 05, 2014 4 * Copyright (C) 2001-2014 by Computer Graphics Group, RWTH Aachen *  Jan Möbius committed Nov 25, 2010 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 . * * *  Jan Möbius committed Sep 30, 2009 33 34 35 \*===========================================================================*/ /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 36 37 38 39 40 * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * *  Jan Möbius committed Sep 30, 2009 41 42 43 44 45 \*===========================================================================*/ #ifndef VIEWMODEINTERFACE_HH #define VIEWMODEINTERFACE_HH  Matthias Möller committed Jul 19, 2013 46 47 48 49 50 51 52  #if QT_VERSION >= 0x050000 #include #else #include #endif  Jan Möbius committed Mar 16, 2011 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 #include #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 70 71 72 73 74 75 76 77 78 79 80 class ViewModeInterface { private slots : public : /// Destructor virtual ~ViewModeInterface() {}; signals :  Jan Möbius committed Sep 30, 2009 81  /** \brief Defines a ViewMode for the Toolboxes  Jan Möbius committed Sep 30, 2009 82 83 84 85  * * 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 86 87  * @param _mode Name of the ViewMode * @param _usedWidgets List of used Widgets names  Jan Möbius committed Sep 30, 2009 88  */  Jan Möbius committed Mar 16, 2011 89  virtual void defineViewModeToolboxes(QString _mode, QStringList _usedWidgets){};  Jan Möbius committed Sep 30, 2009 90 91 92 93 94 95  /** \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 96 97  * @param _mode Name of the ViewMode * @param _usedToolbars List of used toolbars  Jan Möbius committed Sep 30, 2009 98  */  Jan Möbius committed Mar 16, 2011 99  virtual void defineViewModeToolbars(QString _mode, QStringList _usedToolbars){};  Jan Möbius committed Sep 30, 2009 100   Jan Möbius committed Mar 16, 2011 101  /** \brief Defines a ViewMode for the context menus  Jan Möbius committed Mar 26, 2010 102 103 104 105  * * 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 106 107  * @param _mode Name of the ViewMode * @param _usedContextMenus List of used context menus  Jan Möbius committed Mar 26, 2010 108  */  Jan Möbius committed Mar 16, 2011 109  virtual void defineViewModeContextMenus(QString _mode, QStringList _usedContextMenus){};  Jan Möbius committed Mar 26, 2010 110   Jan Möbius committed Sep 30, 2009 111 112 113  /** \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 114  * The Icon will be taken from the standard Icon path or in the OpenFlipper  Jan Möbius committed Oct 01, 2009 115 116  * home directory.\n * The Icon should have a size of 150x150 pixels.  Jan Möbius committed Sep 30, 2009 117  *  Jan Möbius committed Mar 16, 2011 118 119  * @param _mode Name of the ViewMode * @param _iconName Filename of the Icon used for this view mode  Jan Möbius committed Sep 30, 2009 120  */  Jan Möbius committed Mar 16, 2011 121  virtual void defineViewModeIcon(QString _mode, QString _iconName){};  Dirk Wilden committed Sep 01, 2010 122 123 124  /** \brief Set a ViewMode *  Jan Möbius committed Mar 16, 2011 125  * With this function you can switch to a viewMode  Dirk Wilden committed Sep 01, 2010 126 127  * This will show all corresponding toolboxes/toolbars *  Jan Möbius committed Mar 16, 2011 128  * @param _mode Name of the ViewMode  Dirk Wilden committed Sep 01, 2010 129 130  * @param _expandAll Expand all toolboxes */  Jan Möbius committed Mar 16, 2011 131  virtual void setViewMode(QString _mode, bool _expandAll = false){};  Jan Möbius committed Sep 30, 2009 132 133 134  };  Jan Möbius committed Mar 16, 2011 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  /** \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 178 179 180 181 182 \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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 \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:
• derive your plugin from the class ViewModeInterface
*/  Jan Möbius committed Sep 30, 2009 203 204 205 Q_DECLARE_INTERFACE(ViewModeInterface,"OpenFlipper.ViewModeInterface/1.0") #endif // VIEWMODEINTERFACE_HH