MainWindowInstantiator.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_INSTANTIATOR_P_H
#define KD_MAIN_WINDOW_INSTANTIATOR_P_H
#pragma once
 
#include "kddockwidgets/docks_export.h"
#include "kddockwidgets/KDDockWidgets.h"
 
#include <QQuickItem>
 
namespace KDDockWidgets {
 
namespace Core {
class MainWindow;
class SideBar;
}
 
class DOCKS_EXPORT MainWindowInstantiator : public QQuickItem
{
    Q_OBJECT
    Q_PROPERTY(QString uniqueName READ uniqueName WRITE setUniqueName NOTIFY uniqueNameChanged)
    Q_PROPERTY(KDDockWidgets::MainWindowOptions options READ options WRITE setOptions NOTIFY
                   optionsChanged)
    Q_PROPERTY(bool isMDI READ isMDI CONSTANT)
    Q_PROPERTY(QVector<QString> affinities READ affinities CONSTANT)
public:
    MainWindowInstantiator();
 
    QString uniqueName() const;
    void setUniqueName(const QString &);
 
    KDDockWidgets::MainWindowOptions options() const;
    void setOptions(KDDockWidgets::MainWindowOptions);
 
    QVector<QString> affinities() const;
    bool isMDI() const;
 
    Q_INVOKABLE void addDockWidget(QQuickItem *dockWidget, KDDockWidgets::Location location,
                                   QQuickItem *relativeTo = nullptr, QSize initialSize = {},
                                   KDDockWidgets::InitialVisibilityOption = {});
 
    Q_INVOKABLE void addDockWidgetAsTab(QQuickItem *dockWidget);
 
    Q_INVOKABLE void layoutEqually();
    Q_INVOKABLE void layoutParentContainerEqually(QQuickItem *dockWidget);
    Q_INVOKABLE void moveToSideBar(QQuickItem *);
    Q_INVOKABLE void moveToSideBar(QQuickItem *, KDDockWidgets::SideBarLocation);
    Q_INVOKABLE void restoreFromSideBar(QQuickItem *);
    Q_INVOKABLE void overlayOnSideBar(QQuickItem *);
    Q_INVOKABLE void toggleOverlayOnSideBar(QQuickItem *);
    Q_INVOKABLE void clearSideBarOverlay(bool deleteFrame = true);
    Q_INVOKABLE bool sideBarIsVisible(KDDockWidgets::SideBarLocation) const;
    Q_INVOKABLE bool closeDockWidgets(bool force = false);
 
protected:
    void classBegin() override;
    void componentComplete() override;
 
Q_SIGNALS:
    void uniqueNameChanged();
    void optionsChanged();
 
private:
    QString m_uniqueName;
    Core::MainWindow *m_mainWindow = nullptr;
    KDDockWidgets::MainWindowOptions m_options = KDDockWidgets::MainWindowOption_None;
};
 
}
 
#endif