Encapsulates settings relating to a feature source input to a processing algorithm. More...

Public Member Functions
	QgsProcessingFeatureSourceDefinition (const QString &source=QString(), bool selectedFeaturesOnly=false)
	Constructor for QgsProcessingFeatureSourceDefinition, accepting a static string source. More...

	QgsProcessingFeatureSourceDefinition (const QgsProperty &source, bool selectedFeaturesOnly=false)
	Constructor for QgsProcessingFeatureSourceDefinition, accepting a QgsProperty source. More...

	operator QVariant () const
	Allows direct construction of QVariants. More...

bool	operator!= (const QgsProcessingFeatureSourceDefinition &other)

bool	operator== (const QgsProcessingFeatureSourceDefinition &other)

Public Attributes
bool	selectedFeaturesOnly
	True if only selected features in the source should be used by algorithms. More...

QgsProperty	source
	Source definition. More...

Detailed Description

Encapsulates settings relating to a feature source input to a processing algorithm.

Definition at line 49 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

QgsProcessingFeatureSourceDefinition::QgsProcessingFeatureSourceDefinition	(	const QString &	source = `QString()`,
		bool	selectedFeaturesOnly = `false`
	)

inline

Constructor for QgsProcessingFeatureSourceDefinition, accepting a static string source.

Definition at line 56 of file qgsprocessingparameters.h.

QgsProcessingFeatureSourceDefinition::QgsProcessingFeatureSourceDefinition	(	const QgsProperty &	source,
		bool	selectedFeaturesOnly = `false`
	)

inline

Definition at line 64 of file qgsprocessingparameters.h.

QgsProcessingFeatureSourceDefinition::operator QVariant ( ) const

inline

Allows direct construction of QVariants.

Definition at line 90 of file qgsprocessingparameters.h.

bool QgsProcessingFeatureSourceDefinition::operator!= ( const QgsProcessingFeatureSourceDefinition & other )

inline

Definition at line 84 of file qgsprocessingparameters.h.

bool QgsProcessingFeatureSourceDefinition::operator== ( const QgsProcessingFeatureSourceDefinition & other )

inline

Definition at line 79 of file qgsprocessingparameters.h.

bool QgsProcessingFeatureSourceDefinition::selectedFeaturesOnly

True if only selected features in the source should be used by algorithms.

Definition at line 77 of file qgsprocessingparameters.h.

QgsProperty QgsProcessingFeatureSourceDefinition::source

Source definition.

Usually a static property set to a source layer's ID or file name.

Definition at line 72 of file qgsprocessingparameters.h.

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