QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Member Functions | List of all members
QgsTextBufferSettings Class Reference

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

#include <qgstextbuffersettings.h>

Public Member Functions

 QgsTextBufferSettings ()
 
 QgsTextBufferSettings (const QgsTextBufferSettings &other)
 Copy constructor. More...
 
 ~QgsTextBufferSettings ()
 
QPainter::CompositionMode blendMode () const
 Returns the blending mode used for drawing the buffer. More...
 
QColor color () const
 Returns the color of the buffer. More...
 
bool enabled () const
 Returns whether the buffer is enabled. More...
 
bool fillBufferInterior () const
 Returns whether the interior of the buffer will be filled in. More...
 
Qt::PenJoinStyle joinStyle () const
 Returns the buffer join style. More...
 
double opacity () const
 Returns the buffer opacity. More...
 
bool operator!= (const QgsTextBufferSettings &other) const
 
QgsTextBufferSettingsoperator= (const QgsTextBufferSettings &other)
 Copy constructor. More...
 
bool operator== (const QgsTextBufferSettings &other) const
 
const QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the buffer. More...
 
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...
 
void setBlendMode (QPainter::CompositionMode mode)
 Sets the blending mode used for drawing the buffer. More...
 
void setColor (const QColor &color)
 Sets the color for the buffer. More...
 
void setEnabled (bool enabled)
 Sets whether the text buffer will be drawn. More...
 
void setFillBufferInterior (bool fill)
 Sets whether the interior of the buffer will be filled in. More...
 
void setJoinStyle (Qt::PenJoinStyle style)
 Sets the join style used for drawing the buffer. More...
 
void setOpacity (double opacity)
 Sets the buffer opacity. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the buffer. 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...
 
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...
 
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 buffer.

Note
QgsTextBufferSettings objects are implicitly shared.
Since
QGIS 3.0

Definition at line 42 of file qgstextbuffersettings.h.

Constructor & Destructor Documentation

◆ QgsTextBufferSettings() [1/2]

QgsTextBufferSettings::QgsTextBufferSettings ( )

Definition at line 27 of file qgstextbuffersettings.cpp.

◆ QgsTextBufferSettings() [2/2]

QgsTextBufferSettings::QgsTextBufferSettings ( const QgsTextBufferSettings other)

Copy constructor.

Parameters
othersource settings

Definition at line 32 of file qgstextbuffersettings.cpp.

◆ ~QgsTextBufferSettings()

QgsTextBufferSettings::~QgsTextBufferSettings ( )

Definition at line 43 of file qgstextbuffersettings.cpp.

Member Function Documentation

◆ blendMode()

QPainter::CompositionMode QgsTextBufferSettings::blendMode ( ) const

Returns the blending mode used for drawing the buffer.

See also
setBlendMode()

Definition at line 153 of file qgstextbuffersettings.cpp.

◆ color()

QColor QgsTextBufferSettings::color ( ) const

Returns the color of the buffer.

See also
setColor()

Definition at line 113 of file qgstextbuffersettings.cpp.

◆ enabled()

bool QgsTextBufferSettings::enabled ( ) const

Returns whether the buffer is enabled.

See also
setEnabled()

Definition at line 73 of file qgstextbuffersettings.cpp.

◆ fillBufferInterior()

bool QgsTextBufferSettings::fillBufferInterior ( ) const

Returns whether the interior of the buffer will be filled in.

If false, only the stroke of the text will be drawn as the buffer. The effect of this setting is only visible for semi-transparent text.

See also
setFillBufferInterior()

Definition at line 123 of file qgstextbuffersettings.cpp.

◆ joinStyle()

Qt::PenJoinStyle QgsTextBufferSettings::joinStyle ( ) const

Returns the buffer join style.

See also
setJoinStyle

Definition at line 143 of file qgstextbuffersettings.cpp.

◆ opacity()

double QgsTextBufferSettings::opacity ( ) const

Returns the buffer opacity.

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

See also
setOpacity()

Definition at line 133 of file qgstextbuffersettings.cpp.

◆ operator!=()

bool QgsTextBufferSettings::operator!= ( const QgsTextBufferSettings other) const

Definition at line 68 of file qgstextbuffersettings.cpp.

◆ operator=()

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

Copy constructor.

