QgsSelectiveMaskSource Class Reference

Encapsulates a single source for selective masking (e.g. More...

#include <qgsselectivemaskingsource.h>

Public Member Functions
	QgsSelectiveMaskSource ()=default
	Constructor for an invalid QgsSelectiveMaskSource.
	QgsSelectiveMaskSource (const QString &layerId, Qgis::SelectiveMaskSourceType sourceType, const QString &sourceId=QString())
	Constructor for QgsSelectiveMaskSource.
bool	isValid () const
	Returns true if the source is valid (i.e.
QString	layerId () const
	Returns the source layer id.
bool	operator!= (const QgsSelectiveMaskSource &other) const =default
bool	operator== (const QgsSelectiveMaskSource &other) const =default
void	setLayerId (const QString &id)
	Sets the source layer id.
void	setSourceId (const QString &id)
	Sets the symbol layer or label rule id.
void	setSourceType (Qgis::SelectiveMaskSourceType type)
	Sets the source type.
QString	sourceId () const
	Returns the symbol layer or label rule ID.
Qgis::SelectiveMaskSourceType	sourceType () const
	Returns the type of masking source.

Detailed Description

Encapsulates a single source for selective masking (e.g.

a symbol layer or label rule).

Since

QGIS 4.0

Definition at line 35 of file qgsselectivemaskingsource.h.

Constructor & Destructor Documentation

QgsSelectiveMaskSource() [1/2]

QgsSelectiveMaskSource::QgsSelectiveMaskSource ( )

default

Constructor for an invalid QgsSelectiveMaskSource.

QgsSelectiveMaskSource() [2/2]

QgsSelectiveMaskSource::QgsSelectiveMaskSource	(	const QString &	layerId,
		Qgis::SelectiveMaskSourceType	sourceType,
		const QString &	sourceId = QString() )

Constructor for QgsSelectiveMaskSource.

Parameters

layerId	source layer ID
sourceType	masking source type
sourceId	optional ID for the symbol layer or label rule

Definition at line 18 of file qgsselectivemaskingsource.cpp.

Member Function Documentation

isValid()

bool QgsSelectiveMaskSource::isValid ( ) const

inline

Returns true if the source is valid (i.e.

has a non-empty layer ID).

Definition at line 56 of file qgsselectivemaskingsource.h.

layerId()

QString QgsSelectiveMaskSource::layerId ( ) const

inline

Returns the source layer id.

See also

setLayerId()

Definition at line 63 of file qgsselectivemaskingsource.h.

operator!=()

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

default

operator==()

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

default

setLayerId()

void QgsSelectiveMaskSource::setLayerId ( const QString & id )

inline

Sets the source layer id.

See also

layerId()

Definition at line 70 of file qgsselectivemaskingsource.h.

setSourceId()

void QgsSelectiveMaskSource::setSourceId ( const QString & id )

inline

Sets the symbol layer or label rule id.

See also

sourceId()

Definition at line 98 of file qgsselectivemaskingsource.h.

setSourceType()

void QgsSelectiveMaskSource::setSourceType ( Qgis::SelectiveMaskSourceType type )

inline

Sets the source type.

See also

sourceType()

Definition at line 84 of file qgsselectivemaskingsource.h.

sourceId()

QString QgsSelectiveMaskSource::sourceId ( ) const

inline

Returns the symbol layer or label rule ID.

See also

setSourceId()

Definition at line 91 of file qgsselectivemaskingsource.h.

sourceType()

Qgis::SelectiveMaskSourceType QgsSelectiveMaskSource::sourceType ( ) const

inline

Returns the type of masking source.

See also

setSourceType()

Definition at line 77 of file qgsselectivemaskingsource.h.

---

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

• /build/qgis-3.99.0+git20260202+e9821da5c6b+99sid/src/core/symbology/qgsselectivemaskingsource.h
• /build/qgis-3.99.0+git20260202+e9821da5c6b+99sid/src/core/symbology/qgsselectivemaskingsource.cpp