| 1 | /**************************************************************************** |
| 2 | ** |
| 3 | ** Copyright (C) 2014 Klarälvdalens Datakonsult AB, a KDAB Group company, [email protected], author Milian Wolff <[email protected]> |
| 4 | ** Contact: https://www.qt.io/licensing/ |
| 5 | ** |
| 6 | ** This file is part of the QtWebChannel module of the Qt Toolkit. |
| 7 | ** |
| 8 | ** $QT_BEGIN_LICENSE:LGPL$ |
| 9 | ** Commercial License Usage |
| 10 | ** Licensees holding valid commercial Qt licenses may use this file in |
| 11 | ** accordance with the commercial license agreement provided with the |
| 12 | ** Software or, alternatively, in accordance with the terms contained in |
| 13 | ** a written agreement between you and The Qt Company. For licensing terms |
| 14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
| 15 | ** information use the contact form at https://www.qt.io/contact-us. |
| 16 | ** |
| 17 | ** GNU Lesser General Public License Usage |
| 18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
| 19 | ** General Public License version 3 as published by the Free Software |
| 20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| 21 | ** packaging of this file. Please review the following information to |
| 22 | ** ensure the GNU Lesser General Public License version 3 requirements |
| 23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| 24 | ** |
| 25 | ** GNU General Public License Usage |
| 26 | ** Alternatively, this file may be used under the terms of the GNU |
| 27 | ** General Public License version 2.0 or (at your option) the GNU General |
| 28 | ** Public license version 3 or any later version approved by the KDE Free |
| 29 | ** Qt Foundation. The licenses are as published by the Free Software |
| 30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| 31 | ** included in the packaging of this file. Please review the following |
| 32 | ** information to ensure the GNU General Public License requirements will |
| 33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| 34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
| 35 | ** |
| 36 | ** $QT_END_LICENSE$ |
| 37 | ** |
| 38 | ****************************************************************************/ |
| 39 | |
| 40 | #ifndef SIGNALHANDLER_H |
| 41 | #define SIGNALHANDLER_H |
| 42 | |
| 43 | // |
| 44 | // W A R N I N G |
| 45 | // ------------- |
| 46 | // |
| 47 | // This file is not part of the Qt API. It exists for the convenience |
| 48 | // of other Qt classes. This header file may change from version to |
| 49 | // version without notice, or even be removed. |
| 50 | // |
| 51 | // We mean it. |
| 52 | // |
| 53 | |
| 54 | #include <Qt3DCore/qt3dcore_global.h> |
| 55 | #include <QtCore/QDebug> |
| 56 | #include <QtCore/QHash> |
| 57 | #include <QtCore/QMetaMethod> |
| 58 | #include <QtCore/QObject> |
| 59 | #include <QtCore/QVector> |
| 60 | |
| 61 | QT_BEGIN_NAMESPACE |
| 62 | |
| 63 | namespace Qt3DCore { |
| 64 | |
| 65 | class Q_3DCORESHARED_EXPORT PropertyChangeHandlerBase : public QObject |
| 66 | { |
| 67 | Q_OBJECT |
| 68 | public: |
| 69 | PropertyChangeHandlerBase(QObject *parent = nullptr); |
| 70 | |
| 71 | /** |
| 72 | * Connect to the change signal of @p property in @p object. |
| 73 | */ |
| 74 | void connectToPropertyChange(const QObject *object, int propertyIndex); |
| 75 | |
| 76 | /** |
| 77 | * Disconnect from the change signal of @p property in @p object. |
| 78 | */ |
| 79 | void disconnectFromPropertyChange(const QObject *object, int propertyIndex); |
| 80 | }; |
| 81 | |
| 82 | /** |
| 83 | * The property change handler is similar to QSignalSpy, but geared towards the usecase of Qt3D. |
| 84 | * |
| 85 | * It allows connecting to any number of property change signals of the receiver object and forwards |
| 86 | * the signal invocations to the Receiver by calling its propertyChanged function. |
| 87 | */ |
| 88 | template<class Receiver> |
| 89 | class PropertyChangeHandler : public PropertyChangeHandlerBase |
| 90 | { |
| 91 | public: |
| 92 | PropertyChangeHandler(Receiver *receiver, QObject *parent = nullptr); |
| 93 | |
| 94 | /** |
| 95 | * @internal |
| 96 | * |
| 97 | * Custom implementation of qt_metacall which calls propertyChanged() on the receiver for |
| 98 | * connected signals. |
| 99 | */ |
| 100 | int qt_metacall(QMetaObject::Call call, int methodId, void **args) override; |
| 101 | |
| 102 | private: |
| 103 | Receiver *m_receiver; |
| 104 | }; |
| 105 | |
| 106 | template<class Receiver> |
| 107 | PropertyChangeHandler<Receiver>::PropertyChangeHandler(Receiver *receiver, QObject *parent) |
| 108 | : PropertyChangeHandlerBase(parent) |
| 109 | , m_receiver(receiver) |
| 110 | { |
| 111 | } |
| 112 | |
| 113 | template<class Receiver> |
| 114 | int PropertyChangeHandler<Receiver>::qt_metacall(QMetaObject::Call call, int methodId, void **args) |
| 115 | { |
| 116 | methodId = QObject::qt_metacall(call, methodId, args); |
| 117 | if (methodId < 0) |
| 118 | return methodId; |
| 119 | |
| 120 | if (call == QMetaObject::InvokeMetaMethod) { |
| 121 | m_receiver->propertyChanged(methodId); |
| 122 | return -1; |
| 123 | } |
| 124 | return methodId; |
| 125 | } |
| 126 | |
| 127 | } |
| 128 | |
| 129 | QT_END_NAMESPACE |
| 130 | |
| 131 | #endif // SIGNALHANDLER_H |
| 132 | |