qxpluginspec.h

浏览该文件的文档.

 
#ifndef QXPLUGINSPEC_H
#define QXPLUGINSPEC_H
 
#include "qxplugin_global.h"
 
#include <QtCore/QJsonObject>
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QVersionNumber>
 
QX_PLUGIN_BEGIN_NAMESPACE
 
class QxPluginSpecPrivate;
 
class QxPlugin;
 
class QxPluginManagerPrivate;
 
enum class QxPluginState {
    Invalid,
    Read,
    Resolved,
    Loaded,
    Initialized,
    Stopped,
    Disabled
};
 
class QX_PLUGIN_EXPORT QxPluginSpec
{
public:
    QxPluginSpec();
    ~QxPluginSpec();
 
    // Identity --------------------------------------------------------------
    QString id() const;
    QVersionNumber version() const;
    QVersionNumber compatVersion() const;
    QString vendor() const;
    QString copyright() const;
    QString category() const;
    QString description() const;
    QString url() const;
 
    // Dependencies ----------------------------------------------------------
    QStringList dependencies() const;
    QStringList optionalDependencies() const;
 
    // Enabling --------------------------------------------------------------
    bool isEnabledByDefault() const;
    bool isDisabled() const;
 
    // Runtime ----------------------------------------------------------------
    QxPluginState state() const;
    QxPlugin *plugin() const;
    QString filePath() const;
    QString error() const;
 
    // Construction (manager only) ------------------------------------------
    bool read(const QString &filePath, const QJsonObject &metaData);
private:
    friend class QxPluginManager;
    friend class QxPluginManagerPrivate;
    QX_DECLARE_PRIVATE(QxPluginSpec)
 
    
    void setState(QxPluginState state);
    void setError(const QString &error);
    void setPlugin(QxPlugin *plugin);
};
 
QX_PLUGIN_END_NAMESPACE
 
#endif   // QXPLUGINSPEC_H