PythonPlugin Class Reference

#include <PythonPluginManager.h>

Public Member Functions
QString	comment () const
const QString &	errorReason () const
bool	isBroken () const
bool	isEnabled () const
bool	isUnstable () const
bool	isValid () const
QString	manual () const
QString	moduleFilePathPart () const
QString	moduleName () const
QString	name () const
QVariant	property (const QString &name) const

Private Member Functions
	PythonPlugin ()

Private Attributes
bool	m_broken {false}
QString	m_comment
bool	m_enabled {false}
QString	m_errorReason
bool	m_loaded {false}
QString	m_manual
QString	m_moduleName
QString	m_name
QMap< QString, QVariant >	m_properties
bool	m_unstable {false}

Friends
class	PythonPluginManager

Detailed Description

Represents a Python described in the plugin's .desktop file.

Definition at line 22 of file PythonPluginManager.h.

Constructor & Destructor Documentation

PythonPlugin()

PythonPlugin::PythonPlugin ( )

inlineprivate

Definition at line 80 of file PythonPluginManager.h.

                   {
        m_properties["X-Python-Dependencies"] = QStringList();
    }

References m_properties.

Member Function Documentation

comment()

QString PythonPlugin::comment ( ) const

inline

Definition at line 67 of file PythonPluginManager.h.

    {
        return m_comment;
    }

References m_comment.

errorReason()

const QString & PythonPlugin::errorReason ( ) const

inline

Definition at line 32 of file PythonPluginManager.h.

    {
        return m_errorReason;
    }

References m_errorReason.

isBroken()

bool PythonPlugin::isBroken ( ) const

inline

Definition at line 42 of file PythonPluginManager.h.

    {
        return m_broken;
    }

References m_broken.

isEnabled()

bool PythonPlugin::isEnabled ( ) const

inline

Definition at line 37 of file PythonPluginManager.h.

    {
        return m_enabled;
    }

References m_enabled.

isUnstable()

bool PythonPlugin::isUnstable ( ) const

inline

Definition at line 47 of file PythonPluginManager.h.

    {
        return m_unstable;
    }

References m_unstable.

isValid()

bool PythonPlugin::isValid

(

)

const

Definition at line 47 of file PythonPluginManager.cpp.

{
    dbgScript << "Got Krita/PythonPlugin: " << name()
              << ", module-path=" << moduleName()
                ;
    // Make sure mandatory properties are here
    if (m_name.isEmpty()) {
        dbgScript << "Ignore desktop file w/o a name";
        return false;
    }
    if (m_moduleName.isEmpty()) {
        dbgScript << "Ignore desktop file w/o a module to import";
        return false;
    }
 
    return true;
}

References dbgScript, m_moduleName, m_name, moduleName(), and name().

manual()

QString PythonPlugin::manual ( ) const

inline

Definition at line 72 of file PythonPluginManager.h.

    {
        return m_manual;
    }

References m_manual.

moduleFilePathPart()

QString PythonPlugin::moduleFilePathPart

(

)

const

Transforms the Python module name into a file path part

Definition at line 41 of file PythonPluginManager.cpp.

{
    QString filePath = m_moduleName;
    return filePath.replace(".", "/");
}

References m_moduleName.

moduleName()

QString PythonPlugin::moduleName ( ) const

inline

Definition at line 57 of file PythonPluginManager.h.

    {
        return m_moduleName;
    }

References m_moduleName.

name()

QString PythonPlugin::name ( ) const

inline

Definition at line 52 of file PythonPluginManager.h.

    {
        return m_name;
    }

References m_name.

property()

QVariant PythonPlugin::property ( const QString & name ) const

inline

Definition at line 62 of file PythonPluginManager.h.

    {
        return m_properties.value(name, "");
    }

References m_properties, and name().

Friends And Related Symbol Documentation

PythonPluginManager

friend class PythonPluginManager

friend

Definition at line 78 of file PythonPluginManager.h.

Member Data Documentation

m_broken

bool PythonPlugin::m_broken {false}

private

Definition at line 86 of file PythonPluginManager.h.

{false};

m_comment

QString PythonPlugin::m_comment

private

Definition at line 92 of file PythonPluginManager.h.

m_enabled

bool PythonPlugin::m_enabled {false}

private

Definition at line 85 of file PythonPluginManager.h.

{false};

m_errorReason

QString PythonPlugin::m_errorReason

private

Definition at line 84 of file PythonPluginManager.h.

m_loaded

bool PythonPlugin::m_loaded {false}

private

Definition at line 88 of file PythonPluginManager.h.

{false};

m_manual

QString PythonPlugin::m_manual

private

Definition at line 93 of file PythonPluginManager.h.

m_moduleName

QString PythonPlugin::m_moduleName

private

Definition at line 91 of file PythonPluginManager.h.

m_name

QString PythonPlugin::m_name

private

Definition at line 90 of file PythonPluginManager.h.

m_properties

QMap<QString, QVariant> PythonPlugin::m_properties

private

Definition at line 95 of file PythonPluginManager.h.

m_unstable

bool PythonPlugin::m_unstable {false}

private

Definition at line 87 of file PythonPluginManager.h.

{false};

---

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

• plugins/extensions/pykrita/plugin/PythonPluginManager.h
• plugins/extensions/pykrita/plugin/PythonPluginManager.cpp