Defines how text is displayed using characteristics such as font, size, color, and position. More...
Member Function Documentation[explicit]
TextSymbol::TextSymbol(QObject *parent = nullptr)
Creates a text symbol with default values.
The default values are:
Creates a text symbol with the given size, text, and color along with the horizontal and vertical alignment relative to the mid-point of this symbol.
[override virtual noexcept]
TextSymbol::~TextSymbol()
Destructor.
QColor TextSymbol::backgroundColor() constReturns the color for the text symbol background.
The default value is transparent.
See also setBackgroundColor().
QColor TextSymbol::color() constReturns the color of the text.
The default value is black.
See also setColor().
Esri::ArcGISRuntime::FontDecoration TextSymbol::fontDecoration() constReturns the type of font decoration for the text symbol.
The default value is FontDecorationNone.
See also setFontDecoration().
QString TextSymbol::fontFamily() constReturns the font family for the text.
This can be as specific as 'arial' or as generic as 'sans-serif', for example.
See also setFontFamily().
Esri::ArcGISRuntime::FontStyle TextSymbol::fontStyle() constReturns the font style for the text.
Returns FontStyle::Normal if an error occurs.
See also setFontStyle().
Esri::ArcGISRuntime::FontWeight TextSymbol::fontWeight() constReturns the font weight for the text.
Font weight describes how thick or thin characters in text are displayed. The default value is FontWeightNormal.
See also setFontWeight().
QColor TextSymbol::haloColor() constReturns the color for the halo around the text symbol.
The default value is transparent.
See also setHaloColor().
float TextSymbol::haloWidth() constReturns the size of the halo around the text symbol in device-independent pixels (DIPs).
The default value is 0.0.
See also setHaloWidth().
Esri::ArcGISRuntime::HorizontalAlignment TextSymbol::horizontalAlignment() constReturns the horizontal alignment of the text symbol relative to the symbol's mid-point location.
The default value is HorizontalAlignment::Center. Returns HorizontalAlignment::Center if an error occurs.
See also setHorizontalAlignment().
bool TextSymbol::isKerningEnabled() constReturns true
if kerning (visual adjustments to the spacing between characters in the text) is enabled.
Determines whether to adjust the spacing between characters in the text string.
The default value is false
.
Returns the color for the text symbol outline.
See also setOutlineColor().
float TextSymbol::outlineWidth() constReturns the width of the text symbol outline in device-independent pixels (DIPs).
The default value is 0.0.
See also setOutlineWidth().
void TextSymbol::setBackgroundColor(const QColor &backgroundColor)Sets the color for the text symbol background to backgroundColor.
See also backgroundColor().
void TextSymbol::setColor(const QColor &color)Sets the color of the text.
See also color().
void TextSymbol::setFontDecoration(Esri::ArcGISRuntime::FontDecoration fontDecoration)Sets the fontDecoration of the text.
See also fontDecoration.
void TextSymbol::setFontFamily(const QString &fontFamily)Sets the fontFamily for the text.
See also fontFamily.
void TextSymbol::setFontStyle(Esri::ArcGISRuntime::FontStyle fontStyle)Sets the fontStyle for the text.
See also fontStyle.
void TextSymbol::setFontWeight(Esri::ArcGISRuntime::FontWeight fontWeight)Sets the fontWeight for the text.
See also fontWeight.
void TextSymbol::setHaloColor(const QColor &haloColor)Sets the color of the halo to haloColor.
See also haloColor.
void TextSymbol::setHaloWidth(float haloWidth)Sets the width of the outline in device independent pixels (DIPs) to haloWidth.
See also haloWidth.
void TextSymbol::setHorizontalAlignment(Esri::ArcGISRuntime::HorizontalAlignment hAlign)Sets the hAlign for the text.
See also horizontalAlignment.
void TextSymbol::setKerningEnabled(bool kerningEnabled)Sets whether kerning (visual adjustments to the spacing between characters in the text) is enabled to kerningEnabled.
The default value is false
.
See also isKerningEnabled.
void TextSymbol::setOutlineColor(const QColor &outlineColor)Sets the color of the outline to outlineColor.
See also outlineColor.
void TextSymbol::setOutlineWidth(float outlineWidth)Sets the width of the outline in device independent pixels (DIPs) to outlineWidth.
See also outlineWidth.
void TextSymbol::setSize(float size)Sets the size of the text in device independent pixels (DIPs).
See also size.
void TextSymbol::setText(const QString &text)Sets the text to display for the symbol.
See also text.
void TextSymbol::setVerticalAlignment(Esri::ArcGISRuntime::VerticalAlignment vAlign)Sets the vAlign for the text.
See also verticalAlignment.
float TextSymbol::size() constReturns the font size of the text symbol.
The default value is 8.0.
See also setSize().
QString TextSymbol::text() constReturns the text of the text symbol.
The default value is an empty string.
See also setText().
Esri::ArcGISRuntime::VerticalAlignment TextSymbol::verticalAlignment() constReturns the vertical alignment of the text symbol relative to the symbol's mid-point location.
The default value is VerticalAlignment::Middle. Returns VerticalAlignment::Middle if an error occurs.
See also setVerticalAlignment().
[since Esri::ArcGISRuntime 200.2]
bool TextSymbol::operator!=(const Esri::ArcGISRuntime::TextSymbol &other) const
Inequality operator. Returns true
if this object and other are not equal.
This function was introduced in Esri::ArcGISRuntime 200.2.
See also TextSymbol::operator==.
[since Esri::ArcGISRuntime 200.1]
bool TextSymbol::operator==(const Esri::ArcGISRuntime::TextSymbol &other) const
Tests and returns true
if this text symbol is equal to another text symbol.
This function was introduced in Esri::ArcGISRuntime 200.1.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4