QgsSymbolBufferSettings Class Reference

Contains settings relating to symbol buffers, which draw a "halo" effect around the symbol. More...

#include <qgssymbol.h>

Public Member Functions
	QgsSymbolBufferSettings ()
	QgsSymbolBufferSettings (const QgsSymbolBufferSettings &other)
	~QgsSymbolBufferSettings ()
bool	enabled () const
	Returns whether the buffer is enabled.
QgsFillSymbol *	fillSymbol () const
	Returns the fill symbol used to render the buffer.
Qt::PenJoinStyle	joinStyle () const
	Returns the buffer join style.
QgsSymbolBufferSettings &	operator= (const QgsSymbolBufferSettings &)
void	readXml (const QDomElement &element, const QgsReadWriteContext &context)
	Reads the buffer settings from an XML element.
void	setEnabled (bool enabled)
	Sets whether the symbol buffer will be drawn.
void	setFillSymbol (QgsFillSymbol *symbol)
	Sets the fill symbol used to render the buffer.
void	setJoinStyle (Qt::PenJoinStyle style)
	Sets the join style used for drawing the buffer.
void	setSize (double size)
	Sets the size of the buffer.
void	setSizeMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale object for the buffer size.
void	setSizeUnit (Qgis::RenderUnit unit)
	Sets the unit used for the buffer size.
double	size () const
	Returns the size of the buffer.
QgsMapUnitScale	sizeMapUnitScale () const
	Returns the map unit scale object for the buffer size.
Qgis::RenderUnit	sizeUnit () const
	Returns the units for the buffer size.
void	writeXml (QDomElement &element, const QgsReadWriteContext &context) const
	Writes the buffer settings to an XML element.

Detailed Description

Contains settings relating to symbol buffers, which draw a "halo" effect around the symbol.

Since

QGIS 3.40

Definition at line 96 of file qgssymbol.h.

Constructor & Destructor Documentation

QgsSymbolBufferSettings() [1/2]

QgsSymbolBufferSettings::QgsSymbolBufferSettings

(

)

Definition at line 70 of file qgssymbol.cpp.

~QgsSymbolBufferSettings()

QgsSymbolBufferSettings::~QgsSymbolBufferSettings ( )

default

QgsSymbolBufferSettings() [2/2]

QgsSymbolBufferSettings::QgsSymbolBufferSettings

(

const QgsSymbolBufferSettings &

other

)

Definition at line 75 of file qgssymbol.cpp.

Member Function Documentation

enabled()

bool QgsSymbolBufferSettings::enabled ( ) const

inline

Returns whether the buffer is enabled.

See also

setEnabled()

Definition at line 110 of file qgssymbol.h.

fillSymbol()

QgsFillSymbol * QgsSymbolBufferSettings::fillSymbol

(

)

const

Returns the fill symbol used to render the buffer.

Ownership is not transferred.

See also

setFillSymbol()

Definition at line 97 of file qgssymbol.cpp.

joinStyle()

Qt::PenJoinStyle QgsSymbolBufferSettings::joinStyle ( ) const

inline

Returns the buffer join style.

See also

setJoinStyle

Definition at line 174 of file qgssymbol.h.

operator=()

QgsSymbolBufferSettings & QgsSymbolBufferSettings::operator=

(

const QgsSymbolBufferSettings &

other

)

Definition at line 86 of file qgssymbol.cpp.

readXml()

void QgsSymbolBufferSettings::readXml	(	const QDomElement &	element,
		const QgsReadWriteContext &	context
	)

Reads the buffer settings from an XML element.

See also

readXml()

Definition at line 128 of file qgssymbol.cpp.

setEnabled()

void QgsSymbolBufferSettings::setEnabled ( bool  enabled )

inline

Sets whether the symbol buffer will be drawn.

See also

enabled()

Definition at line 116 of file qgssymbol.h.

setFillSymbol()

void QgsSymbolBufferSettings::setFillSymbol

(

QgsFillSymbol *

symbol

)

Sets the fill symbol used to render the buffer.

Ownership of symbol is transferred to the buffer.

See also

fillSymbol()

Definition at line 102 of file qgssymbol.cpp.

setJoinStyle()

void QgsSymbolBufferSettings::setJoinStyle ( Qt::PenJoinStyle  style )

inline

Sets the join style used for drawing the buffer.

See also

joinStyle()

Definition at line 180 of file qgssymbol.h.

setSize()

void QgsSymbolBufferSettings::setSize ( double  size )

inline

Sets the size of the buffer.

The size units are specified using setSizeUnit().

See also

size()

setSizeUnit()

Definition at line 133 of file qgssymbol.h.

setSizeMapUnitScale()

void QgsSymbolBufferSettings::setSizeMapUnitScale ( const QgsMapUnitScale &  scale )

inline

Sets the map unit scale object for the buffer size.

This is only used if the buffer size is set to QgsUnitTypes::RenderMapUnit.

See also

sizeMapUnitScale()

setSizeUnit()

Definition at line 168 of file qgssymbol.h.

setSizeUnit()

void QgsSymbolBufferSettings::setSizeUnit ( Qgis::RenderUnit  unit )

inline

Sets the unit used for the buffer size.

See also

setSize()

sizeUnit()

Definition at line 149 of file qgssymbol.h.

size()

double QgsSymbolBufferSettings::size ( ) const

inline

Returns the size of the buffer.

See also

sizeUnit()

setSize()

Definition at line 123 of file qgssymbol.h.

sizeMapUnitScale()

QgsMapUnitScale QgsSymbolBufferSettings::sizeMapUnitScale ( ) const

inline

Returns the map unit scale object for the buffer size.

This is only used if the buffer size is set to QgsUnitTypes::RenderMapUnit.

See also

setSizeMapUnitScale()

sizeUnit()

Definition at line 158 of file qgssymbol.h.

sizeUnit()

Qgis::RenderUnit QgsSymbolBufferSettings::sizeUnit ( ) const

inline

Returns the units for the buffer size.

See also

size()

setSizeUnit()

Definition at line 141 of file qgssymbol.h.

writeXml()

void QgsSymbolBufferSettings::writeXml	(	QDomElement &	element,
		const QgsReadWriteContext &	context
	)		const

Writes the buffer settings to an XML element.

See also

readXml()

Definition at line 109 of file qgssymbol.cpp.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/symbology/qgssymbol.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/symbology/qgssymbol.cpp