Developer Documentation

ViewModeInterface.hh
Go to the documentation of this file.
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42 #pragma once
43
44 #include <QStringList>
45
46
60 class ViewModeInterface {
61
62 private slots :
63
64 public :
65
67 virtual ~ViewModeInterface() {};
68
69 signals :
70
79 virtual void defineViewModeToolboxes(QString _mode, QStringList _usedWidgets){};
80
89 virtual void defineViewModeToolbars(QString _mode, QStringList _usedToolbars){};
90
99 virtual void defineViewModeContextMenus(QString _mode, QStringList _usedContextMenus){};
100
111 virtual void defineViewModeIcon(QString _mode, QString _iconName){};
112
121 virtual void setViewMode(QString _mode, bool _expandAll = false){};
122
123 };
124
125
193 Q_DECLARE_INTERFACE(ViewModeInterface,"OpenFlipper.ViewModeInterface/1.0")
194
ViewModeInterface::defineViewModeToolboxes
virtual void defineViewModeToolboxes(QString _mode, QStringList _usedWidgets)
Defines a ViewMode for the Toolboxes.
Definition: ViewModeInterface.hh:79
ViewModeInterface::defineViewModeIcon
virtual void defineViewModeIcon(QString _mode, QString _iconName)
Defines an Icon for a ViewMode.
Definition: ViewModeInterface.hh:111
ViewModeInterface
Interface class for adding view modes to the ui.
Definition: ViewModeInterface.hh:60
ViewModeInterface::~ViewModeInterface
virtual ~ViewModeInterface()
Destructor.
Definition: ViewModeInterface.hh:67
ViewModeInterface::defineViewModeToolbars
virtual void defineViewModeToolbars(QString _mode, QStringList _usedToolbars)
Defines a ViewMode for the Toolbars.
Definition: ViewModeInterface.hh:89
ViewModeInterface::setViewMode
virtual void setViewMode(QString _mode, bool _expandAll=false)
Set a ViewMode.
Definition: ViewModeInterface.hh:121
ViewModeInterface::defineViewModeContextMenus
virtual void defineViewModeContextMenus(QString _mode, QStringList _usedContextMenus)
Defines a ViewMode for the context menus.
Definition: ViewModeInterface.hh:99