omni::PluginInfo Class Reference

Holds meta information about a plugins Only plugin loader can construct a plugin info. More...

#include <PluginInfo.h>

Public Member Functions
QString const &	name () const
	Return name of plugin. More...
QString const &	type () const
	Return type of plugin (e.g. input, mapping or canvas) More...
QString const &	author () const
	Return author of plugin. More...
QString const &	url () const
	Return url of plugin. More...
QString const &	description () const
	Return description of plugin. More...
QString	versionString () const
	Return version string (MAJOR.MINOR.REV.BUILD) of plugin. More...
int	majorVersion () const
	Return major version. More...
int	minorVersion () const
	Return minor version. More...
int	revision () const
	Return revision number. More...
int	build () const
	Return build number. More...
QString const &	className () const
	Return class name from meta object. More...
QString const &	file () const
	Return file name of plugin. More...
QObject const *	handle () const
	Return handle (pointer to underlying QObject) More...

Static Private Member Functions
static PluginInfo	make (QString const &_file, QObject const *)
	Make a PluginInfo from file and QObject. More...

Private Attributes
QString	name_
QString	type_
QString	author_
QString	url_
QString	description_
QString	className_
int	majorVersion_ = 0
int	minorVersion_ = 0
int	revision_ = 0
int	build_ = 0
QString	file_

Friends
class	PluginLoader
	Only plugin loader can construct a plugin info. More...

Detailed Description

Holds meta information about a plugins Only plugin loader can construct a plugin info.

Member Function Documentation

QString const & omni::PluginInfo::author

(

)

const

Return author of plugin.

                                            {
        return author_;
    }

int omni::PluginInfo::build

(

)

const

Return build number.

                                {
        return build_;
    }

QString const & omni::PluginInfo::className

(

)

const

Return class name from meta object.

                                               {
        return className_;
    }

QString const & omni::PluginInfo::description

(

)

const

Return description of plugin.

                                                 {
        return description_;
    }

QString const & omni::PluginInfo::file

(

)

const

Return file name of plugin.

                                          {
        return file_;
    }

QObject const* omni::PluginInfo::handle

(

)

const

Return handle (pointer to underlying QObject)

int omni::PluginInfo::majorVersion

(

)

const

Return major version.

                                       {
        return majorVersion_;
    }

PluginInfo omni::PluginInfo::make ( QString const &  _file, QObject const *  _obj  )

staticprivate

Make a PluginInfo from file and QObject.

                                                                         {
        PluginInfo _info;
        _info.file_ = _file;
        _info.className_ = _obj->metaObject()->className();

        auto _getClassInfo = [&](QString const& _name) {
            auto const* _metaObject = _obj->metaObject();
            for (int i = 0; i < _metaObject->classInfoCount(); ++i) {
                auto _metaInfo = _metaObject->classInfo(i);
                if (QString(_metaInfo.name()) == _name) {
                    return QString(_metaInfo.value());
                }
            }
            return QString();
        };

        _info.name_ = _getClassInfo("name");
        if (_info.name_.isEmpty()) {
            QFileInfo fileInfo(_info.file_);
            _info.name_ = fileInfo.fileName();
        }

        _info.type_ = _getClassInfo("type");
        _info.author_ = _getClassInfo("author");
        _info.url_ = _getClassInfo("url");
        _info.description_ = _getClassInfo("description");
        QString _versionString = _getClassInfo("version");
        QStringList _tokens = _versionString.split( ".", QString::SkipEmptyParts);
        if (_tokens.size() >= 1) _info.majorVersion_ = _tokens[0].toInt();
        if (_tokens.size() >= 2) _info.minorVersion_ = _tokens[1].toInt();
        if (_tokens.size() >= 3) _info.revision_ = _tokens[2].toInt();
        if (_tokens.size() >= 4) _info.build_ = _tokens[3].toInt();
        return _info;
    }

int omni::PluginInfo::minorVersion

(

)

const

Return minor version.

                                       {
        return minorVersion_;
    }

QString const & omni::PluginInfo::name

(

)

const

Return name of plugin.

                                          {
        return name_;
    }

int omni::PluginInfo::revision

(

)

const

Return revision number.

                                   {
        return revision_;
    }

QString const & omni::PluginInfo::type

(

)

const

Return type of plugin (e.g. input, mapping or canvas)

                                          {
        return type_;
    }

QString const & omni::PluginInfo::url

(

)

const

Return url of plugin.

                                         {
        return url_;
    }

QString omni::PluginInfo::versionString

(

)

const

Return version string (MAJOR.MINOR.REV.BUILD) of plugin.

                                            {
        return QString("%1.%2.%3.%4")
            .arg(majorVersion())
            .arg(minorVersion())
            .arg(revision())
            .arg(build());
    }

Friends And Related Function Documentation

friend class PluginLoader

friend

Only plugin loader can construct a plugin info.

Field Documentation

QString omni::PluginInfo::author_

private

int omni::PluginInfo::build_ = 0

private

QString omni::PluginInfo::className_

private

QString omni::PluginInfo::description_

private

QString omni::PluginInfo::file_

private

int omni::PluginInfo::majorVersion_ = 0

private

int omni::PluginInfo::minorVersion_ = 0

private

QString omni::PluginInfo::name_

private

int omni::PluginInfo::revision_ = 0

private

QString omni::PluginInfo::type_

private

QString omni::PluginInfo::url_

private

---

The documentation for this class was generated from the following files:

• include/omni/PluginInfo.h
• src/lib/PluginInfo.cpp