KReport

KReportPluginMetaData.h
1/* This file is part of the KDE project
2 Copyright (C) 2010 by Adam Pigg (adam@piggz.co.uk)
3 Copyright (C) 2015 Jarosław Staniek <staniek@kde.org>
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20
21#ifndef KREPORTPLUGININFO_H
22#define KREPORTPLUGININFO_H
23
24#include <KPluginMetaData>
25
26#include "kreport_export.h"
27
28/*!
29 * @brief Information about a KReport plugin.
30 */
31class KREPORT_EXPORT KReportPluginMetaData : public KPluginMetaData
32{
33public:
35
36 //! @return internal name of the plugin, a shortcut of pluginId()
37 QString id() const;
38
39 //! @return priority of the plugin
40 //! Useful for user interfaces such as tool boxes.
41 int priority() const;
42
43 //! @return true if this plugin is built-in, i.e. has been provided by the KReport
44 //! framework itself, not by a plugin file.
45 bool isBuiltIn() const;
46
47 //! @return true if this plugin is static, i.e. is compiled-in.
48 bool isStatic() const;
49
50protected:
51 explicit KReportPluginMetaData(const QJsonObject &metaData);
52 explicit KReportPluginMetaData(const QPluginLoader &loader);
53
54 void setBuiltIn(bool set);
55 void setStatic(bool set);
56
57 friend class KReportPluginEntry;
58
59private:
60 Q_DISABLE_COPY(KReportPluginMetaData)
61 class Private;
62 Private * const d;
63};
64
65#endif // KREPORTPLUGININFO_H
Information about a KReport plugin.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 12 2024 12:06:50 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.