Container for settings relating to a text shadow. More...

#include <qgstextshadowsettings.h>

Public Types
enum	ShadowPlacement { ShadowLowest = 0 , ShadowText , ShadowBuffer , ShadowShape }
	Placement positions for text shadow. More...

Public Member Functions
	QgsTextShadowSettings ()

	QgsTextShadowSettings (const QgsTextShadowSettings &other)
	Copy constructor. More...

	~QgsTextShadowSettings ()

QPainter::CompositionMode	blendMode () const
	Returns the blending mode used for drawing the drop shadow. More...

bool	blurAlphaOnly () const
	Returns whether only the alpha channel for the shadow will be blurred. More...

double	blurRadius () const
	Returns the blur radius for the shadow. More...

QgsMapUnitScale	blurRadiusMapUnitScale () const
	Returns the map unit scale object for the shadow blur radius. More...

QgsUnitTypes::RenderUnit	blurRadiusUnit () const
	Returns the units used for the shadow's blur radius. More...

QColor	color () const
	Returns the color of the drop shadow. More...

bool	enabled () const
	Returns whether the shadow is enabled. More...

int	offsetAngle () const
	Returns the angle for offsetting the position of the shadow from the text. More...

double	offsetDistance () const
	Returns the distance for offsetting the position of the shadow from the text. More...

bool	offsetGlobal () const
	Returns `true` if the global shadow offset will be used. More...

QgsMapUnitScale	offsetMapUnitScale () const
	Returns the map unit scale object for the shadow offset distance. More...

QgsUnitTypes::RenderUnit	offsetUnit () const
	Returns the units used for the shadow's offset. More...

double	opacity () const
	Returns the shadow's opacity. More...

bool	operator!= (const QgsTextShadowSettings &other) const

QgsTextShadowSettings &	operator= (const QgsTextShadowSettings &other)

bool	operator== (const QgsTextShadowSettings &other) const

void	readFromLayer (QgsVectorLayer *layer)
	Reads settings from a layer's custom properties (for QGIS 2.x projects). More...

void	readXml (const QDomElement &elem)
	Read settings from a DOM element. More...

