MainWindowBase.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2019-2023 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 "docks_export.h"
#include "KDDockWidgets.h"
#include "QWidgetAdapter.h"
#include "LayoutSaver.h"
 
#include <QVector>
#include <QMargins>
 
class TestDocks;
 
namespace KDDockWidgets {
 
class DockWidgetBase;
class Frame;
class DropArea;
class MDILayoutWidget;
class MultiSplitter;
class LayoutWidget;
class DropAreaWithCentralFrame;
class SideBar;
 
#ifndef PYTHON_BINDINGS // Pyside bug: https://bugreports.qt.io/projects/PYSIDE/issues/PYSIDE-1327
class DOCKS_EXPORT MainWindowBase : public QMainWindowOrQuick
#else
class DOCKS_EXPORT MainWindowBase : public QMainWindow
#endif
{
    Q_OBJECT
    Q_PROPERTY(QStringList affinities READ affinities CONSTANT)
    Q_PROPERTY(QString uniqueName READ uniqueName CONSTANT)
    Q_PROPERTY(KDDockWidgets::MainWindowOptions options READ options CONSTANT)
    Q_PROPERTY(bool isMDI READ isMDI CONSTANT)
    Q_PROPERTY(int overlayMargin READ overlayMargin WRITE setOverlayMargin NOTIFY overlayMarginChanged)
public:
    typedef QVector<MainWindowBase *> List;
    explicit MainWindowBase(const QString &uniqueName, MainWindowOptions options = MainWindowOption_HasCentralFrame,
                            WidgetType *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags());
 
    ~MainWindowBase() override;
 
    Q_INVOKABLE void addDockWidgetAsTab(KDDockWidgets::DockWidgetBase *dockwidget);
 
    Q_INVOKABLE void addDockWidget(KDDockWidgets::DockWidgetBase *dockWidget,
                                   KDDockWidgets::Location location,
                                   KDDockWidgets::DockWidgetBase *relativeTo = nullptr,
                                   KDDockWidgets::InitialOption initialOption = {});
 
    Q_INVOKABLE void setPersistentCentralWidget(KDDockWidgets::QWidgetOrQuick *widget);
    QWidgetOrQuick *persistentCentralWidget() const;
 
    QString uniqueName() const;
 
 
    MainWindowOptions options() const;
 
    DropAreaWithCentralFrame *dropArea() const;
 
    MultiSplitter *multiSplitter() const;
 
    LayoutWidget *layoutWidget() const;
 
    MDILayoutWidget *mdiLayoutWidget() const;
 
    void setAffinities(const QStringList &names);
 
    QStringList affinities() const;
 
    Q_INVOKABLE void layoutEqually();
 
    Q_INVOKABLE void layoutParentContainerEqually(KDDockWidgets::DockWidgetBase *dockWidget);
 
    Q_INVOKABLE void moveToSideBar(KDDockWidgets::DockWidgetBase *);
 
    Q_INVOKABLE void moveToSideBar(KDDockWidgets::DockWidgetBase *, KDDockWidgets::SideBarLocation);
 
    Q_INVOKABLE void restoreFromSideBar(KDDockWidgets::DockWidgetBase *);
 
    Q_INVOKABLE void overlayOnSideBar(KDDockWidgets::DockWidgetBase *);
 
    Q_INVOKABLE void toggleOverlayOnSideBar(KDDockWidgets::DockWidgetBase *);
 
    Q_INVOKABLE void clearSideBarOverlay(bool deleteFrame = true);
 
    Q_INVOKABLE KDDockWidgets::SideBar *
    sideBarForDockWidget(const KDDockWidgets::DockWidgetBase *) const;
 
    Q_INVOKABLE bool sideBarIsVisible(KDDockWidgets::SideBarLocation) const;
 
    DockWidgetBase *overlayedDockWidget() const;
 
    bool anySideBarIsVisible() const;
 
    bool isMDI() const;
 
    Q_INVOKABLE bool closeDockWidgets(bool force = false);
 
    QRect windowGeometry() const;
 
    int overlayMargin() const;
 
    void setOverlayMargin(int margin);
 
protected:
#ifdef KDDOCKWIDGETS_QTWIDGETS
    void onCloseEvent(QCloseEvent *);
#else
    // QtQuick uses a different base class. This will be fixed in the wip/2.0 branch.
    void onCloseEvent(QCloseEvent *) override;
#endif
 
    void setUniqueName(const QString &uniqueName);
    void onResized(QResizeEvent *); // Because QtQuick doesn't have resizeEvent()
    virtual QMargins centerWidgetMargins() const = 0;
    virtual SideBar *sideBar(SideBarLocation) const = 0;
    virtual QRect centralAreaGeometry() const
    {
        return {};
    }
 
Q_SIGNALS:
    void uniqueNameChanged();
 
    void frameCountChanged(int);
 
    void overlayMarginChanged(int);
 
private:
    class Private;
    Private *const d;
 
    friend class ::TestDocks;
    friend class LayoutSaver;
    bool deserialize(const LayoutSaver::MainWindow &);
    LayoutSaver::MainWindow serialize() const;
};
}
 
#endif