1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtGui module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QDYNAMICDOCKWIDGET_H

    43 #define QDYNAMICDOCKWIDGET_H

    44 

    45 #include <QtGui/qwidget.h>

    46 

    47 QT_BEGIN_HEADER

    48 

    49 QT_BEGIN_NAMESPACE

    50 

    51 QT_MODULE(Gui)

    52 

    53 #ifndef QT_NO_DOCKWIDGET

    54 

    55 class QDockAreaLayout;

    56 class QDockWidgetPrivate;

    57 class QMainWindow;

    58 class QStyleOptionDockWidget;

    59 

    60 class 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 

    71 public:

    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 

   112 Q_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 

   119 protected:

   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 

   126 private:

   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 

   138 Q_DECLARE_OPERATORS_FOR_FLAGS(QDockWidget::DockWidgetFeatures)

   139 

   140 #endif // QT_NO_DOCKWIDGET

   141 

   142 QT_END_NAMESPACE

   143 

   144 QT_END_HEADER

   145 

   146 #endif // QDYNAMICDOCKWIDGET_H