QGIS API Documentation  3.6.0-Noosa (5873452)
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingOutputFolder Class Reference

A folder output for processing algorithms. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputFolder:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingOutputFolder (const QString &name, const QString &description=QString())
 Constructor for QgsProcessingOutputFolder. More...
 
QString type () const override
 Unique output type name. More...
 
- Public Member Functions inherited from QgsProcessingOutputDefinition
 QgsProcessingOutputDefinition (const QString &name, const QString &description=QString())
 Constructor for QgsProcessingOutputDefinition. More...
 
virtual ~QgsProcessingOutputDefinition ()=default
 
QString description () const
 Returns the description for the output. More...
 
QString name () const
 Returns the name of the output. More...
 
void setDescription (const QString &description)
 Sets the description for the output. More...
 
void setName (const QString &name)
 Sets the name of the output. More...
 

Static Public Member Functions

static QString typeName ()
 Returns the type name for the output class. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsProcessingOutputDefinition
QString mDescription
 Output description. More...
 
QString mName
 Output name. More...
 

Detailed Description

A folder output for processing algorithms.

Since
QGIS 3.0

Definition at line 318 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputFolder()

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

Constructor for QgsProcessingOutputFolder.

Definition at line 58 of file qgsprocessingoutputs.cpp.

Member Function Documentation

◆ type()

QString QgsProcessingOutputFolder::type ( ) const
inlineoverridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 332 of file qgsprocessingoutputs.h.

◆ typeName()

static QString QgsProcessingOutputFolder::typeName ( )
inlinestatic

Returns the type name for the output class.

Definition at line 331 of file qgsprocessingoutputs.h.


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