A folder output for processing algorithms. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputFolder:

Public Member Functions
	QgsProcessingOutputFolder (const QString &name, const QString &description=QString())
	Constructor for QgsProcessingOutputFolder.

QString	type () const override
	Unique output type name.

QString	valueAsFormattedString (const QVariant &value, QgsProcessingContext &context, bool &ok) const override
	Returns a HTML string version of the parameter output value (if possible).

Public Member Functions inherited from QgsProcessingOutputDefinition
	QgsProcessingOutputDefinition (const QString &name, const QString &description=QString())
	Constructor for QgsProcessingOutputDefinition.

virtual	~QgsProcessingOutputDefinition ()=default

bool	autoCreated () const
	Returns `true` if the output was automatically created when adding a parameter.

QString	description () const
	Returns the description for the output.

QString	name () const
	Returns the name of the output.

void	setAutoCreated (bool autoCreated)
	Sets whether an output was automatically created when adding a parameter.

void	setDescription (const QString &description)
	Sets the description for the output.

void	setName (const QString &name)
	Sets the name of the output.

virtual QString	valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const
	Returns a string version of the parameter output value (if possible).

Static Public Member Functions
static QString	typeName ()
	Returns the type name for the output class.

Additional Inherited Members
Protected Attributes inherited from QgsProcessingOutputDefinition
bool	mAutoCreated = false

QString	mDescription
	Output description.

QString	mName
	Output name.

Detailed Description

A folder output for processing algorithms.

Definition at line 436 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputFolder()

QgsProcessingOutputFolder::QgsProcessingOutputFolder	(	const QString &	name,
		const QString &	description = `QString()`
	)

Constructor for QgsProcessingOutputFolder.

Definition at line 134 of file qgsprocessingoutputs.cpp.

Member Function Documentation

◆ type()

QString QgsProcessingOutputFolder::type ( ) const

inlineoverridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 450 of file qgsprocessingoutputs.h.

◆ typeName()

static QString QgsProcessingOutputFolder::typeName ( )

inlinestatic

Returns the type name for the output class.

Definition at line 449 of file qgsprocessingoutputs.h.

◆ valueAsFormattedString()

QString QgsProcessingOutputFolder::valueAsFormattedString	(	const QVariant &	value,
		QgsProcessingContext &	context,
		bool &	ok
	)		const

overridevirtual

Returns a HTML string version of the parameter output value (if possible).

By default this will return the same value as valueAsString().

Parameters

value	value to convert
context	processing context
ok	will be set to `true` if value could be represented as a string.

Returns: value converted to string

See also: valueAsString()

Since: QGIS 3.36

Reimplemented from QgsProcessingOutputDefinition.

Definition at line 138 of file qgsprocessingoutputs.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/processing/qgsprocessingoutputs.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/processing/qgsprocessingoutputs.cpp

Public Member Functions

Static Public Member Functions