dockpanel.h

浏览该文件的文档.

 
#pragma once
 
#include "qxdock/dockwidget.h"
#include "qxdock_global.h"
#include "qxmlstream.h"
#include <QFrame>
 
class QAbstractButton;
 
QX_DOCK_BEGIN_NAMESPACE
 
class DockWindow;
class DockContainer;
class DockSplitter;
class DockTitleBar;
class DockAutoHideContainer;
class DockStateReader;
 
class DockPanelPrivate;
 
class QX_DOCK_EXPORT DockPanel : public QFrame
{
    Q_OBJECT
public:
    using Super = QFrame;
 
    enum DockAreaFlag {
        HideSingleWidgetTitleBar = 0x0001,
        DefaultFlags = 0x0000
    };
    Q_DECLARE_FLAGS(DockAreaFlags, DockAreaFlag)
public:
    explicit DockPanel(DockWindow *window, DockContainer *parent);
    ~DockPanel();
 
    DockWindow *dockWindow() const;
    DockContainer *dockContainer() const;
 
    DockSplitter *parentSplitter() const;
 
    QRect titleBarGeometry() const;
    QRect contentAreaGeometry() const;
 
    int dockWidgetsCount() const;
    QList<DockWidget *> dockWidgets() const;
    int openDockWidgetsCount() const;
    QList<DockWidget *> openedDockWidgets() const;
    DockWidget *dockWidget(int index) const;
 
    int currentIndex() const;
 
    DockWidget *currentDockWidget() const;
    void setCurrentDockWidget(DockWidget *w);
 
    DockWidget::DockWidgetFeatures features(Qx::DockBitwiseOperator mode = Qx::DockBitwiseAnd) const;
 
    QAbstractButton *titleBarButton(Qx::DockTitleBarButton which) const;
 
    virtual void setVisible(bool visible) override;
 
    Qx::DockWidgetAreas allowedAreas() const;
    void setAllowedAreas(Qx::DockWidgetAreas areas);
 
    DockTitleBar *titleBar() const;
 
    DockAreaFlags dockAreaFlags() const;
    void setDockAreaFlags(DockAreaFlags flags);
    void setDockAreaFlag(DockAreaFlag flag, bool on);
    bool isCentralWidgetArea() const;
    bool containsCentralWidget() const;
 
    bool isTopLevelArea() const;
 
    DockAutoHideContainer *autoHideContainer() const;
    void setAutoHideContainer(DockAutoHideContainer *container);
    bool isAutoHide() const;
 
    int indexOfFirstOpenDockWidget() const;
 
    void saveState(QXmlStreamWriter &s) const;
    static bool restoreState(DockStateReader &s, DockPanel *&createdWidget, bool testing,
                             DockContainer *parentContainer);
 
    virtual QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    void setCurrentIndex(int index);
    void closeArea();
    void closeOtherAreas();
    void setAutoHide(bool enable, Qx::DockSideBarArea area = Qx::DockSideBarNone, int tabIndex = -1);
    void toggleAutoHide(Qx::DockSideBarArea area = Qx::DockSideBarNone);
    void setFloating();
 
protected Q_SLOTS:
    void toggleView(bool open);
 
private Q_SLOTS:
    void onTabCloseRequested(int index);
    void reorderDockWidget(int fromIndex, int toIndex);
    void updateAutoHideButtonCheckState();
    void updateTitleBarButtonsToolTips();
    Qx::DockSideBarArea calculateSideBarArea() const;
    void onDockWidgetFeaturesChanged();
 
Q_SIGNALS:
    void currentChanging(int index);
    void currentChanged(int index);
    void viewToggled(bool open);
    void tabBarClicked(int index);
protected:
    void addDockWidget(DockWidget *w);
    void insertDockWidget(int index, DockWidget *w, bool activate = true);
    void removeDockWidget(DockWidget *w);
    DockWidget *nextOpenDockWidget(DockWidget *w) const;
    void toggleDockWidgetView(DockWidget *w, bool open);
    int indexOf(DockWidget *w) const;
    void hideAreaWithNoVisibleContent();
    void updateTitleBarVisibility();
    void internalSetCurrentDockWidget(DockWidget *w);
    void updateTitleBarButtonVisibility(bool isTopLevel);
    void markTitleBarMenuOutdated();
protected:
#ifdef Q_OS_WIN
    virtual bool event(QEvent *e) override;
#endif
private:
    QX_DECLARE_PRIVATE(DockPanel)
    friend class DockContainerPrivate;
    friend class DockWidget;
    friend class DockWidgetPrivate;
    friend class DockContainer;
    friend class DockAutoHideContainer;
    friend class DockWindow;
    friend class DockWindowPrivate;
};
 
QX_DOCK_END_NAMESPACE