Files
KDDockWidgets/src/qtquick/DockWidgetInstantiator.h
Sergio Martins da70b1baed qtquick: Don't overload Q_INVOKABLES
Apparently QML doesn't support it very well.

Fixes #291
2022-06-19 20:26:19 +01:00

110 lines
3.6 KiB
C++

/*
This file is part of KDDockWidgets.
SPDX-FileCopyrightText: 2019-2022 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_DOCKWIDGET_INSTANTIATOR_P_H
#define KD_DOCKWIDGET_INSTANTIATOR_P_H
#include "qtquick/views/DockWidget_qtquick.h"
#include "qtquick/views/TitleBar_qtquick.h"
#include <QQmlParserStatus>
#include <QQuickItem>
#include <QString>
#include <optional>
namespace KDDockWidgets {
/**
* @brief Indirection helper to instantiate dock widgets from QML
*
* "DockWidget {}" in QML won't create a KDDockWidget::DockWidget directly, but instead an
* DockWidgetInstantiator. DockWidgetInstantiator will then create the DockWidget instance only
* when the QML parsing ends (and all propreties are set)
*
* This allows to pass the correct uniqueName to DockWidget's ctor.
*/
class DockWidgetInstantiator : public QQuickItem
{
Q_OBJECT
Q_PROPERTY(QString uniqueName READ uniqueName WRITE setUniqueName NOTIFY uniqueNameChanged)
Q_PROPERTY(QString source READ source WRITE setSource NOTIFY sourceChanged)
Q_PROPERTY(KDDockWidgets::Views::DockWidget_qtquick *dockWidget READ dockWidget NOTIFY dockWidgetChanged)
Q_PROPERTY(QObject *actualTitleBar READ actualTitleBar NOTIFY actualTitleBarChanged)
Q_PROPERTY(QString title READ title WRITE setTitle NOTIFY titleChanged)
Q_PROPERTY(bool isFocused READ isFocused NOTIFY isFocusedChanged)
Q_PROPERTY(bool isFloating READ isFloating WRITE setFloating NOTIFY isFloatingChanged)
public:
QString uniqueName() const;
void setUniqueName(const QString &);
QString source() const;
void setSource(const QString &);
KDDockWidgets::Views::DockWidget_qtquick *dockWidget() const;
KDDockWidgets::Controllers::DockWidget *controller() const;
QObject *actualTitleBar() const;
QString title() const;
void setTitle(const QString &title);
bool isFocused() const;
bool isFloating() const;
void setFloating(bool);
Q_INVOKABLE void addDockWidgetAsTab(QQuickItem *other,
KDDockWidgets::InitialVisibilityOption = {});
Q_INVOKABLE void addDockWidgetToContainingWindow(QQuickItem *other,
KDDockWidgets::Location location,
QQuickItem *relativeTo = nullptr,
QSize initialSize = {},
KDDockWidgets::InitialVisibilityOption = {});
Q_INVOKABLE void setAsCurrentTab();
Q_INVOKABLE void forceClose();
Q_INVOKABLE bool close();
Q_INVOKABLE void show();
Q_INVOKABLE void raise();
Q_INVOKABLE void moveToSideBar();
protected:
void classBegin() override;
void componentComplete() override;
Q_SIGNALS:
void uniqueNameChanged();
void sourceChanged();
void dockWidgetChanged();
void actualTitleBarChanged();
void titleChanged(const QString &title);
void shown();
void hidden();
void iconChanged();
void guestViewChanged(QQuickItem *);
void optionsChanged(KDDockWidgets::DockWidgetOptions);
void isFocusedChanged(bool);
void isOverlayedChanged(bool);
void isFloatingChanged(bool);
void removedFromSideBar();
void windowActiveAboutToChange(bool activated);
private:
std::optional<bool> m_isFloating;
QString m_uniqueName;
QString m_sourceFilename;
QString m_title;
Controllers::DockWidget *m_dockWidget = nullptr;
};
}
#endif