SideArea.hh 6.41 KB
Newer Older
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
*                                                                            *
40
41
42
\*===========================================================================*/

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


Jan Möbius's avatar
Dennis:  
Jan Möbius committed
51
52
53
54
55
56
57
58
59
60
61
62

#ifndef SIDE_AREA_
#define SIDE_AREA_

//=============================================================================
//
//  CLASS SideElement
//
//=============================================================================

//== INCLUDES =================================================================

Dirk Wilden's avatar
Dirk Wilden committed
63
#include <QIcon>
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
#include <QWidget>
#include <QString>
#include <QSettings>

//== FORWARDDECLARATIONS ======================================================

class QVBoxLayout;

class SideElement;

/** \class SideArea SideArea.hh <OpenFlipper/widgets/coreWidget/SideArea.hh>

  A widget that holds the different plugin tool widgets
 **/


class SideArea : public QWidget {
  public:

    /** Create a SideElement
      \param _parent Parent widget
    */
    SideArea (QWidget *_parent = 0);

Dirk Wilden's avatar
Dirk Wilden committed
88
    /** Adds a plugin tool widget
89
      \param _plugin plugin corresponding to the widget
Dirk Wilden's avatar
Dirk Wilden committed
90
91
92
      \param _w Plugin widget
      \param _name Plugin name
      \param _icon an icon
93
      \param _headerAreaWidget
Dirk Wilden's avatar
Dirk Wilden committed
94
    */
95
96
    void addItem (QObject const * const _plugin, QWidget *_w, QString _name,
            QIcon* _icon = 0, QWidget *_headerAreaWidget = 0);
Dirk Wilden's avatar
Dirk Wilden committed
97

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
98
99
    /// clears the whole tool widget area
    void clear ();
100

101
102
    //expand all elements
    void expandAll();
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
103

Jan Möbius's avatar
Jan Möbius committed
104
105
    void expand(QWidget *sideElementWidget, bool expand);

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
106
107
108
    /// returns the current state
    void saveState (QSettings &_settings);

109
110
111
    /// saves the active state of _viewMode
    void saveViewModeState(const QString& _viewMode);

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
112
113
114
    /// restores the state
    void restoreState (QSettings &_settings);

115
116
117
    /// restores the active state of _viewMode
    void restoreViewModeState(const QString& _viewMode);

Dirk Wilden's avatar
Dirk Wilden committed
118
119
    /// set the active state of given element
    void setElementActive(QString _name, bool _active);
120

121
122
    /// Move a toolbox widget to a given position
    void moveItemToPosition(const QString& _name, int _position);
123

124
125
126
    /// Move a toolbox widget to a given position
    void moveItemToPosition(QObject const * const _plugin, const QString& _name, int _position);

127
128
    /// Get number of widgets
    int getNumberOfWidgets() const;
Dirk Wilden's avatar
Dirk Wilden committed
129

130
131
132
133
134
135
136
137
138
    /// Get plugins in side area
    const QList<const QObject *>& plugins();

    /// Get item names
    const QStringList& names();

    // position of the last added item
    int lastPos_;

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
139
140
141
142
  private:
    // elements
    QVector<SideElement *> items_;

143
144
145
146
147
148
    // plugins in side area
    QList<const QObject *> plugins_;

    // item names
    QStringList itemNames_;

149
150
151
    // saves active state of each SideElement in each view
    QMap<QString, bool> sideElementState_;

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
152
153
154
155
156
157
158
    // main layout
    QVBoxLayout *layout_;
};

//=============================================================================
//=============================================================================
#endif // SIDE_AREA_ defined
Jan Möbius's avatar
Jan Möbius committed
159
160
//=============================================================================