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

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36
37
38
39
40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
42
43
\*===========================================================================*/


Jan Möbius's avatar
Dennis:    
Jan Möbius committed
44
45
46
47
48
49
50
51
52
53
54
55

#ifndef SIDE_AREA_
#define SIDE_AREA_

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

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

Dirk Wilden's avatar
Dirk Wilden committed
56
#include <QIcon>
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
#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);

    /** Adds a plugin tool widget
82
      \param _plugin plugin corresponding to the widget
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
83
84
85
      \param _w Plugin widget
      \param _name Plugin name
    */
86
    void addItem (QObject const * const _plugin, QWidget *_w, QString _name);
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
87

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
93
      \param _w Plugin widget
      \param _name Plugin name
      \param _icon an icon
    */
94
    void addItem (QObject const * const _plugin, QWidget *_w, QString _name, QIcon* _icon);
Dirk Wilden's avatar
Dirk Wilden committed
95

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

99
100
    //expand all elements
    void expandAll();
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
101
102
103
104
105
106
107

    /// returns the current state
    void saveState (QSettings &_settings);

    /// restores the state
    void restoreState (QSettings &_settings);

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

111
112
    /// Move a toolbox widget to a given position
    void moveItemToPosition(const QString& _name, int _position);
113

114
115
116
    /// Move a toolbox widget to a given position
    void moveItemToPosition(QObject const * const _plugin, const QString& _name, int _position);

117
118
    /// Get number of widgets
    int getNumberOfWidgets() const;
Dirk Wilden's avatar
Dirk Wilden committed
119

120
121
122
123
124
125
126
127
128
    /// 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
129
130
131
132
  private:
    // elements
    QVector<SideElement *> items_;

133
134
135
136
137
138
    // plugins in side area
    QList<const QObject *> plugins_;

    // item names
    QStringList itemNames_;

Jan Möbius's avatar
Dennis:    
Jan Möbius committed
139
140
141
142
143
144
145
    // main layout
    QVBoxLayout *layout_;
};

//=============================================================================
//=============================================================================
#endif // SIDE_AREA_ defined
Jan Möbius's avatar
Jan Möbius committed
146
147
//=============================================================================