QGIS API Documentation 3.41.0-Master (25ec5511245)
|
A string output for processing algorithms. More...
#include <qgsprocessingoutputs.h>
Public Member Functions | |
QgsProcessingOutputString (const QString &name, const QString &description=QString()) | |
Constructor for QgsProcessingOutputString. | |
QString | type () const override |
Unique output type name. | |
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 | valueAsFormattedString (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
Returns a HTML string version of the parameter output value (if possible). | |
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. | |
A string output for processing algorithms.
Definition at line 392 of file qgsprocessingoutputs.h.
QgsProcessingOutputString::QgsProcessingOutputString | ( | const QString & | name, |
const QString & | description = QString() |
||
) |
Constructor for QgsProcessingOutputString.
Definition at line 115 of file qgsprocessingoutputs.cpp.
|
inlineoverridevirtual |
Unique output type name.
Implements QgsProcessingOutputDefinition.
Definition at line 405 of file qgsprocessingoutputs.h.
|
inlinestatic |
Returns the type name for the output class.
Definition at line 404 of file qgsprocessingoutputs.h.