ViewModeInterface.hh 6.83 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
2
3
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
Jan Möbius's avatar
Jan Möbius committed
4
 *      Copyright (C) 2001-2010 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
33
34
35
36
 *                           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/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
37
38
39
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
Jan Möbius's avatar
Jan Möbius committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 *                                                                           *
\*===========================================================================*/




//
// C++ Interface: ViewModeInterface
//
// Description:
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

#ifndef VIEWMODEINTERFACE_HH
#define VIEWMODEINTERFACE_HH

 #include <QtGui>
 #include <QMenuBar>
 #include <QStringList>

 /**
  * \brief Define View Modes using this interface
  *
  * This Interface can be used to configure visible widgets 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.
  *
70
71
72
73
74
75
76
77
78
79
80
81
  * \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 defineViewModeToolboxes(QString, QStringList)
  * in order to hide out everything else:
  *
  * \code
82
  * void ExampleViewModePlugin::pluginsInitialized() {
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
  *
  *     QStringList toolBoxes = QString("Data Control,Selection").split(",");
  *
  *     emit defineViewModeToolboxes("My Custom View Mode", toolBoxes);
  * }
  * \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 defineViewModeToolbars(QString, QStringList).
  * 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 defineViewModeIcon(QString, QString):
  *
  * \code
  * emit defineViewModeIcon("My Custom View Mode", "myIconFile.png");
  * \endcode
  *
Jan Möbius's avatar
Jan Möbius committed
100
101
102
103
104
105
106
107
108
109
110
111
  */
class ViewModeInterface {

  private slots :

  public :

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

  signals :

112
    /** \brief Defines a ViewMode for the Toolboxes
Jan Möbius's avatar
Jan Möbius committed
113
114
115
116
117
118
119
    *
    * With this function you can define a set of toolboxes which should be visible 
    * for the specified view mode.
    * 
    * @param _mode name of the ViewMode
    * @param _usedWidgets list of used Widgets names
    */
120
121
122
123
124
125
126
127
128
129
130
    virtual void defineViewModeToolboxes(QString /*_mode*/, QStringList /*_usedWidgets*/){};
    
    /** \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.
    * 
    * @param _mode name of the ViewMode
    * @param _usedWidgets list of used toolbars 
    */
    virtual void defineViewModeToolbars(QString /*_mode*/, QStringList /*_usedToolbars*/){};    
131
    
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
132
133
134
135
136
137
138
139
140
141
    /** \brief Defines a ViewMode for the Toolbars
    *
    * With this function you can define a set of context menus which should be visible 
    * for the specified view mode.
    * 
    * @param _mode name of the ViewMode
    * @param _usedWidgets list of used context menus 
    */
    virtual void defineViewModeContextMenus(QString /*_mode*/, QStringList /*_usedContextMenus*/){};    
    
142
143
144
    /** \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
145
    * The Icon will be taken from the standard Icon path or in the OpenFlipper 
Jan Möbius's avatar
Jan Möbius committed
146
147
    * home directory.\n
    * The Icon should have a size of 150x150 pixels.
148
149
150
151
152
    * 
    * @param _mode name of the ViewMode
    * @param _iconName Name of the Icon used for this view mode
    */
    virtual void defineViewModeIcon(QString /*_mode*/, QString /*_iconName*/){};        
Jan Möbius's avatar
Jan Möbius committed
153
154
155
156
157
158

};

Q_DECLARE_INTERFACE(ViewModeInterface,"OpenFlipper.ViewModeInterface/1.0")

#endif // VIEWMODEINTERFACE_HH