Parameters
othersource QgsTextBufferSettings

Definition at line 37 of file qgstextbuffersettings.cpp.

◆ operator==()

bool QgsTextBufferSettings::operator== ( const QgsTextBufferSettings other) const

Definition at line 48 of file qgstextbuffersettings.cpp.

◆ paintEffect()

const QgsPaintEffect * QgsTextBufferSettings::paintEffect ( ) const

Returns the current paint effect for the buffer.

Returns
paint effect
See also
setPaintEffect()

Definition at line 163 of file qgstextbuffersettings.cpp.

◆ readFromLayer()

void QgsTextBufferSettings::readFromLayer ( QgsVectorLayer layer)

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

Parameters
layersource vector layer

Definition at line 240 of file qgstextbuffersettings.cpp.

◆ readXml()

void QgsTextBufferSettings::readXml ( const QDomElement &  elem)

Read settings from a DOM element.

See also
writeXml()

Definition at line 311 of file qgstextbuffersettings.cpp.

◆ referencedFields()

QSet< QString > QgsTextBufferSettings::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 235 of file qgstextbuffersettings.cpp.

◆ setBlendMode()

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

Sets the blending mode used for drawing the buffer.

Parameters
modeblending mode
See also
blendMode()

Definition at line 158 of file qgstextbuffersettings.cpp.

◆ setColor()

void QgsTextBufferSettings::setColor ( const QColor &  color)

Sets the color for the buffer.

Parameters
colorbuffer color
See also
color()

Definition at line 118 of file qgstextbuffersettings.cpp.

◆ setEnabled()

void QgsTextBufferSettings::setEnabled ( bool  enabled)

Sets whether the text buffer will be drawn.

Parameters
enabledset to true to draw buffer
See also
enabled()

Definition at line 78 of file qgstextbuffersettings.cpp.

◆ setFillBufferInterior()

void QgsTextBufferSettings::setFillBufferInterior ( bool  fill)

Sets whether the interior of the buffer will be filled in.

Parameters
fillset to false to drawn only the stroke of the text as the buffer, or true to also shade the area inside the text. The effect of this setting is only visible for semi-transparent text.
See also
fillBufferInterior()

Definition at line 128 of file qgstextbuffersettings.cpp.

◆ setJoinStyle()

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

Sets the join style used for drawing the buffer.

Parameters
stylejoin style
See also
joinStyle()

Definition at line 148 of file qgstextbuffersettings.cpp.

◆ setOpacity()

void QgsTextBufferSettings::setOpacity ( double  opacity)

Sets the buffer opacity.

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

Definition at line 138 of file qgstextbuffersettings.cpp.

◆ setPaintEffect()

void QgsTextBufferSettings::setPaintEffect ( QgsPaintEffect effect)

Sets the current paint effect for the buffer.

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

Definition at line 168 of file qgstextbuffersettings.cpp.

◆ setSize()

void QgsTextBufferSettings::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 88 of file qgstextbuffersettings.cpp.

◆ setSizeMapUnitScale()

void QgsTextBufferSettings::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 108 of file qgstextbuffersettings.cpp.

◆ setSizeUnit()

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

Sets the units used for the buffer size.

Parameters
unitsize unit
See also
setSize()
sizeUnit()

Definition at line 98 of file qgstextbuffersettings.cpp.

◆ size()

double QgsTextBufferSettings::size ( ) const

Returns the size of the buffer.

See also
sizeUnit()
setSize()

Definition at line 83 of file qgstextbuffersettings.cpp.

◆ sizeMapUnitScale()

QgsMapUnitScale QgsTextBufferSettings::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 103 of file qgstextbuffersettings.cpp.

◆ sizeUnit()

QgsUnitTypes::RenderUnit QgsTextBufferSettings::sizeUnit ( ) const

Returns the units for the buffer size.

See also
size()
setSizeUnit()

Definition at line 93 of file qgstextbuffersettings.cpp.

◆ updateDataDefinedProperties()

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

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

Since
QGIS 3.10

Definition at line 173 of file qgstextbuffersettings.cpp.

◆ writeXml()

QDomElement QgsTextBufferSettings::writeXml ( QDomDocument &  doc) const

Write settings into a DOM element.

See also
readXml()

Definition at line 378 of file qgstextbuffersettings.cpp.


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