core/MainWindow.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_MAINWINDOW_BASE_H
#define KD_MAINWINDOW_BASE_H
 
#include "kddockwidgets/docks_export.h"
#include "kddockwidgets/KDDockWidgets.h"
#include "kddockwidgets/LayoutSaver.h"
#include "kddockwidgets/core/Controller.h"
 
class TestDocks;
 
namespace KDDockWidgets {
 
namespace QtWidgets {
class MainWindow;
}
 
namespace QtQuick {
class MainWindow;
}
 
namespace flutter {
class MainWindow;
}
 
namespace Core {
 
class MainWindowViewInterface;
class MDILayout;
class DropArea;
class Group;
class Layout;
class SideBar;
class DockWidget;
 
class DOCKS_EXPORT MainWindow : public Controller
{
    Q_OBJECT
public:
    typedef Vector<MainWindow *> List;
 
    explicit MainWindow(View *view, const QString &uniqueName, MainWindowOptions options);
 
    ~MainWindow() override;
 
    void addDockWidgetAsTab(KDDockWidgets::Core::DockWidget *dockwidget);
 
    void addDockWidget(KDDockWidgets::Core::DockWidget *dockWidget,
                       KDDockWidgets::Location location,
                       KDDockWidgets::Core::DockWidget *relativeTo = nullptr,
                       const KDDockWidgets::InitialOption &initialOption = {});
 
    // dev mode only for now, as it still has bugs.
    // We need to be able to dock to relativeTo=hidden dock
    void addDockWidgetToSide(KDDockWidgets::Core::DockWidget *dockWidget,
                             KDDockWidgets::Location location, const KDDockWidgets::InitialOption &initialOption = {});
    void setPersistentCentralView(std::shared_ptr<View> widget);
    std::shared_ptr<View> persistentCentralView() const;
 
    MainWindowOptions options() const;
 
    void setAffinities(const Vector<QString> &names);
 
    Vector<QString> affinities() const;
 
    void layoutEqually();
 
    void layoutParentContainerEqually(KDDockWidgets::Core::DockWidget *dockWidget);
 
    void moveToSideBar(KDDockWidgets::Core::DockWidget *dw);
 
    void moveToSideBar(KDDockWidgets::Core::DockWidget *dw,
                       KDDockWidgets::SideBarLocation location);
 
    void restoreFromSideBar(KDDockWidgets::Core::DockWidget *dw);
 
    void overlayOnSideBar(KDDockWidgets::Core::DockWidget *dw);
 
    void toggleOverlayOnSideBar(KDDockWidgets::Core::DockWidget *dw);
 
    void clearSideBarOverlay(bool deleteGroup = true);
 
    KDDockWidgets::Core::SideBar *
    sideBarForDockWidget(const KDDockWidgets::Core::DockWidget *dw) const;
 
    bool sideBarIsVisible(KDDockWidgets::SideBarLocation location) const;
 
    Core::DockWidget *overlayedDockWidget() const;
 
    bool anySideBarIsVisible() const;
 
    bool isMDI() const;
 
    bool closeDockWidgets(bool force = false);
 
    int overlayMargin() const;
 
    void setOverlayMargin(int margin);
 
    void setContentsMargins(int l, int t, int r, int b);
 
    Core::SideBar *sideBar(SideBarLocation location) const;
 
    // Internal public API:
 
    DropArea *dropArea() const;
 
    DropArea *multiSplitter() const;
 
    Layout *layout() const;
 
    MDILayout *mdiLayout() const;
 
    QString uniqueName() const;
 
 
    Margins centerWidgetMargins() const;
 
    void init(const QString &name);
 
protected:
    void setUniqueName(const QString &uniqueName);
    Rect centralAreaGeometry() const;
 
private:
    class Private;
    Private *const d;
 
    friend class KDDockWidgets::QtWidgets::MainWindow;
    friend class KDDockWidgets::QtQuick::MainWindow;
    friend class KDDockWidgets::flutter::MainWindow;
 
    friend class KDDockWidgets::Core::MainWindowViewInterface;
    friend class ::TestDocks;
    friend class KDDockWidgets::LayoutSaver;
    bool deserialize(const LayoutSaver::MainWindow &);
    LayoutSaver::MainWindow serialize() const;
};
}
}
 
#endif