1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QDYNAMICDOCKWIDGET_H
43#define QDYNAMICDOCKWIDGET_H
44
45#include <QtGui/qwidget.h>
46
47QT_BEGIN_HEADER
48
49QT_BEGIN_NAMESPACE
50
51QT_MODULE(Gui)
52
53#ifndef QT_NO_DOCKWIDGET
54
55class QDockAreaLayout;
56class QDockWidgetPrivate;
57class QMainWindow;
58class QStyleOptionDockWidget;
59
60class Q_GUI_EXPORT QDockWidget : public QWidget
61{
62 Q_OBJECT
63
64 Q_FLAGS(DockWidgetFeatures)
65 Q_PROPERTY(bool floating READ isFloating WRITE setFloating)
66 Q_PROPERTY(DockWidgetFeatures features READ features WRITE setFeatures NOTIFY featuresChanged)
67 Q_PROPERTY(Qt::DockWidgetAreas allowedAreas READ allowedAreas
68 WRITE setAllowedAreas NOTIFY allowedAreasChanged)
69 Q_PROPERTY(QString windowTitle READ windowTitle WRITE setWindowTitle DESIGNABLE true)
70
71public:
72 explicit QDockWidget(const QString &title, QWidget *parent = 0, Qt::WindowFlags flags = 0);
73 explicit QDockWidget(QWidget *parent = 0, Qt::WindowFlags flags = 0);
74 ~QDockWidget();
75
76 QWidget *widget() const;
77 void setWidget(QWidget *widget);
78
79 enum DockWidgetFeature {
80 DockWidgetClosable = 0x01,
81 DockWidgetMovable = 0x02,
82 DockWidgetFloatable = 0x04,
83 DockWidgetVerticalTitleBar = 0x08,
84
85 DockWidgetFeatureMask = 0x0f,
86 AllDockWidgetFeatures = DockWidgetClosable|DockWidgetMovable|DockWidgetFloatable, // ### remove in 5.0
87 NoDockWidgetFeatures = 0x00,
88
89 Reserved = 0xff
90 };
91 Q_DECLARE_FLAGS(DockWidgetFeatures, DockWidgetFeature)
92
93 void setFeatures(DockWidgetFeatures features);
94 DockWidgetFeatures features() const;
95
96 void setFloating(bool floating);
97 inline bool isFloating() const { return isWindow(); }
98
99 void setAllowedAreas(Qt::DockWidgetAreas areas);
100 Qt::DockWidgetAreas allowedAreas() const;
101
102 void setTitleBarWidget(QWidget *widget);
103 QWidget *titleBarWidget() const;
104
105 inline bool isAreaAllowed(Qt::DockWidgetArea area) const
106 { return (allowedAreas() & area) == area; }
107
108#ifndef QT_NO_ACTION
109 QAction *toggleViewAction() const;
110#endif
111
112Q_SIGNALS:
113 void featuresChanged(QDockWidget::DockWidgetFeatures features);
114 void topLevelChanged(bool topLevel);
115 void allowedAreasChanged(Qt::DockWidgetAreas allowedAreas);
116 void visibilityChanged(bool visible);
117 void dockLocationChanged(Qt::DockWidgetArea area);
118
119protected:
120 void changeEvent(QEvent *event);
121 void closeEvent(QCloseEvent *event);
122 void paintEvent(QPaintEvent *event);
123 bool event(QEvent *event);
124 void initStyleOption(QStyleOptionDockWidget *option) const;
125
126private:
127 Q_DECLARE_PRIVATE(QDockWidget)
128 Q_DISABLE_COPY(QDockWidget)
129 Q_PRIVATE_SLOT(d_func(), void _q_toggleView(bool))
130 Q_PRIVATE_SLOT(d_func(), void _q_toggleTopLevel())
131 friend class QDockAreaLayout;
132 friend class QDockWidgetItem;
133 friend class QMainWindowLayout;
134 friend class QDockWidgetLayout;
135 friend class QDockAreaLayoutInfo;
136};
137
138Q_DECLARE_OPERATORS_FOR_FLAGS(QDockWidget::DockWidgetFeatures)
139
140#endif // QT_NO_DOCKWIDGET
141
142QT_END_NAMESPACE
143
144QT_END_HEADER
145
146#endif // QDYNAMICDOCKWIDGET_H
147