/****************************************************************************

**

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

** All rights reserved.

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

**

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

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

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

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

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

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

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

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

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

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

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

**

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

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

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

**

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

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

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QDYNAMICDOCKWIDGET_H

#define QDYNAMICDOCKWIDGET_H

#include <QtGui/qwidget.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

#ifndef QT_NO_DOCKWIDGET

class QDockAreaLayout;

class QDockWidgetPrivate;

class QMainWindow;

class QStyleOptionDockWidget;

class Q_GUI_EXPORT QDockWidget : public QWidget

{

    Q_OBJECT

    Q_FLAGS(DockWidgetFeatures)

    Q_PROPERTY(bool floating READ isFloating WRITE setFloating)

    Q_PROPERTY(DockWidgetFeatures features READ features WRITE setFeatures NOTIFY featuresChanged)

    Q_PROPERTY(Qt::DockWidgetAreas allowedAreas READ allowedAreas

               WRITE setAllowedAreas NOTIFY allowedAreasChanged)

    Q_PROPERTY(QString windowTitle READ windowTitle WRITE setWindowTitle DESIGNABLE true)

public:

    explicit QDockWidget(const QString &title, QWidget *parent = 0, Qt::WindowFlags flags = 0);

    explicit QDockWidget(QWidget *parent = 0, Qt::WindowFlags flags = 0);

    ~QDockWidget();

    QWidget *widget() const;

    void setWidget(QWidget *widget);

    enum DockWidgetFeature {

        DockWidgetClosable    = 0x01,

        DockWidgetMovable     = 0x02,

        DockWidgetFloatable   = 0x04,

        DockWidgetVerticalTitleBar = 0x08,

        DockWidgetFeatureMask = 0x0f,

        AllDockWidgetFeatures = DockWidgetClosable|DockWidgetMovable|DockWidgetFloatable, // ### remove in 5.0

        NoDockWidgetFeatures  = 0x00,

        Reserved              = 0xff

    };

    Q_DECLARE_FLAGS(DockWidgetFeatures, DockWidgetFeature)

    void setFeatures(DockWidgetFeatures features);

    DockWidgetFeatures features() const;

    void setFloating(bool floating);

    inline bool isFloating() const { return isWindow(); }

    void setAllowedAreas(Qt::DockWidgetAreas areas);

    Qt::DockWidgetAreas allowedAreas() const;

    void setTitleBarWidget(QWidget *widget);

    QWidget *titleBarWidget() const;

    inline bool isAreaAllowed(Qt::DockWidgetArea area) const

    { return (allowedAreas() & area) == area; }

#ifndef QT_NO_ACTION

    QAction *toggleViewAction() const;

#endif

Q_SIGNALS:

    void featuresChanged(QDockWidget::DockWidgetFeatures features);

    void topLevelChanged(bool topLevel);

    void allowedAreasChanged(Qt::DockWidgetAreas allowedAreas);

    void visibilityChanged(bool visible);

    void dockLocationChanged(Qt::DockWidgetArea area);

protected:

    void changeEvent(QEvent *event);

    void closeEvent(QCloseEvent *event);

    void paintEvent(QPaintEvent *event);

    bool event(QEvent *event);

    void initStyleOption(QStyleOptionDockWidget *option) const;

private:

    Q_DECLARE_PRIVATE(QDockWidget)

    Q_DISABLE_COPY(QDockWidget)

    Q_PRIVATE_SLOT(d_func(), void _q_toggleView(bool))

    Q_PRIVATE_SLOT(d_func(), void _q_toggleTopLevel())

    friend class QDockAreaLayout;

    friend class QDockWidgetItem;

    friend class QMainWindowLayout;

    friend class QDockWidgetLayout;

    friend class QDockAreaLayoutInfo;

};

Q_DECLARE_OPERATORS_FOR_FLAGS(QDockWidget::DockWidgetFeatures)

#endif // QT_NO_DOCKWIDGET

QT_END_NAMESPACE

QT_END_HEADER

#endif // QDYNAMICDOCKWIDGET_H