QgsSelectiveMaskingSourceSet Class Reference

Represents a named set of selective masking sources (QgsSelectiveMaskSource). More...

#include <qgsselectivemaskingsourceset.h>

Public Member Functions
	QgsSelectiveMaskingSourceSet ()
	Constructor for an empty (invalid) QgsSelectiveMaskingSourceSet.
void	append (const QgsSelectiveMaskSource &source)
	Appends a source to the set.
QString	id () const
	Returns a unique identifier for the set.
bool	isEmpty () const
	Returns true if the set is empty.
bool	isValid () const
	Returns true if the source set is valid, or false if it is invalid (default constructed).
QString	name () const
	Returns the set's unique name.
QgsSelectiveMaskSource &	operator[] (int index)
	Returns the mask source at the specified index.
bool	readXml (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context)
	Sets the set's state from a DOM element.
void	setId (const QString &id)
	Sets the unique identifier for the set.
void	setName (const QString &name)
	Sets the set's unique name.
void	setSources (const QVector< QgsSelectiveMaskSource > &sources)
	Sets the list of selective mask sources for this set.
int	size () const
	Returns the number of sources in the set.
QVector< QgsSelectiveMaskSource >	sources () const
	Returns the list of selective mask sources configured in this set.
QDomElement	writeXml (QDomDocument &document, const QgsReadWriteContext &context) const
	Writes the set's state to a DOM element.

Detailed Description

Represents a named set of selective masking sources (QgsSelectiveMaskSource).

Since

QGIS 4.0

Definition at line 39 of file qgsselectivemaskingsourceset.h.

Constructor & Destructor Documentation

QgsSelectiveMaskingSourceSet()

QgsSelectiveMaskingSourceSet::QgsSelectiveMaskingSourceSet

(

)

Constructor for an empty (invalid) QgsSelectiveMaskingSourceSet.

Definition at line 28 of file qgsselectivemaskingsourceset.cpp.

Member Function Documentation

append()

void QgsSelectiveMaskingSourceSet::append

(

const QgsSelectiveMaskSource &

source

)

Appends a source to the set.

Definition at line 45 of file qgsselectivemaskingsourceset.cpp.

id()

QString QgsSelectiveMaskingSourceSet::id ( ) const

inline

Returns a unique identifier for the set.

This id must be unique in the whole project. It is automatically generated when a new QgsSelectiveMaskingSourceSet is constructed.

See also

setId()

Definition at line 71 of file qgsselectivemaskingsourceset.h.

isEmpty()

bool QgsSelectiveMaskingSourceSet::isEmpty

(

)

const

Returns true if the set is empty.

Definition at line 104 of file qgsselectivemaskingsourceset.cpp.

isValid()

bool QgsSelectiveMaskingSourceSet::isValid ( ) const

inline

Returns true if the source set is valid, or false if it is invalid (default constructed).

Definition at line 51 of file qgsselectivemaskingsourceset.h.

name()

QString QgsSelectiveMaskingSourceSet::name ( ) const

inline

Returns the set's unique name.

See also

setName()

Definition at line 78 of file qgsselectivemaskingsourceset.h.

operator[]()

QgsSelectiveMaskSource & QgsSelectiveMaskingSourceSet::operator[]

(

int

index

)

Returns the mask source at the specified index.

Definition at line 94 of file qgsselectivemaskingsourceset.cpp.

readXml()

bool QgsSelectiveMaskingSourceSet::readXml	(	const QDomElement &	element,
		const QDomDocument &	document,
		const QgsReadWriteContext &	context )

Sets the set's state from a DOM element.

See also

writeXml()

Definition at line 68 of file qgsselectivemaskingsourceset.cpp.

setId()

void QgsSelectiveMaskingSourceSet::setId ( const QString & id )

inline

Sets the unique identifier for the set.

This id must be unique in the whole project. A default random one is automatically generated when a new QgsSelectiveMaskingSourceSet is constructed.

See also

id()

Definition at line 61 of file qgsselectivemaskingsourceset.h.

setName()

void QgsSelectiveMaskingSourceSet::setName ( const QString & name )

inline

Sets the set's unique name.

See also

name()

Definition at line 85 of file qgsselectivemaskingsourceset.h.

setSources()

void QgsSelectiveMaskingSourceSet::setSources

(

const QVector< QgsSelectiveMaskSource > &

sources

)

Sets the list of selective mask sources for this set.

See also

sources()

Definition at line 39 of file qgsselectivemaskingsourceset.cpp.

size()

int QgsSelectiveMaskingSourceSet::size

(

)

const

Returns the number of sources in the set.

Definition at line 99 of file qgsselectivemaskingsourceset.cpp.

sources()

QVector< QgsSelectiveMaskSource > QgsSelectiveMaskingSourceSet::sources

(

)

const

Returns the list of selective mask sources configured in this set.

See also

setSources()

Definition at line 34 of file qgsselectivemaskingsourceset.cpp.

writeXml()

QDomElement QgsSelectiveMaskingSourceSet::writeXml	(	QDomDocument &	document,
		const QgsReadWriteContext &	context ) const

Writes the set's state to a DOM element.

See also

readXml()

Definition at line 50 of file qgsselectivemaskingsourceset.cpp.

---

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

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