- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Directories
- Examples

- File List
- File Members

# qdockwidget.h

Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
    00004 ** All rights reserved.
    00005 ** Contact: Nokia Corporation (qt-info@nokia.com)
    00006 **
    00007 ** This file is part of the QtGui module of the Qt Toolkit.
    00008 **
    00009 ** $QT_BEGIN_LICENSE:LGPL$
    00010 ** Commercial Usage
    00011 ** Licensees holding valid Qt Commercial licenses may use this file in
    00012 ** accordance with the Qt Commercial License Agreement provided with the
    00013 ** Software or, alternatively, in accordance with the terms contained in
    00014 ** a written agreement between you and Nokia.
    00015 **
    00016 ** GNU Lesser General Public License Usage
    00017 ** Alternatively, this file may be used under the terms of the GNU Lesser
    00018 ** General Public License version 2.1 as published by the Free Software
    00019 ** Foundation and appearing in the file LICENSE.LGPL included in the
    00020 ** packaging of this file.  Please review the following information to
    00021 ** ensure the GNU Lesser General Public License version 2.1 requirements
    00022 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    00023 **
    00024 ** In addition, as a special exception, Nokia gives you certain additional
    00025 ** rights.  These rights are described in the Nokia Qt LGPL Exception
    00026 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this module.
    00027 **
    00028 ** GNU General Public License Usage
    00029 ** Alternatively, this file may be used under the terms of the GNU
    00030 ** General Public License version 3.0 as published by the Free Software
    00031 ** Foundation and appearing in the file LICENSE.GPL included in the
    00032 ** packaging of this file.  Please review the following information to
    00033 ** ensure the GNU General Public License version 3.0 requirements will be
    00034 ** met: http://www.gnu.org/copyleft/gpl.html.
    00035 **
    00036 ** If you have questions regarding the use of this file, please contact
    00037 ** Nokia at qt-info@nokia.com.
    00038 ** $QT_END_LICENSE$
    00039 **
    00040 ****************************************************************************/
    00041
    00042 #ifndef QDYNAMICDOCKWIDGET_H
    00043 #define QDYNAMICDOCKWIDGET_H
    00044
    00045 #include <QtGui/qwidget.h>
    00046
    00047 QT_BEGIN_HEADER
    00048
    00049 QT_BEGIN_NAMESPACE
    00050
    00051 QT_MODULE(Gui)
    00052
    00053 #ifndef QT_NO_DOCKWIDGET
    00054
    00055 class QDockAreaLayout;
    00056 class QDockWidgetPrivate;
    00057 class QMainWindow;
    00058 class QStyleOptionDockWidget;
    00059
    00060 class Q_GUI_EXPORT QDockWidget : public QWidget
    00061 {
    00062     Q_OBJECT
    00063
    00064     Q_FLAGS(DockWidgetFeatures)
    00065     Q_PROPERTY(bool floating READ isFloating WRITE setFloating)
    00066     Q_PROPERTY(DockWidgetFeatures features READ features WRITE setFeatures NOTIFY featuresChanged)
    00067     Q_PROPERTY(Qt::DockWidgetAreas allowedAreas READ allowedAreas
    00068                WRITE setAllowedAreas NOTIFY allowedAreasChanged)
    00069     Q_PROPERTY(QString windowTitle READ windowTitle WRITE setWindowTitle DESIGNABLE true)
    00070
    00071 public:
    00072     explicit QDockWidget(const QString &title, QWidget *parent = 0, Qt::WindowFlags flags = 0);
    00073     explicit QDockWidget(QWidget *parent = 0, Qt::WindowFlags flags = 0);
    00074     ~QDockWidget();
    00075
    00076     QWidget *widget() const;
    00077     void setWidget(QWidget *widget);
    00078
    00079     enum DockWidgetFeature {
    00080         DockWidgetClosable    = 0x01,
    00081         DockWidgetMovable     = 0x02,
    00082         DockWidgetFloatable   = 0x04,
    00083         DockWidgetVerticalTitleBar = 0x08,
    00084
    00085         DockWidgetFeatureMask = 0x0f,
    00086         AllDockWidgetFeatures = DockWidgetClosable|DockWidgetMovable|DockWidgetFloatable, // ### remove in 5.0
    00087         NoDockWidgetFeatures  = 0x00,
    00088
    00089         Reserved              = 0xff
    00090     };
    00091     Q_DECLARE_FLAGS(DockWidgetFeatures, DockWidgetFeature)
    00092
    00093     void setFeatures(DockWidgetFeatures features);
    00094     DockWidgetFeatures features() const;
    00095
    00096     void setFloating(bool floating);
    00097     inline bool isFloating() const { return isWindow(); }
    00098
    00099     void setAllowedAreas(Qt::DockWidgetAreas areas);
    00100     Qt::DockWidgetAreas allowedAreas() const;
    00101
    00102     void setTitleBarWidget(QWidget *widget);
    00103     QWidget *titleBarWidget() const;
    00104
    00105     inline bool isAreaAllowed(Qt::DockWidgetArea area) const
    00106     { return (allowedAreas() & area) == area; }
    00107
    00108 #ifndef QT_NO_ACTION
    00109     QAction *toggleViewAction() const;
    00110 #endif
    00111
    00112 Q_SIGNALS:
    00113     void featuresChanged(QDockWidget::DockWidgetFeatures features);
    00114     void topLevelChanged(bool topLevel);
    00115     void allowedAreasChanged(Qt::DockWidgetAreas allowedAreas);
    00116     void visibilityChanged(bool visible);
    00117     void dockLocationChanged(Qt::DockWidgetArea area);
    00118
    00119 protected:
    00120     void changeEvent(QEvent *event);
    00121     void closeEvent(QCloseEvent *event);
    00122     void paintEvent(QPaintEvent *event);
    00123     bool event(QEvent *event);
    00124     void initStyleOption(QStyleOptionDockWidget *option) const;
    00125
    00126 private:
    00127     Q_DECLARE_PRIVATE(QDockWidget)
    00128     Q_DISABLE_COPY(QDockWidget)
    00129     Q_PRIVATE_SLOT(d_func(), void _q_toggleView(bool))
    00130     Q_PRIVATE_SLOT(d_func(), void _q_toggleTopLevel())
    00131     friend class QDockAreaLayout;
    00132     friend class QDockWidgetItem;
    00133     friend class QMainWindowLayout;
    00134     friend class QDockWidgetLayout;
    00135     friend class QDockAreaLayoutInfo;
    00136 };
    00137
    00138 Q_DECLARE_OPERATORS_FOR_FLAGS(QDockWidget::DockWidgetFeatures)
    00139
    00140 #endif // QT_NO_DOCKWIDGET
    00141
    00142 QT_END_NAMESPACE
    00143
    00144 QT_END_HEADER
    00145
    00146 #endif // QDYNAMICDOCKWIDGET_H