core/Group.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2020 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
  Author: Sérgio Martins <sergio.martins@kdab.com>
 
  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
 
  Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
 
#pragma once
 
#include "DockWidget.h"
#include "kddockwidgets/KDDockWidgets.h"
#include "kddockwidgets/LayoutSaver.h"
#include "kddockwidgets/QtCompat_p.h"
#include "kddockwidgets/core/Controller.h"
#include "kddockwidgets/core/FocusScope.h"
#include "kddockwidgets/docks_export.h"
 
class TestDocks;
 
namespace KDDockWidgets {
class WidgetResizeHandler;
}
 
namespace KDDockWidgets::Core {
 
class LayoutingGuest;
class DropArea;
class MDILayout;
class DockWidget;
class FloatingWindow;
class MainWindow;
class Stack;
class TabBar;
class TitleBar;
 
class DOCKS_EXPORT Group : public Controller, public FocusScope
{
    Q_OBJECT
public:
    typedef Vector<Group *> List;
 
    explicit Group(View *parent = nullptr, FrameOptions = FrameOption_None,
                   int userType = 0);
    virtual ~Group() override;
 
    static Group *deserialize(const LayoutSaver::Group &);
    LayoutSaver::Group serialize() const;
 
    void addTab(DockWidget *, InitialOption = {});
    void addTab(Group *, InitialOption = {});
    void addTab(FloatingWindow *floatingWindow, InitialOption = {});
 
    void insertWidget(DockWidget *, int index, InitialOption = {});
 
    void removeWidget(DockWidget *);
 
    FloatingWindow *detachTab(DockWidget *);
 
    int indexOfDockWidget(const DockWidget *);
 
    int currentIndex() const;
 
    void setCurrentTabIndex(int index);
 
    void setCurrentDockWidget(DockWidget *);
 
    void insertDockWidget(DockWidget *, int index);
 
    DockWidget *dockWidgetAt(int index) const;
 
    DockWidget *currentDockWidget() const;
 
    int dockWidgetCount() const;
 
    Core::Stack *stack() const;
    Core::TabBar *tabBar() const;
 
    void updateTitleAndIcon();
    void onDockWidgetTitleChanged(DockWidget *);
    void updateTitleBarVisibility();
    void updateFloatingActions();
    bool containsMouse(Point globalPos) const;
    Core::TitleBar *titleBar() const;
    Core::TitleBar *actualTitleBar() const;
    QString title() const;
    Icon icon() const;
    Vector<DockWidget *> dockWidgets() const;
 
    bool isTheOnlyGroup() const;
 
    bool isOverlayed() const;
 
    void unoverlay();
 
    bool isFloating() const;
 
    bool isInFloatingWindow() const;
 
    bool isInMainWindow() const;
 
    bool isCentralFrame() const;
 
    bool isDockable() const;
 
    bool alwaysShowsTabs() const;
 
    bool containsDockWidget(DockWidget *w) const;
 
    FloatingWindow *floatingWindow() const;
 
    MainWindow *mainWindow() const;
 
    void restoreToPreviousPosition();
 
    int currentTabIndex() const;
    FrameOptions options() const;
    bool anyNonClosable() const;
    bool anyNonDockable() const;
 
    bool isEmpty() const
    {
        return dockWidgetCount() == 0;
    }
 
    bool hasSingleDockWidget() const
    {
        return dockWidgetCount() == 1;
    }
 
    Core::Item *layoutItem() const;
 
    static int dbg_numFrames();
 
    bool beingDeletedLater() const;
 
    bool hasTabsVisible() const;
 
    Vector<QString> affinities() const;
 
    void setLayoutItem(Core::Item *item);
 
    virtual Rect dragRect() const;
 
    bool allDockWidgetsHave(DockWidgetOption) const;
 
    bool anyDockWidgetsHas(DockWidgetOption) const;
 
    bool allDockWidgetsHave(LayoutSaverOption) const;
 
    bool anyDockWidgetsHas(LayoutSaverOption) const;
 
    void setAllowedResizeSides(CursorPositions sides);
 
    bool isMDI() const;
 
    bool isMDIWrapper() const;
 
    DockWidget *mdiDockWidgetWrapper() const;
 
    DropArea *mdiDropAreaWrapper() const;
 
    Group *mdiFrame() const;
 
    MDILayout *mdiLayout() const;
 
    bool hasNestedMDIDockWidgets() const;
 
    int userType() const;
 
    WidgetResizeHandler *resizeHandler() const;
 
    void renameTab(int index, const QString &);
    void changeTabIcon(int index, const Icon &);
    void setLayout(Layout *);
 
    void onDockWidgetCountChanged();
 
    FloatingWindowFlags requestedFloatingWindowFlags() const;
 
    LayoutingGuest *asLayoutingGuest() const;
 
    static Core::Group *fromItem(const Core::Item *);
 
protected:
    void isFocusedChangedCallback() override;
    void focusedWidgetChangedCallback() override;
    void setParentView_impl(View *parent) override;
 
public:
    Size dockWidgetsMinSize() const;
 
    Size biggestDockWidgetMaxSize() const;
    int nonContentsHeight() const;
 
    class Private;
    Private *dptr() const;
 
private:
    Private *const d;
    bool m_inCtor = true; // Needs to be initialized early, as pointed out by UBSAN
protected:
    bool m_inDtor = false;
 
    Core::Stack *const m_stack;
    Core::TabBar *const m_tabBar;
    Core::TitleBar *const m_titleBar;
 
private:
    KDDW_DELETE_COPY_CTOR(Group)
    friend class ::TestDocks;
    friend class KDDockWidgets::Core::Stack;
 
    void scheduleDeleteLater();
    void onCloseEvent(CloseEvent *);
 
    Layout *m_layout = nullptr;
    WidgetResizeHandler *m_resizeHandler = nullptr;
    bool m_updatingTitleBar = false;
    bool m_beingDeleted = false;
};
 
}