QGIS API Documentation  3.13.0-Master (13337b20cd)
Public Types | Public Member Functions | List of all members
QgsTextMaskSettings Class Reference

Container for settings relating to a selective masking around a text. More...

#include <qgstextrenderer.h>

Public Types

enum  MaskType { MaskBuffer = 0 }
 Mask shape types. More...
 

Public Member Functions

 QgsTextMaskSettings ()
 
 QgsTextMaskSettings (const QgsTextMaskSettings &other)
 Copy constructor. More...
 
 ~QgsTextMaskSettings ()
 
bool enabled () const
 Returns whether the mask is enabled. More...
 
Qt::PenJoinStyle joinStyle () const
 Returns the buffer join style. More...
 
QgsSymbolLayerReferenceList maskedSymbolLayers () const
 Returns a list of references to symbol layers that are masked by this buffer. More...
 
double opacity () const
 Returns the mask's opacity. More...
 
QgsTextMaskSettingsoperator= (const QgsTextMaskSettings &other)
 Copy constructor. More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the mask. More...
 
void readXml (const QDomElement &elem)
 Read settings from a DOM element. More...
 
void setEnabled (bool)
 Returns whether the mask is enabled. More...
 
void setJoinStyle (Qt::PenJoinStyle style)
 Sets the join style used for drawing the buffer. More...
 
void setMaskedSymbolLayers (QgsSymbolLayerReferenceList maskedLayers)
 Sets the symbol layers that will be masked by this buffer. More...
 
void setOpacity (double opacity)
 Sets the mask's opacity. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the mask. More...
 
void setSize (double size)
 Sets the size of the buffer. More...
 
void setSizeMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale object for the buffer size. More...
 
void setSizeUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units used for the buffer size. More...
 
void setType (MaskType type)
 Sets the type of mask shape. More...
 
double size () const
 Returns the size of the buffer. More...
 
QgsMapUnitScale sizeMapUnitScale () const
 Returns the map unit scale object for the buffer size. More...
 
QgsUnitTypes::RenderUnit sizeUnit () const
 Returns the units for the buffer size. More...
 
MaskType type () const
 Returns the type of mask shape. 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 selective masking around a text.

A selective masking only makes sense in contexts where the text is rendered over some other map layers, especially for labeling.

Note
QgsTextMaskSettings objects are implicitly shared.
Since
QGIS 3.12

Definition at line 1019 of file qgstextrenderer.h.

Member Enumeration Documentation

◆ MaskType

Mask shape types.

Enumerator
MaskBuffer 

Buffer.

Definition at line 1026 of file qgstextrenderer.h.

Constructor & Destructor Documentation

◆ QgsTextMaskSettings() [1/2]

QgsTextMaskSettings::QgsTextMaskSettings ( )

Definition at line 1580 of file qgstextrenderer.cpp.

◆ QgsTextMaskSettings() [2/2]

QgsTextMaskSettings::QgsTextMaskSettings ( const QgsTextMaskSettings other)

Copy constructor.

Parameters
othersource settings

Definition at line 1587 of file qgstextrenderer.cpp.

◆ ~QgsTextMaskSettings()

QgsTextMaskSettings::~QgsTextMaskSettings ( )
default

Member Function Documentation

◆ enabled()

bool QgsTextMaskSettings::enabled ( ) const

Returns whether the mask is enabled.

Definition at line 1598 of file qgstextrenderer.cpp.

◆ joinStyle()

Qt::PenJoinStyle QgsTextMaskSettings::joinStyle ( ) const

Returns the buffer join style.

See also
setJoinStyle

Definition at line 1649 of file qgstextrenderer.cpp.

◆ maskedSymbolLayers()

QgsSymbolLayerReferenceList QgsTextMaskSettings::maskedSymbolLayers ( ) const

Returns a list of references to symbol layers that are masked by this buffer.

Returns
a list of references to masked symbol layers
See also
setMaskedSymbolLayers

Definition at line 1760 of file qgstextrenderer.cpp.

◆ opacity()

double QgsTextMaskSettings::opacity ( ) const

Returns the mask's opacity.

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

See also
setOpacity()

Definition at line 1659 of file qgstextrenderer.cpp.

◆ operator=()

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

Copy constructor.

Parameters
othersource QgsTextMaskSettings

Definition at line 1592 of file qgstextrenderer.cpp.

◆ paintEffect()

