qtquick/views/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_MAIN_WINDOW_QUICK_P_H
#define KD_MAIN_WINDOW_QUICK_P_H
 
#include "View.h"
#include "kddockwidgets/core/views/MainWindowViewInterface.h"
 
#include <QString>
 
namespace KDDockWidgets {
 
namespace Core {
class SideBar;
}
 
namespace QtQuick {
 
 
class DOCKS_EXPORT MainWindow : public QtQuick::View, public Core::MainWindowViewInterface
{
    Q_OBJECT
    Q_PROPERTY(QVector<QString> 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)
public:
    explicit MainWindow(const QString &uniqueName, MainWindowOptions options = {},
                        QQuickItem *parent = nullptr, Qt::WindowFlags flags = {});
 
    ~MainWindow() override;
 
    QSize minSize() const override;
 
    QSize maxSizeHint() const override;
 
    void setPersistentCentralView(const QString &qmlFilename);
 
#ifdef Q_MOC_RUN
    Q_INVOKABLE bool closeDockWidgets(bool force = false);
    Q_INVOKABLE bool sideBarIsVisible(KDDockWidgets::SideBarLocation) const;
    Q_INVOKABLE void clearSideBarOverlay(bool deleteFrame = true);
    Q_INVOKABLE void layoutEqually();
    Q_INVOKABLE bool anySideBarIsVisible() const;
 
    Q_INVOKABLE void moveToSideBar(const QString &dockId);
    Q_INVOKABLE void moveToSideBar(const QString &dockId, KDDockWidgets::SideBarLocation);
    Q_INVOKABLE void restoreFromSideBar(const QString &dockId);
    Q_INVOKABLE void overlayOnSideBar(const QString &dockId);
    Q_INVOKABLE void toggleOverlayOnSideBar(const QString &dockId);
    Q_INVOKABLE void layoutParentContainerEqually(const QString &dockId);
    Q_INVOKABLE void addDockWidgetAsTab(const QString &dockId);
    Q_INVOKABLE void addDockWidget(const QString &dockId, KDDockWidgets::Location,
                                   const QString &relativeToDockId = {},
                                   KDDockWidgets::InitialOption = {});
 
#endif
 
protected:
    QMargins centerWidgetMargins() const override;
    QRect centralAreaGeometry() const override;
    void setContentsMargins(int left, int top, int right, int bottom) override;
 
private:
    class Private;
    Private *const d;
};
}
}
 
#endif