DockManager.h

Go to the documentation of this file.

#ifndef DockManagerH
#define DockManagerH
/*******************************************************************************
** 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 "ads_globals.h"
#include "DockContainerWidget.h"
#include "DockWidget.h"
#include "FloatingDockContainer.h"


QT_FORWARD_DECLARE_CLASS(QSettings)
QT_FORWARD_DECLARE_CLASS(QMenu)

namespace ads
{
struct DockManagerPrivate;
class CFloatingDockContainer;
struct FloatingDockContainerPrivate;
class CDockContainerWidget;
class DockContainerWidgetPrivate;
class CDockOverlay;
class CDockAreaTabBar;
class CDockWidgetTab;
struct DockWidgetTabPrivate;
struct DockAreaWidgetPrivate;
class CIconProvider;
class CDockComponentsFactory;

class ADS_EXPORT CDockManager : public CDockContainerWidget
{
        Q_OBJECT
private:
        DockManagerPrivate* d; 
        friend struct DockManagerPrivate;
        friend class CFloatingDockContainer;
        friend struct FloatingDockContainerPrivate;
        friend class CDockContainerWidget;
        friend class DockContainerWidgetPrivate;
        friend class CDockAreaTabBar;
        friend class CDockWidgetTab;
        friend struct DockAreaWidgetPrivate;
        friend struct DockWidgetTabPrivate;
        friend class CFloatingDragPreview;
        friend struct FloatingDragPreviewPrivate;
        friend class CDockAreaTitleBar;


protected:
        void registerFloatingWidget(CFloatingDockContainer* FloatingWidget);

        void removeFloatingWidget(CFloatingDockContainer* FloatingWidget);

        void registerDockContainer(CDockContainerWidget* DockContainer);

        void removeDockContainer(CDockContainerWidget* DockContainer);

        CDockOverlay* containerOverlay() const;

        CDockOverlay* dockAreaOverlay() const;


        void notifyWidgetOrAreaRelocation(QWidget* RelocatedWidget);

        void notifyFloatingWidgetDrop(CFloatingDockContainer* FloatingWidget);


        virtual void showEvent(QShowEvent *event) override;

public:
        using Super = CDockContainerWidget;

        enum eViewMenuInsertionOrder
        {
                MenuSortedByInsertion,
                MenuAlphabeticallySorted
        };

        enum eConfigFlag
        {
                ActiveTabHasCloseButton = 0x0001,    
                DockAreaHasCloseButton = 0x0002,     
                DockAreaCloseButtonClosesTab = 0x0004,
                OpaqueSplitterResize = 0x0008, 
                XmlAutoFormattingEnabled = 0x0010,
                XmlCompressionEnabled = 0x0020,
                TabCloseButtonIsToolButton = 0x0040,
                AllTabsHaveCloseButton = 0x0080, 
                RetainTabSizeWhenCloseButtonHidden = 0x0100, 
                OpaqueUndocking = 0x0200,
                DragPreviewIsDynamic = 0x0400,
                DragPreviewShowsContentPixmap = 0x0800,
                DragPreviewHasWindowFrame = 0x1000,
                AlwaysShowTabs = 0x2000,
                DockAreaHasUndockButton = 0x4000,     
                DockAreaHasTabsMenuButton = 0x8000,     
                DockAreaHideDisabledButtons = 0x10000,    
                DockAreaDynamicTabsMenuButtonVisibility = 0x20000, 
                FloatingContainerHasWidgetTitle = 0x40000, 
                FloatingContainerHasWidgetIcon = 0x80000, 
                HideSingleCentralWidgetTitleBar = 0x100000, 

                FocusHighlighting = 0x200000, 
                EqualSplitOnInsertion = 0x400000, 

                FloatingContainerForceNativeTitleBar = 0x800000, 
        FloatingContainerForceQWidgetTitleBar = 0x1000000,

        DefaultDockAreaButtons = DockAreaHasCloseButton
                                                           | DockAreaHasUndockButton
                                       | DockAreaHasTabsMenuButton,

                DefaultBaseConfig = DefaultDockAreaButtons
                                  | ActiveTabHasCloseButton
                                  | XmlCompressionEnabled
                                  | FloatingContainerHasWidgetTitle,

        DefaultOpaqueConfig = DefaultBaseConfig
                                    | OpaqueSplitterResize
                                    | OpaqueUndocking, 

                DefaultNonOpaqueConfig = DefaultBaseConfig
                              | DragPreviewShowsContentPixmap, 

                NonOpaqueWithWindowFrame = DefaultNonOpaqueConfig
                              | DragPreviewHasWindowFrame 
        };
        Q_DECLARE_FLAGS(ConfigFlags, eConfigFlag)

        
        CDockManager(QWidget* parent = nullptr);

        virtual ~CDockManager() override;

        static ConfigFlags configFlags();

        static void setConfigFlags(const ConfigFlags Flags);

        static void setConfigFlag(eConfigFlag Flag, bool On = true);

        static bool testConfigFlag(eConfigFlag Flag);

        static CIconProvider& iconProvider();

        CDockAreaWidget* addDockWidget(DockWidgetArea area, CDockWidget* Dockwidget,
                CDockAreaWidget* DockAreaWidget = nullptr);

        CDockAreaWidget* addDockWidgetTab(DockWidgetArea area,
                CDockWidget* Dockwidget);

        CDockAreaWidget* addDockWidgetTabToArea(CDockWidget* Dockwidget,
                CDockAreaWidget* DockAreaWidget);

        CFloatingDockContainer* addDockWidgetFloating(CDockWidget* Dockwidget);

        CDockWidget* findDockWidget(const QString& ObjectName) const;

        void removeDockWidget(CDockWidget* Dockwidget);

        QMap<QString, CDockWidget*> dockWidgetsMap() const;

        const QList<CDockContainerWidget*> dockContainers() const;

        const QList<CFloatingDockContainer*> floatingWidgets() const;

        unsigned int zOrderIndex() const override;

        QByteArray saveState(int version = 0) const;

        bool restoreState(const QByteArray &state, int version = 0);

        void addPerspective(const QString& UniquePrespectiveName);

        void removePerspective(const QString& Name);

        void removePerspectives(const QStringList& Names);

        QStringList perspectiveNames() const;

        void savePerspectives(QSettings& Settings) const;

        void loadPerspectives(QSettings& Settings);

    CDockWidget* centralWidget() const;

    CDockAreaWidget* setCentralWidget(CDockWidget* widget);

        QAction* addToggleViewActionToMenu(QAction* ToggleViewAction,
                const QString& Group = QString(), const QIcon& GroupIcon = QIcon());

        QMenu* viewMenu() const;

        void setViewMenuInsertionOrder(eViewMenuInsertionOrder Order);

        bool isRestoringState() const;

        static int startDragDistance();

        template <class QWidgetPtr>
        static void setWidgetFocus(QWidgetPtr widget)
        {
                if (!CDockManager::testConfigFlag(CDockManager::FocusHighlighting))
                {
                        return;
                }

                widget->setFocus(Qt::OtherFocusReason);
        }

#ifdef Q_OS_LINUX
        bool eventFilter(QObject *obj, QEvent *e) override;
#endif

        CDockWidget* focusedDockWidget() const;

    QList<int> splitterSizes(CDockAreaWidget *ContainedArea) const;

    void setSplitterSizes(CDockAreaWidget *ContainedArea, const QList<int>& sizes);

public slots:
        void openPerspective(const QString& PerspectiveName);

        void setDockWidgetFocused(CDockWidget* DockWidget);

signals:
        void perspectiveListChanged();

        void perspectivesRemoved();

        void restoringState();

    void stateRestored();

    void openingPerspective(const QString& PerspectiveName);

    void perspectiveOpened(const QString& PerspectiveName);

        void floatingWidgetCreated(ads::CFloatingDockContainer* FloatingWidget);

    void dockAreaCreated(ads::CDockAreaWidget* DockArea);

    void dockWidgetAdded(ads::CDockWidget* DockWidget);

    void dockWidgetAboutToBeRemoved(ads::CDockWidget* DockWidget);

    void dockWidgetRemoved(ads::CDockWidget* DockWidget);

    void focusedDockWidgetChanged(ads::CDockWidget* old, ads::CDockWidget* now);
}; // class DockManager
} // namespace ads
//-----------------------------------------------------------------------------
#endif // DockManagerH