1 /* 2 enumrepository.h 3 4 This file is part of GammaRay, the Qt application inspection and 5 manipulation tool. 6 7 Copyright (C) 2016-2021 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com 8 Author: Volker Krause <volker.krause@kdab.com> 9 10 Licensees holding valid commercial KDAB GammaRay licenses may use this file in 11 accordance with GammaRay Commercial License Agreement provided with the Software. 12 13 Contact info@kdab.com if any conditions of this licensing are not clear to you. 14 15 This program is free software; you can redistribute it and/or modify 16 it under the terms of the GNU General Public License as published by 17 the Free Software Foundation, either version 2 of the License, or 18 (at your option) any later version. 19 20 This program is distributed in the hope that it will be useful, 21 but WITHOUT ANY WARRANTY; without even the implied warranty of 22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 GNU General Public License for more details. 24 25 You should have received a copy of the GNU General Public License 26 along with this program. If not, see <http://www.gnu.org/licenses/>. 27 */ 28 29 #ifndef GAMMARAY_ENUMREPOSITORY_H 30 #define GAMMARAY_ENUMREPOSITORY_H 31 32 #include "gammaray_common_export.h" 33 34 #include "enumdefinition.h" 35 36 #include <QObject> 37 38 namespace GammaRay { 39 40 /*! Collection of EnumDefinition and on-demand client/server transfer of those. */ 41 class GAMMARAY_COMMON_EXPORT EnumRepository : public QObject 42 { 43 Q_OBJECT 44 public: 45 ~EnumRepository() override; 46 47 /*! Request the enum definition for the given enum id. 48 * On the client side the response can be invalid on first request, 49 * as transfer from the server is asynchronous. Listen to the 50 * definitionChanged() signal to be notified for its availability 51 * in that case. 52 */ 53 virtual EnumDefinition definition(EnumId id) const; 54 55 signals: 56 /*! Notification of EnumDefinition availability. 57 * @see definition() 58 */ 59 void definitionChanged(int id); 60 61 //! @cond internal 62 void definitionResponse(const GammaRay::EnumDefinition &def); 63 64 protected: 65 EnumRepository(QObject *parent = nullptr); 66 void addDefinition(const EnumDefinition &def); 67 68 Q_INVOKABLE virtual void requestDefinition(int id) = 0; 69 //! @endcond 70 71 private: 72 QVector<EnumDefinition> m_definitions; 73 }; 74 75 } 76 77 QT_BEGIN_NAMESPACE 78 Q_DECLARE_INTERFACE(GammaRay::EnumRepository, "com.kdab.GammaRay.EnumRepository/1.0") 79 QT_END_NAMESPACE 80 81 #endif // GAMMARAY_ENUMREPOSITORY_H 82