Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qpluginloader.h
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QPLUGINLOADER_H
5#define QPLUGINLOADER_H
6
7#include <QtCore/qglobal.h>
8#if QT_CONFIG(library)
9#include <QtCore/qlibrary.h>
10#endif
11#include <QtCore/qplugin.h>
12
14
15#if QT_CONFIG(library)
16
17class QLibraryPrivate;
18class QJsonObject;
19
20class Q_CORE_EXPORT QPluginLoader : public QObject
21{
22 Q_OBJECT
23 Q_PROPERTY(QString fileName READ fileName WRITE setFileName)
24 Q_PROPERTY(QLibrary::LoadHints loadHints READ loadHints WRITE setLoadHints)
25public:
26 explicit QPluginLoader(QObject *parent = nullptr);
27 explicit QPluginLoader(const QString &fileName, QObject *parent = nullptr);
28 ~QPluginLoader();
29
30 QObject *instance();
31 QJsonObject metaData() const;
32
33 static QObjectList staticInstances();
34 static QList<QStaticPlugin> staticPlugins();
35
36 bool load();
37 bool unload();
38 bool isLoaded() const;
39
40 void setFileName(const QString &fileName);
41 QString fileName() const;
42
43 QString errorString() const;
44
45 void setLoadHints(QLibrary::LoadHints loadHints);
46 QLibrary::LoadHints loadHints() const;
47
48private:
49 QLibraryPrivate *d;
50 bool did_load;
51 Q_DISABLE_COPY(QPluginLoader)
52};
53
54#else
55
56class Q_CORE_EXPORT QPluginLoader
57{
58public:
59 static QObjectList staticInstances();
60 static QList<QStaticPlugin> staticPlugins();
61};
62
63#endif // QT_CONFIG(library)
64
65QT_END_NAMESPACE
66
67#endif // QPLUGINLOADER_H
\inmodule QtCore\reentrant
operator QPluginMetaData() const
Definition qplugin.h:186
QPluginParsedMetaData(QByteArrayView input)
Definition qplugin_p.h:110
QCborValue value(QtPluginMetaDataKeys k) const
Definition qplugin_p.h:123
bool parse(QByteArrayView input)
QCborMap toCbor() const
Definition qplugin_p.h:122
bool parse(QPluginMetaData metaData)
Definition qplugin_p.h:116
bool isError() const
Definition qplugin_p.h:112
QJsonObject toJson() const
QString errorString() const
Definition qplugin_p.h:113
Combined button and popup list for selecting options.
Q_DECLARE_TYPEINFO(QByteArrayView, Q_PRIMITIVE_TYPE)
QT_REQUIRE_CONFIG(cborstreamreader)
Q_TRACE_POINT(qtcore, QFactoryLoader_update, const QString &fileName)
static bool isIidMatch(QByteArrayView raw, QLatin1StringView iid)
static IterationResult iterateInPluginMetaData(QByteArrayView raw, F &&f)
PluginInterface * qLoadPlugin(const QFactoryLoader *loader, const QString &key, Args &&...args)
#define Q_PLUGIN_INSTANCE(IMPLEMENTATION)
Definition qplugin.h:212
#define QT_MOC_EXPORT_PLUGIN_COMMON(PLUGINCLASS, MANGLEDNAME)
Definition qplugin.h:240
QT_BEGIN_NAMESPACE constexpr unsigned char qPluginArchRequirements()
Definition qplugin.h:21
#define Q_EXPORT_PLUGIN2(PLUGIN, PLUGINCLASS)
Definition qplugin.h:259
#define QT_PLUGIN_RESOURCE_INIT
Definition qplugin.h:209
#define QT_PLUGIN_METADATAV2_SECTION
Definition qplugin.h:179
QObject *(* QtPluginInstanceFunction)()
Definition qplugin.h:36
#define QT_PLUGIN_METADATA_SECTION
Definition qplugin.h:139
QtPluginMetaDataKeys
Definition qplugin_p.h:26
#define QT_PLUGIN_FOREACH_METADATA(F)
Definition qplugin_p.h:38
char name[sizeof(NoteName)]
Definition qplugin.h:92
constexpr ElfNoteHeader(quint32 payloadSize)
Definition qplugin.h:97
static constexpr quint32 NoteType
Definition qplugin.h:85
static constexpr char NoteName[]
Definition qplugin.h:86
quint8 plugin_arch_requirements
Definition qplugin.h:73
char magic[sizeof(QPluginMetaData::MagicString)]
Definition qplugin.h:78
static constexpr void copy(OO(&out)[OSize], II(&in)[ISize])
Definition qplugin.h:45
const void * data
Definition qplugin.h:103
static constexpr quint8 CurrentMetaDataVersion
Definition qplugin.h:39
static constexpr quint8 archRequirements()
Definition qplugin.h:51
static constexpr char MagicString[]
Definition qplugin.h:40
\inmodule QtCore
Definition qplugin.h:110