DockWidget.h

Go to the documentation of this file.

#ifndef DockWidgetH
#define DockWidgetH
/*******************************************************************************
** Qt Advanced Docking System
** Copyright (C) 2017 Uwe Kindler
**
** This library 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 2.1 of the License, or (at your option) any later version.
**
** This library 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 Lesser General Public
** License along with this library; If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/


//============================================================================
//============================================================================


//============================================================================
//                                   INCLUDES
//============================================================================
#include <QFrame>

#include "ads_globals.h"

QT_FORWARD_DECLARE_CLASS(QToolBar)
QT_FORWARD_DECLARE_CLASS(QXmlStreamWriter)

namespace ads
{
struct DockWidgetPrivate;
class CDockWidgetTab;
class CDockManager;
class CDockContainerWidget;
class CDockAreaWidget;
class DockContainerWidgetPrivate;
class CFloatingDockContainer;

class ADS_EXPORT CDockWidget : public QFrame
{
    Q_OBJECT
private:
    DockWidgetPrivate* d; 
    friend struct DockWidgetPrivate;

private slots:
    void setToolbarFloatingStyle(bool topLevel);

protected:
    friend class CDockContainerWidget;
    friend class CDockAreaWidget;
    friend class CFloatingDockContainer;
    friend class CDockManager;
    friend struct DockManagerPrivate;
    friend class DockContainerWidgetPrivate;
    friend class CDockAreaTabBar;
    friend class CDockWidgetTab;
    friend struct DockWidgetTabPrivate;
    friend struct DockAreaTitleBarPrivate;

    void setDockManager(CDockManager* DockManager);

    void setDockArea(CDockAreaWidget* DockArea);

    void setToggleViewActionChecked(bool Checked);

    void saveState(QXmlStreamWriter& Stream) const;

    void flagAsUnassigned();

    static void emitTopLevelEventForWidget(CDockWidget* TopLevelDockWidget, bool Floating);

    void emitTopLevelChanged(bool Floating);

    void setClosedState(bool Closed);

    void toggleViewInternal(bool Open);

    bool closeDockWidgetInternal(bool ForceClose = false);

public:
    using Super = QFrame;

    enum DockWidgetFeature
    {
        DockWidgetClosable = 0x01,
        DockWidgetMovable = 0x02,
        DockWidgetFloatable = 0x04,
        DockWidgetDeleteOnClose = 0x08, 
        CustomCloseHandling = 0x10, 
        DockWidgetFocusable = 0x20, 
        DockWidgetForceCloseWithArea = 0x40, 
        DefaultDockWidgetFeatures = DockWidgetClosable | DockWidgetMovable | DockWidgetFloatable | DockWidgetFocusable,
        AllDockWidgetFeatures = DefaultDockWidgetFeatures | DockWidgetDeleteOnClose | CustomCloseHandling,
        DockWidgetAlwaysCloseAndDelete = DockWidgetForceCloseWithArea | DockWidgetDeleteOnClose,
        NoDockWidgetFeatures = 0x00
    };
    Q_DECLARE_FLAGS(DockWidgetFeatures, DockWidgetFeature)

    enum eState
    {
        StateHidden,
        StateDocked,
        StateFloating
    };

    enum eInsertMode
    {
        AutoScrollArea,
        ForceScrollArea,
        ForceNoScrollArea
    };


    enum eMinimumSizeHintMode
    {
        MinimumSizeHintFromDockWidget,
        MinimumSizeHintFromContent
    };


    enum eToggleViewActionMode
    {
        ActionModeToggle,
        ActionModeShow   
    };


    CDockWidget(const QString &title, QWidget* parent = 0);

    virtual ~CDockWidget();

    virtual QSize minimumSizeHint() const override;

    void setWidget(QWidget* widget, eInsertMode InsertMode = AutoScrollArea);

    QWidget* takeWidget();

    QWidget* widget() const;

    CDockWidgetTab* tabWidget() const;

    void setFeatures(DockWidgetFeatures features);

    void setFeature(DockWidgetFeature flag, bool on);

    DockWidgetFeatures features() const;

    CDockManager* dockManager() const;

    CDockContainerWidget* dockContainer() const;

    CDockAreaWidget* dockAreaWidget() const;

    bool isFloating() const;

    bool isInFloatingContainer() const;

    bool isClosed() const;

    QAction* toggleViewAction() const;

    void setToggleViewActionMode(eToggleViewActionMode Mode);

    void setMinimumSizeHintMode(eMinimumSizeHintMode Mode);

    bool isCentralWidget() const;

    void setIcon(const QIcon& Icon);

    QIcon icon() const;

    QToolBar* toolBar() const;

    QToolBar* createDefaultToolBar();

    void setToolBar(QToolBar* ToolBar);

    void setToolBarStyle(Qt::ToolButtonStyle Style, eState State);

    Qt::ToolButtonStyle toolBarStyle(eState State) const;

    void setToolBarIconSize(const QSize& IconSize, eState State);

    QSize toolBarIconSize(eState State) const;

    void setTitleBarActions(QList<QAction*> actions);

    virtual QList<QAction*> titleBarActions() const;


#ifndef QT_NO_TOOLTIP

    void setTabToolTip(const QString &text);
#endif

    bool isFullScreen() const;

    bool isTabbed() const;

    bool isCurrentTab() const;

public: // reimplements QFrame -----------------------------------------------
    virtual bool event(QEvent *e) override;

public slots:
    void toggleView(bool Open = true);

    void setAsCurrentTab();

    void raise();

    void setFloating();

    void deleteDockWidget();

    void closeDockWidget();

    void showFullScreen();

    void showNormal();


signals:
    void viewToggled(bool Open);

    void closed();

    void titleChanged(const QString& Title);

    void topLevelChanged(bool topLevel);

    void closeRequested();

    void visibilityChanged(bool visible);

    void featuresChanged(ads::CDockWidget::DockWidgetFeatures features);
}; // class DockWidget
}
 // namespace ads
//-----------------------------------------------------------------------------
#endif // DockWidgetH