Skip to content

Class QfProcessingAlgorithmsModelBase

ClassList > QfProcessingAlgorithmsModelBase

A model for providers and algorithms available within QField. More...

  • #include <qfprocessingalgorithmsmodel.h>

Inherits the following classes: QAbstractListModel

Public Types

Type Name
enum Role
Roles to get the data of the model.

Public Functions

Type Name
QfProcessingAlgorithmsModelBase (QObject * parent=nullptr)
const QgsProcessingAlgorithm * algorithmForIndex (const QModelIndex & index) const
Returns the processing algorithm for the given index.
QVariant data (const QModelIndex & index, int role) override const
Q_INVOKABLE void rebuild ()
Rebuilds the algorithms model.
QHash< int, QByteArray > roleNames () override const
int rowCount (const QModelIndex & parent) override const
bool setData (const QModelIndex & index, const QVariant & value, int role=Qt::EditRole) override

Detailed Description

See ProcessingAlgorithmsProxyModel for a sorted, filterable version of this model.

Public Types Documentation

enum Role

Roles to get the data of the model.

enum QfProcessingAlgorithmsModelBase::Role {
    AlgorithmIdRole = Qt::UserRole,
    AlgorithmGroupRole,
    AlgorithmNameRole,
    AlgorithmSvgIconRole,
    AlgorithmFlagsRole,
    AlgorithmFavoriteRole
};


Public Functions Documentation

function QfProcessingAlgorithmsModelBase

explicit QfProcessingAlgorithmsModelBase::QfProcessingAlgorithmsModelBase (
    QObject * parent=nullptr
) 

function algorithmForIndex

Returns the processing algorithm for the given index.

const QgsProcessingAlgorithm * QfProcessingAlgorithmsModelBase::algorithmForIndex (
    const QModelIndex & index
) const


function data

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

function rebuild

Rebuilds the algorithms model.

Q_INVOKABLE void QfProcessingAlgorithmsModelBase::rebuild () 


function roleNames

QHash< int, QByteArray > QfProcessingAlgorithmsModelBase::roleNames () override const

function rowCount

int QfProcessingAlgorithmsModelBase::rowCount (
    const QModelIndex & parent
) override const

function setData

bool QfProcessingAlgorithmsModelBase::setData (
    const QModelIndex & index,
    const QVariant & value,
    int role=Qt::EditRole
) override


The documentation for this class was generated from the following file src/core/processing/qfprocessingalgorithmsmodel.h