25 #include "qgsconfig.h"
26 #include <QFontDatabase>
30 #if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
31 #include <QDesktopWidget>
36 d =
new QgsTextSettingsPrivate();
40 : mBufferSettings( other.mBufferSettings )
41 , mBackgroundSettings( other.mBackgroundSettings )
42 , mShadowSettings( other.mShadowSettings )
43 , mMaskSettings( other.mMaskSettings )
44 , mTextFontFamily( other.mTextFontFamily )
45 , mTextFontFound( other.mTextFontFound )
54 mBufferSettings = other.mBufferSettings;
55 mBackgroundSettings = other.mBackgroundSettings;
56 mShadowSettings = other.mShadowSettings;
57 mMaskSettings = other.mMaskSettings;
58 mTextFontFamily = other.mTextFontFamily;
59 mTextFontFound = other.mTextFontFound;
70 if ( d->isValid != other.
isValid()
71 || d->textFont != other.
font()
73 || d->fontSizeUnits != other.
sizeUnit()
75 || d->fontSize != other.
size()
76 || d->textColor != other.
color()
77 || d->opacity != other.
opacity()
86 || mBufferSettings != other.mBufferSettings
87 || mBackgroundSettings != other.mBackgroundSettings
88 || mShadowSettings != other.mShadowSettings
89 || mMaskSettings != other.mMaskSettings
99 return !( *
this == other );
115 return mBufferSettings;
121 mBufferSettings = bufferSettings;
127 return mBackgroundSettings;
133 mBackgroundSettings = backgroundSettings;
139 return mShadowSettings;
145 mShadowSettings = shadowSettings;
151 return mMaskSettings;
157 mMaskSettings = maskSettings;
170 QFont
font = d->textFont;
171 if ( scaleFactor == 1 )
174 d->fontSizeMapUnitScale );
175 if ( fontPixelSize == 0 )
182 font.setPixelSize( fontPixelSize );
186 double fontPixelSize = context.
convertToPainterUnits( d->fontSize, d->fontSizeUnits, d->fontSizeMapUnitScale );
193 const int roundedPixelSize =
static_cast< int >( std::round( scaleFactor * fontPixelSize + 0.5 ) );
194 font.setPixelSize( roundedPixelSize );
197 font.setLetterSpacing( QFont::AbsoluteSpacing, context.
convertToPainterUnits( d->textFont.letterSpacing(), d->fontSizeUnits, d->fontSizeMapUnitScale ) * scaleFactor );
198 font.setWordSpacing( context.
convertToPainterUnits( d->textFont.wordSpacing(), d->fontSizeUnits, d->fontSizeMapUnitScale ) * scaleFactor * scaleFactor );
202 font.setCapitalization( QFont::SmallCaps );
215 if ( !d->textNamedStyle.isEmpty() )
216 return d->textNamedStyle;
219 return db.styleString( d->textFont );
226 d->textNamedStyle = style;
231 return d->forcedBold;
237 d->textFont.setBold( forced );
238 d->forcedBold =
true;
243 return d->forcedItalic;
249 d->textFont.setItalic( forced );
250 d->forcedItalic =
true;
266 return d->fontSizeUnits;
272 d->fontSizeUnits = unit;
277 return d->fontSizeMapUnitScale;
283 d->fontSizeMapUnitScale = scale;
305 d->textColor =
color;
321 return d->textFont.stretch() > 0 ? d->textFont.stretch() : 100;
327 d->textFont.setStretch( factor );
343 return d->multilineHeight;
349 d->multilineHeight = height;
354 return d->orientation;
368 : d->capitalization ;
375 #if defined(HAS_KDE_QT5_SMALL_CAPS_FIX) || QT_VERSION >= QT_VERSION_CHECK(6, 3, 0)
378 d->textFont.setCapitalization( QFont::MixedCase );
384 return d->allowHtmlFormatting;
390 d->allowHtmlFormatting = allow;
395 return d->previewBackgroundColor;
401 d->previewBackgroundColor =
color;
407 QFont appFont = QApplication::font();
408 mTextFontFamily = layer->
customProperty( QStringLiteral(
"labeling/fontFamily" ), QVariant( appFont.family() ) ).toString();
409 QString fontFamily = mTextFontFamily;
413 mTextFontFound =
false;
419 fontFamily = appFont.family();
423 mTextFontFound =
true;
428 d->fontSize = appFont.pointSizeF();
432 d->fontSize = layer->
customProperty( QStringLiteral(
"labeling/fontSize" ) ).toDouble();
435 if ( layer->
customProperty( QStringLiteral(
"labeling/fontSizeUnit" ) ).toString().isEmpty() )
437 d->fontSizeUnits = layer->
customProperty( QStringLiteral(
"labeling/fontSizeInMapUnits" ), QVariant(
false ) ).toBool() ?
447 if ( layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitScale" ) ).toString().isEmpty() )
450 double oldMin = layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitMinScale" ), 0.0 ).toDouble();
451 d->fontSizeMapUnitScale.minScale = oldMin != 0 ? 1.0 / oldMin : 0;
452 double oldMax = layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitMaxScale" ), 0.0 ).toDouble();
453 d->fontSizeMapUnitScale.maxScale = oldMax != 0 ? 1.0 / oldMax : 0;
459 int fontWeight = layer->
customProperty( QStringLiteral(
"labeling/fontWeight" ) ).toInt();
460 bool fontItalic = layer->
customProperty( QStringLiteral(
"labeling/fontItalic" ) ).toBool();
461 d->textFont = QFont( fontFamily, d->fontSize, fontWeight, fontItalic );
465 d->textFont.setUnderline( layer->
customProperty( QStringLiteral(
"labeling/fontUnderline" ) ).toBool() );
466 d->textFont.setStrikeOut( layer->
customProperty( QStringLiteral(
"labeling/fontStrikeout" ) ).toBool() );
467 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, layer->
customProperty( QStringLiteral(
"labeling/fontLetterSpacing" ), QVariant( 0.0 ) ).toDouble() );
468 d->textFont.setWordSpacing( layer->
customProperty( QStringLiteral(
"labeling/fontWordSpacing" ), QVariant( 0.0 ) ).toDouble() );
470 if ( layer->
customProperty( QStringLiteral(
"labeling/textOpacity" ) ).toString().isEmpty() )
472 d->opacity = ( 1 - layer->
customProperty( QStringLiteral(
"labeling/textTransp" ) ).toInt() / 100.0 );
476 d->opacity = ( layer->
customProperty( QStringLiteral(
"labeling/textOpacity" ) ).toDouble() );
480 d->multilineHeight = layer->
customProperty( QStringLiteral(
"labeling/multilineHeight" ), QVariant( 1.0 ) ).toDouble();
491 QDomElement textStyleElem;
492 if ( elem.nodeName() == QLatin1String(
"text-style" ) )
493 textStyleElem = elem;
495 textStyleElem = elem.firstChildElement( QStringLiteral(
"text-style" ) );
496 QFont appFont = QApplication::font();
497 mTextFontFamily = textStyleElem.attribute( QStringLiteral(
"fontFamily" ), appFont.family() );
498 QString fontFamily = mTextFontFamily;
500 const QDomElement familiesElem = textStyleElem.firstChildElement( QStringLiteral(
"families" ) );
501 const QDomNodeList familyNodes = familiesElem.childNodes();
503 families.reserve( familyNodes.size() );
504 for (
int i = 0; i < familyNodes.count(); ++i )
506 const QDomElement familyElem = familyNodes.at( i ).toElement();
507 families << familyElem.attribute( QStringLiteral(
"name" ) );
511 mTextFontFound =
false;
514 for (
const QString &family : std::as_const(
families ) )
518 mTextFontFound =
true;
524 if ( !mTextFontFound )
527 fontFamily = appFont.family();
532 mTextFontFound =
true;
535 if ( !mTextFontFound )
537 context.
pushMessage( QObject::tr(
"Font “%1” not available on system" ).arg( mTextFontFamily ) );
540 if ( textStyleElem.hasAttribute( QStringLiteral(
"fontSize" ) ) )
542 d->fontSize = textStyleElem.attribute( QStringLiteral(
"fontSize" ) ).toDouble();
546 d->fontSize = appFont.pointSizeF();
549 if ( !textStyleElem.hasAttribute( QStringLiteral(
"fontSizeUnit" ) ) )
551 d->fontSizeUnits = textStyleElem.attribute( QStringLiteral(
"fontSizeInMapUnits" ) ).toUInt() == 0 ?
QgsUnitTypes::RenderPoints
559 if ( !textStyleElem.hasAttribute( QStringLiteral(
"fontSizeMapUnitScale" ) ) )
562 double oldMin = textStyleElem.attribute( QStringLiteral(
"fontSizeMapUnitMinScale" ), QStringLiteral(
"0" ) ).toDouble();
563 d->fontSizeMapUnitScale.minScale = oldMin != 0 ? 1.0 / oldMin : 0;
564 double oldMax = textStyleElem.attribute( QStringLiteral(
"fontSizeMapUnitMaxScale" ), QStringLiteral(
"0" ) ).toDouble();
565 d->fontSizeMapUnitScale.maxScale = oldMax != 0 ? 1.0 / oldMax : 0;
571 int fontWeight = textStyleElem.attribute( QStringLiteral(
"fontWeight" ) ).toInt();
572 bool fontItalic = textStyleElem.attribute( QStringLiteral(
"fontItalic" ) ).toInt();
573 d->textFont = QFont( fontFamily, d->fontSize, fontWeight, fontItalic );
574 d->textFont.setPointSizeF( d->fontSize );
577 d->forcedBold = textStyleElem.attribute( QStringLiteral(
"forcedBold" ) ).toInt();
578 d->forcedItalic = textStyleElem.attribute( QStringLiteral(
"forcedItalic" ) ).toInt();
579 d->textFont.setUnderline( textStyleElem.attribute( QStringLiteral(
"fontUnderline" ) ).toInt() );
580 d->textFont.setStrikeOut( textStyleElem.attribute( QStringLiteral(
"fontStrikeout" ) ).toInt() );
581 d->textFont.setKerning( textStyleElem.attribute( QStringLiteral(
"fontKerning" ), QStringLiteral(
"1" ) ).toInt() );
582 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, textStyleElem.attribute( QStringLiteral(
"fontLetterSpacing" ), QStringLiteral(
"0" ) ).toDouble() );
583 d->textFont.setWordSpacing( textStyleElem.attribute( QStringLiteral(
"fontWordSpacing" ), QStringLiteral(
"0" ) ).toDouble() );
585 if ( !textStyleElem.hasAttribute( QStringLiteral(
"textOpacity" ) ) )
587 d->opacity = ( 1 - textStyleElem.attribute( QStringLiteral(
"textTransp" ) ).toInt() / 100.0 );
591 d->opacity = ( textStyleElem.attribute( QStringLiteral(
"textOpacity" ) ).toDouble() );
593 #ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
594 d->textFont.setStretch( textStyleElem.attribute( QStringLiteral(
"stretchFactor" ), QStringLiteral(
"100" ) ).toInt() );
602 if ( !textStyleElem.hasAttribute( QStringLiteral(
"multilineHeight" ) ) )
604 QDomElement textFormatElem = elem.firstChildElement( QStringLiteral(
"text-format" ) );
605 d->multilineHeight = textFormatElem.attribute( QStringLiteral(
"multilineHeight" ), QStringLiteral(
"1" ) ).toDouble();
609 d->multilineHeight = textStyleElem.attribute( QStringLiteral(
"multilineHeight" ), QStringLiteral(
"1" ) ).toDouble();
612 if ( textStyleElem.hasAttribute( QStringLiteral(
"capitalization" ) ) )
615 d->capitalization =
static_cast< Qgis::Capitalization >( textStyleElem.attribute( QStringLiteral(
"fontCapitals" ), QStringLiteral(
"0" ) ).toUInt() );
618 d->textFont.setCapitalization( QFont::SmallCaps );
620 d->allowHtmlFormatting = textStyleElem.attribute( QStringLiteral(
"allowHtml" ), QStringLiteral(
"0" ) ).toInt();
622 if ( textStyleElem.firstChildElement( QStringLiteral(
"text-buffer" ) ).isNull() )
624 mBufferSettings.
readXml( elem );
628 mBufferSettings.
readXml( textStyleElem );
630 if ( textStyleElem.firstChildElement( QStringLiteral(
"text-mask" ) ).isNull() )
636 mMaskSettings.
readXml( textStyleElem );
638 if ( textStyleElem.firstChildElement( QStringLiteral(
"shadow" ) ).isNull() )
640 mShadowSettings.
readXml( elem );
644 mShadowSettings.
readXml( textStyleElem );
646 if ( textStyleElem.firstChildElement( QStringLiteral(
"background" ) ).isNull() )
648 mBackgroundSettings.
readXml( elem, context );
652 mBackgroundSettings.
readXml( textStyleElem, context );
655 QDomElement ddElem = textStyleElem.firstChildElement( QStringLiteral(
"dd_properties" ) );
656 if ( ddElem.isNull() )
658 ddElem = elem.firstChildElement( QStringLiteral(
"dd_properties" ) );
660 if ( !ddElem.isNull() )
667 d->mDataDefinedProperties.clear();
674 QDomElement textStyleElem = doc.createElement( QStringLiteral(
"text-style" ) );
675 textStyleElem.setAttribute( QStringLiteral(
"fontFamily" ), d->textFont.family() );
677 QDomElement familiesElem = doc.createElement( QStringLiteral(
"families" ) );
678 for (
const QString &family : std::as_const( d->families ) )
680 QDomElement familyElem = doc.createElement( QStringLiteral(
"family" ) );
681 familyElem.setAttribute( QStringLiteral(
"name" ), family );
682 familiesElem.appendChild( familyElem );
684 textStyleElem.appendChild( familiesElem );
687 textStyleElem.setAttribute( QStringLiteral(
"fontSize" ), d->fontSize );
690 textStyleElem.setAttribute( QStringLiteral(
"fontWeight" ), d->textFont.weight() );
691 textStyleElem.setAttribute( QStringLiteral(
"fontItalic" ), d->textFont.italic() );
692 textStyleElem.setAttribute( QStringLiteral(
"fontStrikeout" ), d->textFont.strikeOut() );
693 textStyleElem.setAttribute( QStringLiteral(
"fontUnderline" ), d->textFont.underline() );
694 textStyleElem.setAttribute( QStringLiteral(
"forcedBold" ), d->forcedBold );
695 textStyleElem.setAttribute( QStringLiteral(
"forcedItalic" ), d->forcedItalic );
698 textStyleElem.setAttribute( QStringLiteral(
"fontLetterSpacing" ), d->textFont.letterSpacing() );
699 textStyleElem.setAttribute( QStringLiteral(
"fontWordSpacing" ), d->textFont.wordSpacing() );
700 textStyleElem.setAttribute( QStringLiteral(
"fontKerning" ), d->textFont.kerning() );
701 textStyleElem.setAttribute( QStringLiteral(
"textOpacity" ), d->opacity );
702 #ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
703 if ( d->textFont.stretch() > 0 )
704 textStyleElem.setAttribute( QStringLiteral(
"stretchFactor" ), d->textFont.stretch() );
708 textStyleElem.setAttribute( QStringLiteral(
"multilineHeight" ), d->multilineHeight );
709 textStyleElem.setAttribute( QStringLiteral(
"allowHtml" ), d->allowHtmlFormatting ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
710 textStyleElem.setAttribute( QStringLiteral(
"capitalization" ), QString::number(
static_cast< int >( d->capitalization ) ) );
712 QDomElement ddElem = doc.createElement( QStringLiteral(
"dd_properties" ) );
715 textStyleElem.appendChild( mBufferSettings.
writeXml( doc ) );
716 textStyleElem.appendChild( mMaskSettings.
writeXml( doc ) );
717 textStyleElem.appendChild( mBackgroundSettings.
writeXml( doc, context ) );
718 textStyleElem.appendChild( mShadowSettings.
writeXml( doc ) );
719 textStyleElem.appendChild( ddElem );
721 return textStyleElem;
728 QMimeData *mimeData =
new QMimeData;
729 mimeData->setColorData( QVariant(
color() ) );
732 QDomDocument textDoc;
733 QDomElement textElem =
writeXml( textDoc, rwContext );
734 textDoc.appendChild( textElem );
735 mimeData->setText( textDoc.toString() );
744 if (
font.pointSizeF() > 0 )
749 else if (
font.pixelSize() > 0 )
764 f.setPointSizeF(
size() );
768 f.setPointSizeF(
size() * 2.83464567 );
772 f.setPointSizeF(
size() * 72 );
776 f.setPixelSize(
static_cast< int >( std::round(
size() ) ) );
797 QString text = data->text();
798 if ( !text.isEmpty() )
804 if ( doc.setContent( text ) )
806 elem = doc.documentElement();
808 format.
readXml( elem, rwContext );
819 if ( d->blendMode != QPainter::CompositionMode_SourceOver )
822 if ( mBufferSettings.
enabled() && mBufferSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
825 if ( mBackgroundSettings.
enabled() && mBackgroundSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
828 if ( mShadowSettings.
enabled() && mShadowSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
837 return d->mDataDefinedProperties;
842 return d->mDataDefinedProperties;
847 QSet< QString > fields = d->mDataDefinedProperties.referencedFields( context.
expressionContext(),
true );
858 d->mDataDefinedProperties = collection;
864 if ( !d->mDataDefinedProperties.hasActiveProperties() )
867 QString ddFontFamily;
870 if ( !exprVal.isNull() )
872 QString family = exprVal.toString().trimmed();
873 if ( d->textFont.family() != family )
879 ddFontFamily = family;
888 if ( !exprVal.isNull() )
890 QString fontstyle = exprVal.toString().trimmed();
891 ddFontStyle = fontstyle;
901 bool ddItalic =
false;
911 QFontDatabase fontDb;
912 QFont appFont = QApplication::font();
913 bool newFontBuilt =
false;
914 if ( ddBold || ddItalic )
917 newFont = QFont( !ddFontFamily.isEmpty() ? ddFontFamily : d->textFont.family() );
919 newFont.setBold( ddBold );
920 newFont.setItalic( ddItalic );
922 else if ( !ddFontStyle.isEmpty()
923 && ddFontStyle.compare( QLatin1String(
"Ignore" ), Qt::CaseInsensitive ) != 0 )
925 if ( !ddFontFamily.isEmpty() )
928 QFont styledfont = fontDb.font( ddFontFamily, ddFontStyle, appFont.pointSize() );
929 if ( appFont != styledfont )
931 newFont = styledfont;
939 else if ( !ddFontFamily.isEmpty() )
941 if ( ddFontStyle.compare( QLatin1String(
"Ignore" ), Qt::CaseInsensitive ) != 0 )
944 QFont styledfont = fontDb.font( ddFontFamily, d->textNamedStyle, appFont.pointSize() );
945 if ( appFont != styledfont )
947 newFont = styledfont;
953 newFont = QFont( ddFontFamily );
961 newFont.setUnderline( d->textFont.underline() );
962 newFont.setStrikeOut( d->textFont.strikeOut() );
963 newFont.setWordSpacing( d->textFont.wordSpacing() );
964 newFont.setLetterSpacing( QFont::AbsoluteSpacing, d->textFont.letterSpacing() );
965 d->textFont = newFont;
993 if ( !exprVal.isNull() )
995 QString units = exprVal.toString();
996 if ( !units.isEmpty() )
1001 d->fontSizeUnits = res;
1009 if ( !val.isNull() )
1011 d->opacity = val.toDouble() / 100.0;
1015 #ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
1020 if ( !val.isNull() )
1022 d->textFont.setStretch( val.toInt() );
1038 if ( !val.isNull() )
1040 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, val.toDouble() );
1048 if ( !val.isNull() )
1050 d->textFont.setWordSpacing( val.toDouble() );
1057 QString blendstr = exprVal.toString().trimmed();
1058 if ( !blendstr.isEmpty() )
1071 QPixmap pixmap(
size );
1072 pixmap.fill( Qt::transparent );
1074 painter.begin( &pixmap );
1076 painter.setRenderHint( QPainter::Antialiasing );
1078 QRect rect( 0, 0,
size.width(),
size.height() );
1081 painter.setPen( Qt::NoPen );
1083 if ( ( background1.lightnessF() < 0.7 ) )
1085 background1 = background1.darker( 125 );
1089 background1 = background1.lighter( 125 );
1092 QLinearGradient linearGrad( QPointF( 0, 0 ), QPointF( 0, rect.height() ) );
1093 linearGrad.setColorAt( 0, background1 );
1094 linearGrad.setColorAt( 1, background2 );
1095 painter.setBrush( QBrush( linearGrad ) );
1096 if (
size.width() > 30 )
1098 painter.drawRoundedRect( rect, 6, 6 );
1103 painter.drawRect( rect );
1105 painter.setBrush( Qt::NoBrush );
1106 painter.setPen( Qt::NoPen );
1114 #if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
1115 const double logicalDpiX = QgsApplication::desktop()->logicalDpiX();
1117 QWidget *activeWindow = QApplication::activeWindow();
1118 const double logicalDpiX = activeWindow && activeWindow->screen() ? activeWindow->screen()->logicalDotsPerInchX() : 96.0;
1132 ? fontSize * tempFormat.
buffer().
size() / 100
1137 double ytrans = 0.0;
1140 ? fontSize * tempFormat.
buffer().
size() / 100
1145 const QStringList text = QStringList() << ( previewText.isEmpty() ? QObject::tr(
"Aa" ) : previewText );
1147 QRectF textRect = rect;
1148 textRect.setLeft( xtrans + padding );
1149 textRect.setWidth( rect.width() - xtrans - 2 * padding );
1151 if ( textRect.width() > 2000 )
1152 textRect.setWidth( 2000 - 2 * padding );
1154 const double bottom = textRect.height() / 2 + textHeight / 2;
1155 textRect.setTop( bottom - textHeight );
1156 textRect.setBottom( bottom );
1161 painter.setBrush( Qt::NoBrush );
1163 if (
size.width() > 30 )
1165 painter.drawRoundedRect( rect, 6, 6 );
1170 painter.drawRect( rect );
Capitalization
String capitalization options.
@ AllSmallCaps
Force all characters to small caps (since QGIS 3.24)
@ MixedCase
Mixed case, ie no change.
@ SmallCaps
Mixed case small caps (since QGIS 3.24)
@ Antialiasing
Use antialiasing while drawing.
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
static QString translateNamedStyle(const QString &namedStyle)
Returns the localized named style of a font, if such a translation is available.
static QString untranslateNamedStyle(const QString &namedStyle)
Returns the english named style of a font, if possible.
static bool fontFamilyMatchOnSystem(const QString &family, QString *chosen=nullptr, bool *match=nullptr)
Check whether font family is on system.
static bool fontFamilyOnSystem(const QString &family)
Check whether font family is on system in a quick manner, which does not compare [foundry].
static bool updateFontViaStyle(QFont &f, const QString &fontstyle, bool fallback=false)
Updates font with named style and retain all font properties.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
Perform transforms between map coordinates and device coordinates.
void setParameters(double mapUnitsPerPixel, double centerX, double centerY, int widthPixels, int heightPixels, double rotation)
Sets parameters for use in transforming coordinates.
Struct for storing maximum and minimum scales for measurements in map units.
static QgsPainting::BlendMode getBlendModeEnum(QPainter::CompositionMode blendMode)
Returns a BlendMode corresponding to a QPainter::CompositionMode.
static QPainter::CompositionMode getCompositionMode(QgsPainting::BlendMode blendMode)
Returns a QPainter::CompositionMode corresponding to a BlendMode.
BlendMode
Blending modes enum defining the available composition modes that can be used when rendering a layer.
@ Strikeout
Use strikeout.
@ FontStyle
Font style name.
@ Underline
Use underline.
@ FontLetterSpacing
Letter spacing.
@ FontStretchFactor
Font stretch factor, since QGIS 3.24.
@ FontSizeUnit
Font size units.
@ Italic
Use italic style.
@ FontWordSpacing
Word spacing.
@ FontBlendMode
Text blend mode.
@ FontOpacity
Text opacity.
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the labeling property definitions.
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
The class is used as a container of context for various read/write operations on other objects.
void pushMessage(const QString &message, Qgis::MessageLevel level=Qgis::MessageLevel::Warning) const
Append a message to the context.
Contains information about the context of a rendering operation.
void setScaleFactor(double factor)
Sets the scaling factor for the render to convert painter units to physical sizes.
void setUseAdvancedEffects(bool enabled)
Used to enable or disable advanced effects such as blend modes.
QgsExpressionContext & expressionContext()
Gets the expression context.
double convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
void setMapToPixel(const QgsMapToPixel &mtp)
Sets the context's map to pixel transform, which transforms between map coordinates and device coordi...
void setPainter(QPainter *p)
Sets the destination QPainter for the render operation.
static QString encodeMapUnitScale(const QgsMapUnitScale &mapUnitScale)
static QColor decodeColor(const QString &str)
static QgsMapUnitScale decodeMapUnitScale(const QString &str)
static QPainter::CompositionMode decodeBlendMode(const QString &s)
static QString encodeColor(const QColor &color)
Container for settings relating to a text background object.
QSizeF size() const
Returns the size of the background shape.
QSet< QString > referencedFields(const QgsRenderContext &context) const
Returns all field names referenced by the configuration (e.g.
void upgradeDataDefinedProperties(QgsPropertyCollection &properties)
Upgrade data defined properties when reading a project file saved in QGIS prior to version 3....
QPainter::CompositionMode blendMode() const
Returns the blending mode used for drawing the background shape.
bool enabled() const
Returns whether the background is enabled.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
void updateDataDefinedProperties(QgsRenderContext &context, const QgsPropertyCollection &properties)
Updates the format by evaluating current values of data defined properties.
SizeType sizeType() const
Returns the method used to determine the size of the background shape (e.g., fixed size or buffer aro...
QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Write settings into a DOM element.
void readFromLayer(QgsVectorLayer *layer)
Reads settings from a layer's custom properties (for QGIS 2.x projects).
QgsMapUnitScale sizeMapUnitScale() const
Returns the map unit scale object for the shape size.
QgsUnitTypes::RenderUnit sizeUnit() const
Returns the units used for the shape's size.
Container for settings relating to a text buffer.
void readFromLayer(QgsVectorLayer *layer)
Reads settings from a layer's custom properties (for QGIS 2.x projects).
QSet< QString > referencedFields(const QgsRenderContext &context) const
Returns all field names referenced by the configuration (e.g.
double size() const
Returns the size of the buffer.
QgsMapUnitScale sizeMapUnitScale() const
Returns the map unit scale object for the buffer size.
bool enabled() const
Returns whether the buffer is enabled.
QDomElement writeXml(QDomDocument &doc) const
Write settings into a DOM element.
QgsUnitTypes::RenderUnit sizeUnit() const
Returns the units for the buffer size.
QPainter::CompositionMode blendMode() const
Returns the blending mode used for drawing the buffer.
void updateDataDefinedProperties(QgsRenderContext &context, const QgsPropertyCollection &properties)
Updates the format by evaluating current values of data defined properties.
void readXml(const QDomElement &elem)
Read settings from a DOM element.
Container for all settings relating to text rendering.
QgsTextFormat()
Default constructor for QgsTextFormat.
void setColor(const QColor &color)
Sets the color that text will be rendered in.
void setBlendMode(QPainter::CompositionMode mode)
Sets the blending mode used for drawing the text.
void setSize(double size)
Sets the size for rendered text.
QgsMapUnitScale sizeMapUnitScale() const
Returns the map unit scale object for the size.
void setCapitalization(Qgis::Capitalization capitalization)
Sets the text capitalization style.
void setDataDefinedProperties(const QgsPropertyCollection &collection)
Sets the format's property collection, used for data defined overrides.
QStringList families() const
Returns the list of font families to use when restoring the text format, in order of precedence.
void setFont(const QFont &font)
Sets the font used for rendering text.
QSet< QString > referencedFields(const QgsRenderContext &context) const
Returns all field names referenced by the configuration (e.g.
void setFamilies(const QStringList &families)
Sets a list of font families to use for the text format, in order of precedence.
void setForcedItalic(bool forced)
Sets whether the format is set to force an italic style.
static QgsTextFormat fromMimeData(const QMimeData *data, bool *ok=nullptr)
Attempts to parse the provided mime data as a QgsTextFormat.
double lineHeight() const
Returns the line height for text.
QgsUnitTypes::RenderUnit sizeUnit() const
Returns the units for the size of rendered text.
int stretchFactor() const
Returns the text's stretch factor.
void setOrientation(TextOrientation orientation)
Sets the orientation for the text.
void updateDataDefinedProperties(QgsRenderContext &context)
Updates the format by evaluating current values of data defined properties.
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the format's property collection, used for data defined overrides.
void setStretchFactor(int factor)
Sets the text's stretch factor.
void setShadow(const QgsTextShadowSettings &shadowSettings)
Sets the text's drop shadow settings.
void setMask(const QgsTextMaskSettings &maskSettings)
Sets the text's masking settings.
void setPreviewBackgroundColor(const QColor &color)
Sets the background color that text will be rendered on for previews.
QFont scaledFont(const QgsRenderContext &context, double scaleFactor=1.0, bool *isZeroSize=nullptr) const
Returns a font with the size scaled to match the format's size settings (including units and map unit...
void setOpacity(double opacity)
Sets the text's opacity.
QPainter::CompositionMode blendMode() const
Returns the blending mode used for drawing the text.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
bool operator==(const QgsTextFormat &other) const
TextOrientation orientation() const
Returns the orientation of the text.
void setAllowHtmlFormatting(bool allow)
Sets whether text should be treated as a HTML document and HTML tags should be used for formatting th...
Qgis::Capitalization capitalization() const
Returns the text capitalization style.
bool forcedItalic() const
Returns true if the format is set to force an italic style.
QgsTextMaskSettings & mask()
Returns a reference to the masking settings.
static QPixmap textFormatPreviewPixmap(const QgsTextFormat &format, QSize size, const QString &previewText=QString(), int padding=0)
Returns a pixmap preview for a text format.
void setForcedBold(bool forced)
Sets whether the format is set to force a bold style.
bool isValid() const
Returns true if the format is valid.
void setBuffer(const QgsTextBufferSettings &bufferSettings)
Sets the text's buffer settings.
QgsTextBackgroundSettings & background()
Returns a reference to the text background settings.
TextOrientation
Text orientation.
static QgsTextFormat fromQFont(const QFont &font)
Returns a text format matching the settings from an input font.
void setValid()
Sets the format to a valid state, without changing any of the default format settings.
bool allowHtmlFormatting() const
Returns true if text should be treated as a HTML document and HTML tags should be used for formatting...
QFont toQFont() const
Returns a QFont matching the relevant settings from this text format.
void setSizeUnit(QgsUnitTypes::RenderUnit unit)
Sets the units for the size of rendered text.
bool operator!=(const QgsTextFormat &other) const
double opacity() const
Returns the text's opacity.
QString namedStyle() const
Returns the named style for the font used for rendering text (e.g., "bold").
double size() const
Returns the size for rendered text.
QgsTextShadowSettings & shadow()
Returns a reference to the text drop shadow settings.
QgsTextFormat & operator=(const QgsTextFormat &other)
bool forcedBold() const
Returns true if the format is set to force a bold style.
void setBackground(const QgsTextBackgroundSettings &backgroundSettings)
Sets the text's background settings.q.
QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Write settings into a DOM element.
QMimeData * toMimeData() const
Returns new mime data representing the text format settings.
void setSizeMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale object for the size.
void setNamedStyle(const QString &style)
Sets the named style for the font used for rendering text.
QColor color() const
Returns the color that text will be rendered in.
QFont font() const
Returns the font used for rendering text.
void readFromLayer(QgsVectorLayer *layer)
Reads settings from a layer's custom properties (for QGIS 2.x projects).
QColor previewBackgroundColor() const
Returns the background color for text previews.
bool containsAdvancedEffects() const
Returns true if any component of the font format requires advanced effects such as blend modes,...
QgsTextBufferSettings & buffer()
Returns a reference to the text buffer settings.
void setLineHeight(double height)
Sets the line height for text.
Container for settings relating to a selective masking around a text.
QSet< QString > referencedFields(const QgsRenderContext &context) const
Returns all field names referenced by the configuration (e.g.
void updateDataDefinedProperties(QgsRenderContext &context, const QgsPropertyCollection &properties)
Updates the format by evaluating current values of data defined properties.
void readXml(const QDomElement &elem)
Read settings from a DOM element.
QDomElement writeXml(QDomDocument &doc) const
Write settings into a DOM element.
static QString encodeTextOrientation(QgsTextFormat::TextOrientation orientation)
Encodes a text orientation.
static QColor readColor(QgsVectorLayer *layer, const QString &property, const QColor &defaultColor=Qt::black, bool withAlpha=true)
Converts an encoded color value from a layer property.
static QgsTextFormat::TextOrientation decodeTextOrientation(const QString &name, bool *ok=nullptr)
Attempts to decode a string representation of a text orientation.
static void drawText(const QRectF &rect, double rotation, HAlignment alignment, const QStringList &textLines, QgsRenderContext &context, const QgsTextFormat &format, bool drawAsOutlines=true, VAlignment vAlignment=AlignTop, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags())
Draws text within a rectangle using the specified settings.
@ AlignCenter
Center align.
static int sizeToPixel(double size, const QgsRenderContext &c, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &mapUnitScale=QgsMapUnitScale())
Calculates pixel size (considering output size should be in pixel or map units, scale factors and opt...
static double textHeight(const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, DrawMode mode=Point, QFontMetricsF *fontMetrics=nullptr, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags(), double maxLineWidth=0)
Returns the height of a text based on a given format.
@ Rect
Text within rectangle draw mode.
Container for settings relating to a text shadow.
bool enabled() const
Returns whether the shadow is enabled.
void readXml(const QDomElement &elem)
Read settings from a DOM element.
QDomElement writeXml(QDomDocument &doc) const
Write settings into a DOM element.
void updateDataDefinedProperties(QgsRenderContext &context, const QgsPropertyCollection &properties)
Updates the format by evaluating current values of data defined properties.
QPainter::CompositionMode blendMode() const
Returns the blending mode used for drawing the drop shadow.
QSet< QString > referencedFields(const QgsRenderContext &context) const
Returns all field names referenced by the configuration (e.g.
void readFromLayer(QgsVectorLayer *layer)
Reads settings from a layer's custom properties (for QGIS 2.x projects).
static Q_INVOKABLE QString encodeUnit(QgsUnitTypes::DistanceUnit unit)
Encodes a distance unit to a string.
static Q_INVOKABLE QgsUnitTypes::RenderUnit decodeRenderUnit(const QString &string, bool *ok=nullptr)
Decodes a render unit from a string.
RenderUnit
Rendering size units.
@ RenderUnknownUnit
Mixed or unknown units.
@ RenderMetersInMapUnits
Meters value as Map units.
@ RenderPercentage
Percentage of another measurement (e.g., canvas size, feature size)
@ RenderPoints
Points (e.g., for font sizes)
@ RenderMillimeters
Millimeters.
@ RenderMapUnits
Map units.
Represents a vector layer which manages a vector based data sets.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)