QgsPaintEffect * QgsTextMaskSettings::paintEffect ( ) const

Returns the current paint effect for the mask.

Returns
paint effect
See also
setPaintEffect()

Definition at line 1669 of file qgstextrenderer.cpp.

◆ readXml()

void QgsTextMaskSettings::readXml ( const QDomElement &  elem)

Read settings from a DOM element.

See also
writeXml()

Definition at line 1726 of file qgstextrenderer.cpp.

◆ setEnabled()

void QgsTextMaskSettings::setEnabled ( bool  enabled)

Returns whether the mask is enabled.

Definition at line 1603 of file qgstextrenderer.cpp.

◆ setJoinStyle()

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

Sets the join style used for drawing the buffer.

Parameters
stylejoin style
See also
joinStyle()

Definition at line 1654 of file qgstextrenderer.cpp.

◆ setMaskedSymbolLayers()

void QgsTextMaskSettings::setMaskedSymbolLayers ( QgsSymbolLayerReferenceList  maskedLayers)

Sets the symbol layers that will be masked by this buffer.

Parameters
maskedLayerslist of references to symbol layers
See also
setMaskedSymbolLayers

Definition at line 1765 of file qgstextrenderer.cpp.

◆ setOpacity()

void QgsTextMaskSettings::setOpacity ( double  opacity)

Sets the mask's opacity.

Parameters
opacityopacity as a double value between 0 (fully transparent) and 1 (totally opaque)
See also
opacity()

Definition at line 1664 of file qgstextrenderer.cpp.

◆ setPaintEffect()

void QgsTextMaskSettings::setPaintEffect ( QgsPaintEffect effect)

Sets the current paint effect for the mask.

Parameters
effectpaint effect. Ownership is transferred to the mask settings.
See also
paintEffect()

Definition at line 1674 of file qgstextrenderer.cpp.

◆ setSize()

void QgsTextMaskSettings::setSize ( double  size)

Sets the size of the buffer.

The size units are specified using setSizeUnit().

Parameters
sizebuffer size
See also
size()
setSizeUnit()

Definition at line 1624 of file qgstextrenderer.cpp.

◆ setSizeMapUnitScale()

void QgsTextMaskSettings::setSizeMapUnitScale ( const QgsMapUnitScale scale)

Sets the map unit scale object for the buffer size.

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

Parameters
scalescale for buffer size
See also
sizeMapUnitScale()
setSizeUnit()

Definition at line 1644 of file qgstextrenderer.cpp.

◆ setSizeUnit()

void QgsTextMaskSettings::setSizeUnit ( QgsUnitTypes::RenderUnit  unit)

Sets the units used for the buffer size.

Parameters
unitsize unit
See also
setSize()
sizeUnit()

Definition at line 1634 of file qgstextrenderer.cpp.

◆ setType()

void QgsTextMaskSettings::setType ( QgsTextMaskSettings::MaskType  type)

Sets the type of mask shape.

Parameters
typeshape type
See also
type()

Definition at line 1613 of file qgstextrenderer.cpp.

◆ size()

double QgsTextMaskSettings::size ( ) const

Returns the size of the buffer.

See also
sizeUnit()
setSize()

Definition at line 1619 of file qgstextrenderer.cpp.

◆ sizeMapUnitScale()

QgsMapUnitScale QgsTextMaskSettings::sizeMapUnitScale ( ) const

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 1639 of file qgstextrenderer.cpp.

◆ sizeUnit()

QgsUnitTypes::RenderUnit QgsTextMaskSettings::sizeUnit ( ) const

Returns the units for the buffer size.

See also
size()
setSizeUnit()

Definition at line 1629 of file qgstextrenderer.cpp.

◆ type()

QgsTextMaskSettings::MaskType QgsTextMaskSettings::type ( ) const

Returns the type of mask shape.

See also
setType()

Definition at line 1608 of file qgstextrenderer.cpp.

◆ updateDataDefinedProperties()

void QgsTextMaskSettings::updateDataDefinedProperties ( QgsRenderContext context,
const QgsPropertyCollection properties 
)

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

Definition at line 1679 of file qgstextrenderer.cpp.

◆ writeXml()

QDomElement QgsTextMaskSettings::writeXml ( QDomDocument &  doc) const

Write settings into a DOM element.

See also
readXml()

Definition at line 1744 of file qgstextrenderer.cpp.


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