DockAreaWidget.h

Go to the documentation of this file.

#ifndef DockAreaWidgetH
#define DockAreaWidgetH
/*******************************************************************************
** 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)
QT_FORWARD_DECLARE_CLASS(QAbstractButton)
 
namespace ads
{
struct DockAreaWidgetPrivate;
class CDockManager;
class CDockContainerWidget;
class DockContainerWidgetPrivate;
class CDockAreaTitleBar;
 
 
class ADS_EXPORT CDockAreaWidget : public QFrame
{
        Q_OBJECT
private:
        DockAreaWidgetPrivate* d; 
        friend struct DockAreaWidgetPrivate;
        friend class CDockContainerWidget;
        friend class DockContainerWidgetPrivate;
        friend class CDockWidgetTab;
        friend struct DockWidgetPrivate;
        friend class CDockWidget;
        friend struct DockManagerPrivate;
        friend class CDockManager;
        void onDockWidgetFeaturesChanged();
 
private slots:
        void onTabCloseRequested(int Index);
 
        void reorderDockWidget(int fromIndex, int toIndex);
 
protected:
        void insertDockWidget(int index, CDockWidget* DockWidget, bool Activate = true);
 
        void addDockWidget(CDockWidget* DockWidget);
 
        void removeDockWidget(CDockWidget* DockWidget);
 
        void toggleDockWidgetView(CDockWidget* DockWidget, bool Open);
 
        CDockWidget* nextOpenDockWidget(CDockWidget* DockWidget) const;
 
        int index(CDockWidget* DockWidget);
 
        void hideAreaWithNoVisibleContent();
 
        void updateTitleBarVisibility();
 
        void internalSetCurrentDockWidget(CDockWidget* DockWidget);
 
        void markTitleBarMenuOutdated();
 
protected slots:
        void toggleView(bool Open);
 
public:
        using Super = QFrame;
 
        enum eDockAreaFlag
        {
                HideSingleWidgetTitleBar = 0x0001,
                DefaultFlags = 0x0000
        };
        Q_DECLARE_FLAGS(DockAreaFlags, eDockAreaFlag)
 
    
        CDockAreaWidget(CDockManager* DockManager, CDockContainerWidget* parent);
 
        virtual ~CDockAreaWidget();
 
        CDockManager* dockManager() const;
 
        CDockContainerWidget* dockContainer() const;
 
    virtual QSize minimumSizeHint() const override;
 
        QRect titleBarGeometry() const;
 
        QRect contentAreaGeometry() const;
 
        int dockWidgetsCount() const;
 
        QList<CDockWidget*> dockWidgets() const;
 
        int openDockWidgetsCount() const;
 
        QList<CDockWidget*> openedDockWidgets() const;
 
        CDockWidget* dockWidget(int Index) const;
 
        int currentIndex() const;
 
        int indexOfFirstOpenDockWidget() const;
 
        CDockWidget* currentDockWidget() const;
 
        void setCurrentDockWidget(CDockWidget* DockWidget);
 
        void saveState(QXmlStreamWriter& Stream) const;
 
        CDockWidget::DockWidgetFeatures features(eBitwiseOperator Mode = BitwiseAnd) const;
 
        QAbstractButton* titleBarButton(TitleBarButton which) const;
 
        virtual void setVisible(bool Visible) override;
 
        void setAllowedAreas(DockWidgetAreas areas);
 
        DockWidgetAreas allowedAreas() const;
 
        CDockAreaTitleBar* titleBar() const;
 
        DockAreaFlags dockAreaFlags() const;
 
        void setDockAreaFlags(DockAreaFlags Flags);
 
        void setDockAreaFlag(eDockAreaFlag Flag, bool On);
 
    bool isCentralWidgetArea() const;
 
public slots:
        void setCurrentIndex(int index);
 
        void closeArea();
 
        void closeOtherAreas();
 
signals:
        void tabBarClicked(int index);
 
    void currentChanging(int index);
 
        void currentChanged(int index);
 
        void viewToggled(bool Open);
}; // class DockAreaWidget
}
 // namespace ads
//-----------------------------------------------------------------------------
#endif // DockAreaWidgetH