PythonPluginsModel Class Reference

#include <PythonPluginsModel.h>

Inheritance diagram for PythonPluginsModel:

Public Member Functions
PythonPlugin *	plugin (const QModelIndex &) const
	PythonPluginsModel (QObject *parent, PythonPluginManager *pluginManager)

Protected Types
enum	Column { COl_NAME , COL_COMMENT , COLUMN_COUNT }

Protected Member Functions
int	columnCount (const QModelIndex &) const override
QVariant	data (const QModelIndex &, int) const override
Qt::ItemFlags	flags (const QModelIndex &) const override
QVariant	headerData (int, Qt::Orientation, int) const override
QModelIndex	index (int row, int column, const QModelIndex &parent) const override
int	rowCount (const QModelIndex &) const override
bool	setData (const QModelIndex &, const QVariant &, int) override

Private Attributes
PythonPluginManager *	m_pluginManager

Detailed Description

Definition at line 19 of file PythonPluginsModel.h.

Member Enumeration Documentation

Column

enum PythonPluginsModel::Column

protected

Enumerator
COl_NAME
COL_COMMENT
COLUMN_COUNT

Definition at line 26 of file PythonPluginsModel.h.

{COl_NAME, COL_COMMENT, COLUMN_COUNT};

Constructor & Destructor Documentation

PythonPluginsModel()

PythonPluginsModel::PythonPluginsModel	(	QObject *	parent,
		PythonPluginManager *	pluginManager )

Definition at line 18 of file PythonPluginsModel.cpp.

    : QAbstractTableModel(parent)
    , m_pluginManager(pluginManager)
{
}

Member Function Documentation

columnCount()

int PythonPluginsModel::columnCount ( const QModelIndex & ) const

overrideprotected

Definition at line 24 of file PythonPluginsModel.cpp.

{
    return COLUMN_COUNT;
}

References COLUMN_COUNT.

data()

QVariant PythonPluginsModel::data ( const QModelIndex & index, int role ) const

overrideprotected

Definition at line 61 of file PythonPluginsModel.cpp.

{
    if (index.isValid()) {
        PythonPlugin *plugin = static_cast<PythonPlugin*>(index.internalPointer());
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(plugin, QVariant());
 
        switch (role) {
            case Qt::DisplayRole:
                switch (index.column()) {
                    case COl_NAME:
                        return plugin->name();
                    case COL_COMMENT:
                        return plugin->comment();
                    default:
                        break;
                }
                break;
            case Qt::CheckStateRole:
                if (index.column() == COl_NAME) {
                    const bool checked = plugin->isEnabled();
                    return checked ? Qt::Checked : Qt::Unchecked;
                }
                break;
            case Qt::ToolTipRole:
                {
                    auto error = plugin->errorReason();
                    if (!error.isEmpty()) {
                        return error;
                    }
                }
                break;
            case Qt::ForegroundRole:
                if (plugin->isUnstable()) {
                    KColorScheme scheme(QPalette::Inactive, KColorScheme::View);
                    return scheme.foreground(KColorScheme::NegativeText).color();
                }
                break;
            default:
                break;
        }
    }
 
    return QVariant();
}

References COL_COMMENT, COl_NAME, PythonPlugin::comment(), PythonPlugin::errorReason(), KColorScheme::foreground(), index(), PythonPlugin::isEnabled(), PythonPlugin::isUnstable(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, PythonPlugin::name(), KColorScheme::NegativeText, plugin(), and KColorScheme::View.

flags()

Qt::ItemFlags PythonPluginsModel::flags ( const QModelIndex & index ) const

overrideprotected

Definition at line 106 of file PythonPluginsModel.cpp.

{
    PythonPlugin *plugin = static_cast<PythonPlugin*>(index.internalPointer());
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(plugin, Qt::ItemIsSelectable);
 
    int result = Qt::ItemIsSelectable;
    if (index.column() == COl_NAME) {
        result |= Qt::ItemIsUserCheckable;
    }
 
    // Disable UI for broken modules
    if (!plugin->isBroken()) {
        result |= Qt::ItemIsEnabled;
    }
 
    return static_cast<Qt::ItemFlag>(result);
}

References COl_NAME, index(), PythonPlugin::isBroken(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and plugin().

headerData()

QVariant PythonPluginsModel::headerData ( int section, Qt::Orientation orientation, int role ) const

overrideprotected

Definition at line 46 of file PythonPluginsModel.cpp.

{
    if (role == Qt::DisplayRole && orientation == Qt::Horizontal) {
        switch (section) {
            case COl_NAME:
                return i18nc("@title:column", "Name");
            case COL_COMMENT:
                return i18nc("@title:column", "Comment");
            default:
                break;
        }
    }
    return QVariant();
}

References COL_COMMENT, and COl_NAME.

index()

QModelIndex PythonPluginsModel::index ( int row, int column, const QModelIndex & parent ) const

overrideprotected

Definition at line 34 of file PythonPluginsModel.cpp.

{
    if (!parent.isValid() && column < COLUMN_COUNT) {
        auto *plugin = m_pluginManager->plugin(row);
        if (plugin) {
            return createIndex(row, column, plugin);
        }
    }
 
    return QModelIndex();
}

References COLUMN_COUNT, m_pluginManager, plugin(), and PythonPluginManager::plugin().

plugin()

PythonPlugin * PythonPluginsModel::plugin

(

const QModelIndex &

index

)

const

Definition at line 138 of file PythonPluginsModel.cpp.

{
    if (index.isValid()) {
        PythonPlugin * plugin = static_cast<PythonPlugin*>(index.internalPointer());
        return plugin;
    }
    return 0;
}

References index(), and plugin().

rowCount()

int PythonPluginsModel::rowCount ( const QModelIndex & ) const

overrideprotected

Definition at line 29 of file PythonPluginsModel.cpp.

{
    return m_pluginManager->plugins().size();
}

References m_pluginManager, and PythonPluginManager::plugins().

setData()

bool PythonPluginsModel::setData ( const QModelIndex & index, const QVariant & value, int role )

overrideprotected

Definition at line 124 of file PythonPluginsModel.cpp.

{
    PythonPlugin *plugin = static_cast<PythonPlugin*>(index.internalPointer());
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(plugin, false);
 
    if (role == Qt::CheckStateRole) {
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(!plugin->isBroken(), false);
 
        const bool enabled = value.toBool();
        m_pluginManager->setPluginEnabled(*plugin, enabled);
    }
    return true;
}

References index(), PythonPlugin::isBroken(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_pluginManager, plugin(), PythonPluginManager::setPluginEnabled(), and value().

Member Data Documentation

m_pluginManager

PythonPluginManager* PythonPluginsModel::m_pluginManager

private

Definition at line 38 of file PythonPluginsModel.h.

---

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

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