DockRegistry.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2019 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.
*/
 
#ifndef KD_DOCKREGISTRY_P_H
#define KD_DOCKREGISTRY_P_H
 
#include "kddockwidgets/KDDockWidgets.h"
#include "kddockwidgets/core/View.h"
#include "kddockwidgets/QtCompat_p.h"
#include "kddockwidgets/core/EventFilterInterface.h"
 
#include <map>
#include <memory>
 
namespace KDDockWidgets {
 
 
namespace Core {
class FloatingWindow;
class Layout;
class SideBar;
class SideBarGroupings;
class MainWindow;
class DockWidget;
class Group;
class MainWindowMDIViewInterface;
class MainWindowViewInterface;
class FocusScope;
struct WindowBeingDragged;
}
 
class MainWindowMDI;
 
class DOCKS_EXPORT DockRegistry : public Core::Object, public Core::EventFilterInterface
{
    Q_OBJECT
 
public:
    enum class DockByNameFlag {
        None = 0,
        ConsultRemapping = 1,
        CreateIfNotFound =
            2, 
        SilentIfNotFound = 4 
    };
    Q_DECLARE_FLAGS(DockByNameFlags, DockByNameFlag)
 
    static DockRegistry *self();
    ~DockRegistry();
    void registerDockWidget(Core::DockWidget *);
    void unregisterDockWidget(Core::DockWidget *);
 
    void registerMainWindow(Core::MainWindow *);
    void unregisterMainWindow(Core::MainWindow *);
 
    void registerFloatingWindow(Core::FloatingWindow *);
    void unregisterFloatingWindow(Core::FloatingWindow *);
 
    void registerGroup(Core::Group *);
    void unregisterGroup(Core::Group *);
 
    void registerLayoutSaver();
    void unregisterLayoutSaver();
 
    Q_INVOKABLE KDDockWidgets::Core::DockWidget *focusedDockWidget() const;
 
    Q_INVOKABLE bool containsDockWidget(const QString &uniqueName) const;
    Q_INVOKABLE bool containsMainWindow(const QString &uniqueName) const;
 
    Q_INVOKABLE KDDockWidgets::Core::DockWidget *
    dockByName(const QString &, KDDockWidgets::DockRegistry::DockByNameFlags = {}) const;
    Q_INVOKABLE KDDockWidgets::Core::MainWindow *mainWindowByName(const QString &) const;
 
    bool isSane() const;
 
    Vector<Core::DockWidget *> dockwidgets() const;
 
    Vector<Core::DockWidget *> dockWidgets(const Vector<QString> &names);
 
    Vector<Core::DockWidget *> closedDockwidgets(bool honourSkipped) const;
 
    Vector<Core::MainWindow *> mainwindows() const;
 
    Vector<Core::MainWindowViewInterface *> mainDockingAreas() const;
 
    Vector<Core::MainWindow *> mainWindows(const Vector<QString> &names);
 
    Vector<Core::Group *> groups() const;
 
    Vector<Core::FloatingWindow *>
    floatingWindows(bool includeBeingDeleted = false, bool honourSkipped = false) const;
 
    Vector<std::shared_ptr<Core::Window>> floatingQWindows() const;
 
    Q_INVOKABLE bool hasFloatingWindows() const;
 
    Core::FloatingWindow *
    floatingWindowForHandle(std::shared_ptr<Core::Window> windowHandle) const;
 
    Core::FloatingWindow *floatingWindowForHandle(Core::WId hwnd) const;
 
    Core::MainWindow *mainWindowForHandle(std::shared_ptr<Core::Window> windowHandle) const;
 
    Vector<std::shared_ptr<Core::Window>> topLevels(bool excludeFloatingDocks = false) const;
 
    Q_INVOKABLE void clear(const Vector<QString> &affinities = {});
 
    void clear(const Vector<Core::DockWidget *> &dockWidgets,
               const Vector<Core::MainWindow *> &mainWindows,
               const Vector<QString> &affinities);
 
    void ensureAllFloatingWidgetsAreMorphed();
 
    bool isEmpty(bool excludeBeingDeleted = false) const;
 
    Vector<Core::MainWindow *> mainWindowsWithAffinity(const Vector<QString> &affinities) const;
 
    Core::Layout *layoutForItem(const Core::Item *) const;
 
    bool itemIsInMainWindow(const Core::Item *) const;
 
    bool affinitiesMatch(const Vector<QString> &affinities1, const Vector<QString> &affinities2) const;
 
    Vector<QString> mainWindowsNames() const;
 
    Vector<QString> dockWidgetNames() const;
 
    bool isProbablyObscured(std::shared_ptr<Core::Window> target,
                            Core::FloatingWindow *exclude) const;
 
    bool isProbablyObscured(std::shared_ptr<Core::Window> target, Core::WindowBeingDragged *exclude) const;
 
    SideBarLocation sideBarLocationForDockWidget(const Core::DockWidget *) const;
 
    Core::SideBar *sideBarForDockWidget(const Core::DockWidget *) const;
 
    Core::Group *groupInMDIResize() const;
 
    void setCurrentCloseReason(CloseReason);
    CloseReason currentCloseReason();
 
    class Private;
    Private *dptr() const;
 
private:
    friend class Core::FocusScope;
    friend class Core::TitleBar;
 
    explicit DockRegistry(Core::Object *parent = nullptr);
    bool onDockWidgetPressed(Core::DockWidget *dw, MouseEvent *);
    void onFocusedViewChanged(std::shared_ptr<Core::View> view);
    void maybeDelete();
    void setFocusedDockWidget(Core::DockWidget *);
 
    // EventFilterInterface:
    bool onExposeEvent(std::shared_ptr<Core::Window>) override;
    bool onMouseButtonPress(Core::View *, MouseEvent *) override;
 
    // To honour Config::Flag_AutoHideAsTabGroups:
    void addSideBarGrouping(const Vector<Core::DockWidget *> &);
    void removeSideBarGrouping(const Vector<Core::DockWidget *> &);
    Vector<Core::DockWidget *> sideBarGroupingFor(Core::DockWidget *) const;
 
    Private *const d;
 
    Vector<Core::DockWidget *> m_dockWidgets;
    Vector<Core::MainWindow *> m_mainWindows;
    Vector<Core::Group *> m_groups;
    Vector<Core::FloatingWindow *> m_floatingWindows;
 
    mutable std::map<QString, QString> m_dockWidgetIdRemapping;
 
    // To honour Config::Flag_AutoHideAsTabGroups
    Core::SideBarGroupings *const m_sideBarGroupings;
};
 
struct CloseReasonSetter
{
    CloseReasonSetter(CloseReason);
    ~CloseReasonSetter();
 
private:
    CloseReasonSetter(CloseReasonSetter &) = delete;
    CloseReasonSetter &operator=(CloseReason &) = delete;
};
 
}
 
#endif