QSet< QString >	referencedFields (const QgsRenderContext &context) const
	Returns all field names referenced by the configuration (e.g. More...

int	scale () const
	Returns the scaling used for the drop shadow (in percentage of original size). More...

void	setBlendMode (QPainter::CompositionMode mode)
	Sets the blending mode used for drawing the drop shadow. More...

void	setBlurAlphaOnly (bool alphaOnly)
	Sets whether only the alpha channel for the shadow should be blurred. More...

void	setBlurRadius (double blurRadius)
	Sets the blur radius for the shadow. More...

void	setBlurRadiusMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale object for the shadow blur radius. More...

void	setBlurRadiusUnit (QgsUnitTypes::RenderUnit units)
	Sets the units used for the shadow's blur radius. More...

void	setColor (const QColor &color)
	Sets the color for the drop shadow. More...

void	setEnabled (bool enabled)
	Sets whether the text shadow will be drawn. More...

void	setOffsetAngle (int angle)
	Sets the angle for offsetting the position of the shadow from the text. More...

void	setOffsetDistance (double distance)
	Sets the distance for offsetting the position of the shadow from the text. More...

void	setOffsetGlobal (bool global)
	Sets whether the global shadow offset should be used. More...

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale object for the shadow offset distance. More...

void	setOffsetUnit (QgsUnitTypes::RenderUnit units)
	Sets the units used for the shadow's offset. More...

void	setOpacity (double opacity)
	Sets the shadow's opacity. More...

void	setScale (int scale)
	Sets the scaling used for the drop shadow (in percentage of original size). More...

void	setShadowPlacement (QgsTextShadowSettings::ShadowPlacement placement)
	Sets the placement for the drop shadow. More...

QgsTextShadowSettings::ShadowPlacement	shadowPlacement () const
	Returns the placement for the drop shadow. More...

void	updateDataDefinedProperties (QgsRenderContext &context, const QgsPropertyCollection &properties)
	Updates the format by evaluating current values of data defined properties. More...

QDomElement	writeXml (QDomDocument &doc) const
	Write settings into a DOM element. More...

Detailed Description

Container for settings relating to a text shadow.

Note: QgsTextShadowSettings objects are implicitly shared.

Since: QGIS 3.0

Definition at line 37 of file qgstextshadowsettings.h.

Member Enumeration Documentation

◆ ShadowPlacement

enum QgsTextShadowSettings::ShadowPlacement

Placement positions for text shadow.

Enumerator
ShadowLowest	Draw shadow below all text components.
ShadowText	Draw shadow under text.
ShadowBuffer	Draw shadow under buffer.
ShadowShape	Draw shadow under background shape.

Definition at line 44 of file qgstextshadowsettings.h.

Constructor & Destructor Documentation

◆ QgsTextShadowSettings() [1/2]

QgsTextShadowSettings::QgsTextShadowSettings ( )

Definition at line 24 of file qgstextshadowsettings.cpp.

◆ QgsTextShadowSettings() [2/2]

QgsTextShadowSettings::QgsTextShadowSettings ( const QgsTextShadowSettings & other )

Copy constructor.

Parameters

other source QgsTextShadowSettings

Definition at line 29 of file qgstextshadowsettings.cpp.

◆ ~QgsTextShadowSettings()

QgsTextShadowSettings::~QgsTextShadowSettings ( )

Definition at line 41 of file qgstextshadowsettings.cpp.

Member Function Documentation

◆ blendMode()

QPainter::CompositionMode QgsTextShadowSettings::blendMode ( ) const

Returns the blending mode used for drawing the drop shadow.

See also: setBlendMode()

Definition at line 213 of file qgstextshadowsettings.cpp.

◆ blurAlphaOnly()

bool QgsTextShadowSettings::blurAlphaOnly ( ) const

Returns whether only the alpha channel for the shadow will be blurred.

See also: setBlurAlphaOnly()

Definition at line 173 of file qgstextshadowsettings.cpp.

◆ blurRadius()

double QgsTextShadowSettings::blurRadius ( ) const

Returns the blur radius for the shadow.

Radius units are retrieved via blurRadiusUnits().

See also: setBlurRadius(); blurRadiusUnit()

Definition at line 143 of file qgstextshadowsettings.cpp.

◆ blurRadiusMapUnitScale()

QgsMapUnitScale QgsTextShadowSettings::blurRadiusMapUnitScale ( ) const

Returns the map unit scale object for the shadow blur radius.

This is only used if the blurRadiusUnit() is set to QgsUnitTypes::RenderMapUnit.

See also: setBlurRadiusMapUnitScale(); blurRadiusUnit()

Definition at line 163 of file qgstextshadowsettings.cpp.

◆ blurRadiusUnit()

QgsUnitTypes::RenderUnit QgsTextShadowSettings::blurRadiusUnit ( ) const

Returns the units used for the shadow's blur radius.

See also: setBlurRadiusUnit(); blurRadius()

Definition at line 153 of file qgstextshadowsettings.cpp.

◆ color()

QColor QgsTextShadowSettings::color ( ) const

Returns the color of the drop shadow.

See also: setColor()

Definition at line 203 of file qgstextshadowsettings.cpp.

◆ enabled()

bool QgsTextShadowSettings::enabled ( ) const

Returns whether the shadow is enabled.

See also: setEnabled()

Definition at line 73 of file qgstextshadowsettings.cpp.

◆ offsetAngle()

int QgsTextShadowSettings::offsetAngle ( ) const

Returns the angle for offsetting the position of the shadow from the text.

See also: setOffsetAngle; offsetDistance()

Definition at line 93 of file qgstextshadowsettings.cpp.

◆ offsetDistance()

double QgsTextShadowSettings::offsetDistance ( ) const

Returns the distance for offsetting the position of the shadow from the text.

Offset units are retrieved via offsetUnit().

See also: setOffsetDistance(); offsetUnit()

Definition at line 103 of file qgstextshadowsettings.cpp.

◆ offsetGlobal()

bool QgsTextShadowSettings::offsetGlobal ( ) const

Returns true if the global shadow offset will be used.

See also: setOffsetGlobal()

Definition at line 133 of file qgstextshadowsettings.cpp.

◆ offsetMapUnitScale()

QgsMapUnitScale QgsTextShadowSettings::offsetMapUnitScale ( ) const

Returns the map unit scale object for the shadow offset distance.

This is only used if the offsetUnit() is set to QgsUnitTypes::RenderMapUnit.

See also: setOffsetMapUnitScale(); offsetUnit()

Definition at line 123 of file qgstextshadowsettings.cpp.

◆ offsetUnit()

QgsUnitTypes::RenderUnit QgsTextShadowSettings::offsetUnit ( ) const

Returns the units used for the shadow's offset.

See also: setOffsetUnit(); offsetDistance()

Definition at line 113 of file qgstextshadowsettings.cpp.

◆ opacity()

double QgsTextShadowSettings::opacity ( ) const

Returns the shadow's opacity.

The opacity is a double value between 0 (fully transparent) and 1 (totally opaque).

See also: setOpacity()

Definition at line 183 of file qgstextshadowsettings.cpp.

◆ operator!=()

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

Definition at line 68 of file qgstextshadowsettings.cpp.

◆ operator=()

QgsTextShadowSettings & QgsTextShadowSettings::operator= ( const QgsTextShadowSettings & other )

Definition at line 35 of file qgstextshadowsettings.cpp.

◆ operator==()

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

Definition at line 46 of file qgstextshadowsettings.cpp.

◆ readFromLayer()

void QgsTextShadowSettings::readFromLayer ( QgsVectorLayer * layer )

Reads settings from a layer's custom properties (for QGIS 2.x projects).

Parameters

layer source vector layer

Definition at line 223 of file qgstextshadowsettings.cpp.

◆ readXml()

void QgsTextShadowSettings::readXml ( const QDomElement & elem )

Read settings from a DOM element.

See also: writeXml()

Definition at line 289 of file qgstextshadowsettings.cpp.

◆ referencedFields()

QSet< QString > QgsTextShadowSettings::referencedFields ( const QgsRenderContext & context ) const

Returns all field names referenced by the configuration (e.g.

from data defined properties).

Since: QGIS 3.14

Definition at line 471 of file qgstextshadowsettings.cpp.

◆ scale()

int QgsTextShadowSettings::scale ( ) const

Returns the scaling used for the drop shadow (in percentage of original size).

See also: setScale()

Definition at line 193 of file qgstextshadowsettings.cpp.

◆ setBlendMode()

void QgsTextShadowSettings::setBlendMode ( QPainter::CompositionMode mode )

Sets the blending mode used for drawing the drop shadow.

Parameters

mode	blending mode

See also: blendMode()

Definition at line 218 of file qgstextshadowsettings.cpp.

◆ setBlurAlphaOnly()

void QgsTextShadowSettings::setBlurAlphaOnly ( bool alphaOnly )

Sets whether only the alpha channel for the shadow should be blurred.

Parameters

alphaOnly set to true to blur only the alpha channel. If false, all channels (including red, green and blue channel) will be blurred.

See also: blurAlphaOnly()

Definition at line 178 of file qgstextshadowsettings.cpp.

◆ setBlurRadius()

void QgsTextShadowSettings::setBlurRadius ( double blurRadius )

Sets the blur radius for the shadow.

Radius units are specified via setBlurRadiusUnits().

Parameters

blurRadius blur radius

See also: blurRadius(); setBlurRadiusUnit()

Definition at line 148 of file qgstextshadowsettings.cpp.

◆ setBlurRadiusMapUnitScale()

void QgsTextShadowSettings::setBlurRadiusMapUnitScale ( const QgsMapUnitScale & scale )

Sets the map unit scale object for the shadow blur radius.

This is only used if the blurRadiusUnit() is set to QgsUnitTypes::RenderMapUnit.

Parameters

scale scale for shadow blur radius

See also: blurRadiusMapUnitScale(); setBlurRadiusUnit()

Definition at line 168 of file qgstextshadowsettings.cpp.

◆ setBlurRadiusUnit()

void QgsTextShadowSettings::setBlurRadiusUnit ( QgsUnitTypes::RenderUnit units )

Sets the units used for the shadow's blur radius.

Parameters

units shadow blur radius units

See also: blurRadiusUnit(); setBlurRadius()

Definition at line 158 of file qgstextshadowsettings.cpp.

◆ setColor()

void QgsTextShadowSettings::setColor ( const QColor & color )

Sets the color for the drop shadow.

Parameters

color shadow color

See also: color()

Definition at line 208 of file qgstextshadowsettings.cpp.

◆ setEnabled()

void QgsTextShadowSettings::setEnabled ( bool enabled )

Sets whether the text shadow will be drawn.

Parameters

enabled set to true to draw shadow

See also: enabled()

Definition at line 78 of file qgstextshadowsettings.cpp.

◆ setOffsetAngle()

void QgsTextShadowSettings::setOffsetAngle ( int angle )

Sets the angle for offsetting the position of the shadow from the text.

Parameters

angle offset angle in degrees

See also: offsetAngle(); setOffsetDistance()

Definition at line 98 of file qgstextshadowsettings.cpp.

◆ setOffsetDistance()

void QgsTextShadowSettings::setOffsetDistance ( double distance )

Sets the distance for offsetting the position of the shadow from the text.

Offset units are specified via setOffsetUnit().

Parameters

distance offset distance

See also: offsetDistance(); setOffsetUnit()

Definition at line 108 of file qgstextshadowsettings.cpp.

◆ setOffsetGlobal()

void QgsTextShadowSettings::setOffsetGlobal ( bool global )

Sets whether the global shadow offset should be used.

Parameters

global set to true to use global shadow offset.

Definition at line 138 of file qgstextshadowsettings.cpp.

◆ setOffsetMapUnitScale()

void QgsTextShadowSettings::setOffsetMapUnitScale ( const QgsMapUnitScale & scale )

Sets the map unit scale object for the shadow offset distance.

This is only used if the offsetUnit() is set to QgsUnitTypes::RenderMapUnit.

Parameters

scale scale for shadow offset

See also: offsetMapUnitScale(); setOffsetUnit()

Definition at line 128 of file qgstextshadowsettings.cpp.

◆ setOffsetUnit()

void QgsTextShadowSettings::setOffsetUnit ( QgsUnitTypes::RenderUnit units )

Sets the units used for the shadow's offset.

Parameters

units shadow distance units

See also: offsetUnit(); setOffsetDistance()

Definition at line 118 of file qgstextshadowsettings.cpp.

◆ setOpacity()

void QgsTextShadowSettings::setOpacity ( double opacity )

Sets the shadow's opacity.

Parameters

opacity opacity as a double value between 0 (fully transparent) and 1 (totally opaque)

See also: opacity()

Definition at line 188 of file qgstextshadowsettings.cpp.

◆ setScale()

void QgsTextShadowSettings::setScale ( int scale )

Sets the scaling used for the drop shadow (in percentage of original size).

Parameters

scale scale percent for drop shadow

See also: scale()

Definition at line 198 of file qgstextshadowsettings.cpp.

◆ setShadowPlacement()

void QgsTextShadowSettings::setShadowPlacement ( QgsTextShadowSettings::ShadowPlacement placement )

Sets the placement for the drop shadow.

The placement determines both the z-order stacking position for the shadow and the what shape (e.g., text, background shape) is used for casting the shadow.

Parameters

placement shadow placement

See also: shadowPlacement()

Definition at line 88 of file qgstextshadowsettings.cpp.

◆ shadowPlacement()

QgsTextShadowSettings::ShadowPlacement QgsTextShadowSettings::shadowPlacement ( ) const

Returns the placement for the drop shadow.

The placement determines both the z-order stacking position for the shadow and the what shape (e.g., text, background shape) is used for casting the shadow.

See also: setShadowPlacement()

Definition at line 83 of file qgstextshadowsettings.cpp.

◆ updateDataDefinedProperties()

void QgsTextShadowSettings::updateDataDefinedProperties	(	QgsRenderContext &	context,
		const QgsPropertyCollection &	properties
	)

Updates the format by evaluating current values of data defined properties.

Since: QGIS 3.10

Definition at line 378 of file qgstextshadowsettings.cpp.

◆ writeXml()

QDomElement QgsTextShadowSettings::writeXml ( QDomDocument & doc ) const

Write settings into a DOM element.

See also: readXml()

Definition at line 357 of file qgstextshadowsettings.cpp.

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

/build/qgis-3.28.0+99sid/src/core/textrenderer/qgstextshadowsettings.h
/build/qgis-3.28.0+99sid/src/core/textrenderer/qgstextshadowsettings.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ShadowPlacement

Constructor & Destructor Documentation

◆ QgsTextShadowSettings() [1/2]

◆ QgsTextShadowSettings() [2/2]

◆ ~QgsTextShadowSettings()

Member Function Documentation

◆ blendMode()

◆ blurAlphaOnly()

◆ blurRadius()

◆ blurRadiusMapUnitScale()

◆ blurRadiusUnit()

◆ color()

◆ enabled()

◆ offsetAngle()

◆ offsetDistance()

◆ offsetGlobal()

◆ offsetMapUnitScale()

◆ offsetUnit()

◆ opacity()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ readFromLayer()

◆ readXml()

◆ referencedFields()

◆ scale()

◆ setBlendMode()

◆ setBlurAlphaOnly()

◆ setBlurRadius()

◆ setBlurRadiusMapUnitScale()

◆ setBlurRadiusUnit()

◆ setColor()

◆ setEnabled()

◆ setOffsetAngle()

◆ setOffsetDistance()

◆ setOffsetGlobal()

◆ setOffsetMapUnitScale()

◆ setOffsetUnit()

◆ setOpacity()

◆ setScale()

◆ setShadowPlacement()

◆ shadowPlacement()

◆ updateDataDefinedProperties()

◆ writeXml()