DockContainerWidget.h

Go to the documentation of this file.

#ifndef DockContainerWidgetH
#define DockContainerWidgetH
/*******************************************************************************
** 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"
#include "DockWidget.h"
 
QT_FORWARD_DECLARE_CLASS(QXmlStreamWriter)
 
 
namespace ads
{
class DockContainerWidgetPrivate;
class CDockAreaWidget;
class CDockWidget;
class CDockManager;
struct DockManagerPrivate;
class CFloatingDockContainer;
struct FloatingDockContainerPrivate;
class CFloatingDragPreview;
struct FloatingDragPreviewPrivate;
class CDockingStateReader;
 
class ADS_EXPORT CDockContainerWidget : public QFrame
{
        Q_OBJECT
private:
        DockContainerWidgetPrivate* d; 
    friend class DockContainerWidgetPrivate;
        friend class CDockManager;
        friend struct DockManagerPrivate;
        friend class CDockAreaWidget;
        friend struct DockAreaWidgetPrivate;
        friend class CFloatingDockContainer;
        friend struct FloatingDockContainerPrivate;
        friend class CDockWidget;
        friend class CFloatingDragPreview;
        friend struct FloatingDragPreviewPrivate;
 
public:
  QSplitter* rootSplitter() const;
 
protected:
        virtual bool event(QEvent *e) override;
 
 
        void createRootSplitter();
 
        void dropFloatingWidget(CFloatingDockContainer* FloatingWidget, const QPoint& TargetPos);
 
        void dropWidget(QWidget* Widget, DockWidgetArea DropArea, CDockAreaWidget* TargetAreaWidget);
 
        void addDockArea(CDockAreaWidget* DockAreaWidget, DockWidgetArea area = CenterDockWidgetArea);
 
        void removeDockArea(CDockAreaWidget* area);
 
        void saveState(QXmlStreamWriter& Stream) const;
 
        bool restoreState(CDockingStateReader& Stream, bool Testing);
 
        CDockAreaWidget* lastAddedDockAreaWidget(DockWidgetArea area) const;
 
        CDockWidget* topLevelDockWidget() const;
 
        CDockAreaWidget* topLevelDockArea() const;
 
    QList<CDockWidget*> dockWidgets() const;
 
    void updateSplitterHandles(QSplitter* splitter);
 
public:
        CDockContainerWidget(CDockManager* DockManager, QWidget* parent = 0);
 
        virtual ~CDockContainerWidget();
 
        CDockAreaWidget* addDockWidget(DockWidgetArea area, CDockWidget* Dockwidget,
                CDockAreaWidget* DockAreaWidget = nullptr);
 
        void removeDockWidget(CDockWidget* Dockwidget);
 
        virtual unsigned int zOrderIndex() const;
 
        bool isInFrontOf(CDockContainerWidget* Other) const;
 
        CDockAreaWidget* dockAreaAt(const QPoint& GlobalPos) const;
 
        CDockAreaWidget* dockArea(int Index) const;
 
        QList<CDockAreaWidget*> openedDockAreas() const;
 
    bool hasTopLevelDockWidget() const;
 
        int dockAreaCount() const;
 
        int visibleDockAreaCount() const;
 
        bool isFloating() const;
 
        void dumpLayout();
 
        CDockWidget::DockWidgetFeatures features() const;
 
        CFloatingDockContainer* floatingWidget() const;
 
        void closeOtherAreas(CDockAreaWidget* KeepOpenArea);
 
signals:
        void dockAreasAdded();
 
        void dockAreasRemoved();
 
        void dockAreaViewToggled(ads::CDockAreaWidget* DockArea, bool Open);
}; // class DockContainerWidget
} // namespace ads
//-----------------------------------------------------------------------------
#endif // DockContainerWidgetH