Class ProcessingAlgorithmParametersModelBase

ClassList > ProcessingAlgorithmParametersModelBase

A model for configuring processing algorithm parameters.

• #include <processingalgorithmparametersmodel.h>

Inherits the following classes: QAbstractListModel

Public Types

Type	Name
enum	Role Roles of the model.

Public Signals

Type	Name
signal void	algorithmIdChanged (const QString & id)
signal void	inPlaceLayerChanged
signal void	parametersChanged

Public Functions

Type	Name
	ProcessingAlgorithmParametersModelBase (QObject * parent=nullptr)
QString	algorithmDisplayName () const
QString	algorithmId () const
QString	algorithmShortHelp () const
QVariant	data (const QModelIndex & index, int role) override const
bool	hasAdvancedParameters () const
bool	hasParameters () const
QgsVectorLayer *	inPlaceLayer () const
bool	isValid () const
QVariantMap	parameters ()
QHash< int, QByteArray >	roleNames () override const
int	rowCount (const QModelIndex & parent) override const
void	setAlgorithmId (const QString & id)
bool	setData (const QModelIndex & index, const QVariant & value, int role=Qt::EditRole) override
void	setInPlaceLayer (QgsVectorLayer * layer)
void	setParameters (const QVariantMap & parameters)

Public Types Documentation

enum Role

Roles of the model.

enum ProcessingAlgorithmParametersModelBase::Role {
    ParameterTypeRole = Qt::UserRole,
    ParameterDescriptionRole,
    ParameterFlagsRole,
    ParameterDefaultValueRole,
    ParameterValueRole,
    ParameterConfigurationRole
};

---

Public Signals Documentation

signal algorithmIdChanged

void ProcessingAlgorithmParametersModelBase::algorithmIdChanged;

Emitted when the algorithm ID has changed.

---

signal inPlaceLayerChanged

void ProcessingAlgorithmParametersModelBase::inPlaceLayerChanged;

Emitted when the in place vector layer has changed

---

signal parametersChanged

void ProcessingAlgorithmParametersModelBase::parametersChanged;

Emitted when the parameters have changed.

---

Public Functions Documentation

function ProcessingAlgorithmParametersModelBase

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

---

function algorithmDisplayName

QString ProcessingAlgorithmParametersModelBase::algorithmDisplayName () const

Returns the display name of the algorithm.

---

function algorithmId

inline QString ProcessingAlgorithmParametersModelBase::algorithmId () const

Returns the current algorithm ID from which parameters are taken from.

---

function algorithmShortHelp

QString ProcessingAlgorithmParametersModelBase::algorithmShortHelp () const

Returns a short description of the algorithm.

---

function data

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

---

function hasAdvancedParameters

inline bool ProcessingAlgorithmParametersModelBase::hasAdvancedParameters () const

Returns whether the current model has advanced parameters.

---

function hasParameters

inline bool ProcessingAlgorithmParametersModelBase::hasParameters () const

Returns whether the current model has parameters.

---

function inPlaceLayer

inline QgsVectorLayer * ProcessingAlgorithmParametersModelBase::inPlaceLayer () const

Returns the vector layer for in-place algorithms for parameters to take details from.

---

function isValid

inline bool ProcessingAlgorithmParametersModelBase::isValid () const

Returns whether the current model refers to a valid algorithm.

---

function parameters

QVariantMap ProcessingAlgorithmParametersModelBase::parameters () 

Returns a variant map of parameter names and values.

---

function roleNames

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

---

function rowCount

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

---

function setAlgorithmId

void ProcessingAlgorithmParametersModelBase::setAlgorithmId (
    const QString & id
) 

Sets the current algorithm ID from which parameters are taken from.

---

function setData

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

---

function setInPlaceLayer

void ProcessingAlgorithmParametersModelBase::setInPlaceLayer (
    QgsVectorLayer * layer
) 

Sets the vector layer for in-place algorithm filter for parameters to take details from.

---

function setParameters

void ProcessingAlgorithmParametersModelBase::setParameters (
    const QVariantMap & parameters
) 

Sets the values of the parameters model from variant map of parameter names and values.

---

---

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