QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Container for settings relating to a selective masking around a text. More...
#include <qgstextmasksettings.h>
Public Types | |
enum | MaskType { MaskBuffer = 0 } |
Mask shape types. More... | |
Public Member Functions | |
QgsTextMaskSettings () | |
QgsTextMaskSettings (const QgsTextMaskSettings &other) | |
~QgsTextMaskSettings () | |
bool | enabled () const |
Returns whether the mask is enabled. | |
Qt::PenJoinStyle | joinStyle () const |
Returns the buffer join style. | |
QList< QgsSymbolLayerReference > | maskedSymbolLayers () const |
Returns a list of references to symbol layers that are masked by this buffer. | |
double | opacity () const |
Returns the mask's opacity. | |
bool | operator!= (const QgsTextMaskSettings &other) const |
QgsTextMaskSettings & | operator= (const QgsTextMaskSettings &other) |
bool | operator== (const QgsTextMaskSettings &other) const |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the mask. | |
void | readXml (const QDomElement &elem) |
Read settings from a DOM element. | |
QSet< QString > | referencedFields (const QgsRenderContext &context) const |
Returns all field names referenced by the configuration (e.g. | |
void | setEnabled (bool) |
Returns whether the mask is enabled. | |
void | setJoinStyle (Qt::PenJoinStyle style) |
Sets the join style used for drawing the buffer. | |
void | setMaskedSymbolLayers (const QList< QgsSymbolLayerReference > &maskedLayers) |
Sets the symbol layers that will be masked by this buffer. | |
void | setOpacity (double opacity) |
Sets the mask's opacity. | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the mask. | |
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 units used for the buffer size. | |
void | setType (MaskType type) |
Sets the type of mask shape. | |
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. | |
MaskType | type () const |
Returns the type of mask shape. | |
void | updateDataDefinedProperties (QgsRenderContext &context, const QgsPropertyCollection &properties) |
Updates the format by evaluating current values of data defined properties. | |
QDomElement | writeXml (QDomDocument &doc) const |
Write settings into a DOM element. | |
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.
Definition at line 42 of file qgstextmasksettings.h.
QgsTextMaskSettings::QgsTextMaskSettings | ( | ) |
Definition at line 24 of file qgstextmasksettings.cpp.
QgsTextMaskSettings::QgsTextMaskSettings | ( | const QgsTextMaskSettings & | other | ) |
Definition at line 31 of file qgstextmasksettings.cpp.
|
default |
bool QgsTextMaskSettings::enabled | ( | ) | const |
Returns whether the mask is enabled.
Definition at line 66 of file qgstextmasksettings.cpp.
Qt::PenJoinStyle QgsTextMaskSettings::joinStyle | ( | ) | const |
Returns the buffer join style.
Definition at line 117 of file qgstextmasksettings.cpp.
QList< QgsSymbolLayerReference > QgsTextMaskSettings::maskedSymbolLayers | ( | ) | const |
Returns a list of references to symbol layers that are masked by this buffer.
Definition at line 254 of file qgstextmasksettings.cpp.
double QgsTextMaskSettings::opacity | ( | ) | const |
Returns the mask's opacity.
The opacity is a double value between 0 (fully transparent) and 1 (totally opaque).
Definition at line 127 of file qgstextmasksettings.cpp.
bool QgsTextMaskSettings::operator!= | ( | const QgsTextMaskSettings & | other | ) | const |
Definition at line 61 of file qgstextmasksettings.cpp.
QgsTextMaskSettings & QgsTextMaskSettings::operator= | ( | const QgsTextMaskSettings & | other | ) |
Definition at line 36 of file qgstextmasksettings.cpp.
bool QgsTextMaskSettings::operator== | ( | const QgsTextMaskSettings & | other | ) | const |
Definition at line 42 of file qgstextmasksettings.cpp.
QgsPaintEffect * QgsTextMaskSettings::paintEffect | ( | ) | const |
Returns the current paint effect for the mask.
Definition at line 137 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::readXml | ( | const QDomElement & | elem | ) |
Read settings from a DOM element.
Definition at line 203 of file qgstextmasksettings.cpp.
QSet< QString > QgsTextMaskSettings::referencedFields | ( | const QgsRenderContext & | context | ) | const |
Returns all field names referenced by the configuration (e.g.
from data defined properties).
Definition at line 198 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::setEnabled | ( | bool | enabled | ) |
Returns whether the mask is enabled.
Definition at line 71 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::setJoinStyle | ( | Qt::PenJoinStyle | style | ) |
Sets the join style used for drawing the buffer.
style | join style |
Definition at line 122 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::setMaskedSymbolLayers | ( | const QList< QgsSymbolLayerReference > & | maskedLayers | ) |
Sets the symbol layers that will be masked by this buffer.
maskedLayers | list of references to symbol layers |
Definition at line 259 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::setOpacity | ( | double | opacity | ) |
Sets the mask's opacity.
opacity | opacity as a double value between 0 (fully transparent) and 1 (totally opaque) |
Definition at line 132 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::setPaintEffect | ( | QgsPaintEffect * | effect | ) |
Sets the current paint effect for the mask.
effect | paint effect. Ownership is transferred to the mask settings. |
Definition at line 142 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::setSize | ( | double | size | ) |
Sets the size of the buffer.
The size units are specified using setSizeUnit().
size | buffer size |
Definition at line 92 of file qgstextmasksettings.cpp.
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.
scale | scale for buffer size |
Definition at line 112 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::setSizeUnit | ( | Qgis::RenderUnit | unit | ) |
Sets the units used for the buffer size.
unit | size unit |
Definition at line 102 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::setType | ( | QgsTextMaskSettings::MaskType | type | ) |
Sets the type of mask shape.
type | shape type |
Definition at line 81 of file qgstextmasksettings.cpp.
double QgsTextMaskSettings::size | ( | ) | const |
Returns the size of the buffer.
Definition at line 87 of file qgstextmasksettings.cpp.
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.
Definition at line 107 of file qgstextmasksettings.cpp.
Qgis::RenderUnit QgsTextMaskSettings::sizeUnit | ( | ) | const |
Returns the units for the buffer size.
Definition at line 97 of file qgstextmasksettings.cpp.
QgsTextMaskSettings::MaskType QgsTextMaskSettings::type | ( | ) | const |
Returns the type of mask shape.
Definition at line 76 of file qgstextmasksettings.cpp.
void QgsTextMaskSettings::updateDataDefinedProperties | ( | QgsRenderContext & | context, |
const QgsPropertyCollection & | properties | ||
) |
Updates the format by evaluating current values of data defined properties.
Definition at line 147 of file qgstextmasksettings.cpp.
QDomElement QgsTextMaskSettings::writeXml | ( | QDomDocument & | doc | ) | const |
Write settings into a DOM element.
Definition at line 236 of file qgstextmasksettings.cpp.