Class ProcessingAlgorithmsModelBase

ClassList > ProcessingAlgorithmsModelBase

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

• #include <processingalgorithmsmodel.h>

Inherits the following classes: QAbstractListModel

Public Types

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

Public Functions

Type	Name
	ProcessingAlgorithmsModelBase (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 ProcessingAlgorithmsModelBase::Role {
    AlgorithmIdRole = Qt::UserRole,
    AlgorithmGroupRole,
    AlgorithmNameRole,
    AlgorithmSvgIconRole,
    AlgorithmFlagsRole,
    AlgorithmFavoriteRole
};

---

Public Functions Documentation

function ProcessingAlgorithmsModelBase

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

---

function algorithmForIndex

Returns the processing algorithm for the given index.

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

---

function data

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

---

function rebuild

Rebuilds the algorithms model.

Q_INVOKABLE void ProcessingAlgorithmsModelBase::rebuild () 

---

function roleNames

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

---

function rowCount

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

---

function setData

bool ProcessingAlgorithmsModelBase::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/processingalgorithmsmodel.h