31#include <QFontDatabase>
38 d =
new QgsTextSettingsPrivate();
42 : mBufferSettings( other.mBufferSettings )
43 , mBackgroundSettings( other.mBackgroundSettings )
44 , mShadowSettings( other.mShadowSettings )
45 , mMaskSettings( other.mMaskSettings )
46 , mTextFontFamily( other.mTextFontFamily )
47 , mTextFontFound( other.mTextFontFound )
56 mBufferSettings = other.mBufferSettings;
57 mBackgroundSettings = other.mBackgroundSettings;
58 mShadowSettings = other.mShadowSettings;
59 mMaskSettings = other.mMaskSettings;
60 mTextFontFamily = other.mTextFontFamily;
61 mTextFontFound = other.mTextFontFound;
72 if ( d->isValid != other.
isValid()
73 || d->textFont != other.
font()
75 || d->fontSizeUnits != other.
sizeUnit()
77 || d->fontSize != other.
size()
78 || d->textColor != other.
color()
79 || d->opacity != other.
opacity()
89 || mBufferSettings != other.mBufferSettings
90 || mBackgroundSettings != other.mBackgroundSettings
91 || mShadowSettings != other.mShadowSettings
92 || mMaskSettings != other.mMaskSettings
102 return !( *
this == other );
118 return mBufferSettings;
124 mBufferSettings = bufferSettings;
130 return mBackgroundSettings;
136 mBackgroundSettings = backgroundSettings;
142 return mShadowSettings;
148 mShadowSettings = shadowSettings;
154 return mMaskSettings;
160 mMaskSettings = maskSettings;
173 QFont
font = d->textFont;
174 if ( scaleFactor == 1 )
177 d->fontSizeMapUnitScale );
178 if ( fontPixelSize == 0 )
185 font.setPixelSize( fontPixelSize );
189 double fontPixelSize = context.
convertToPainterUnits( d->fontSize, d->fontSizeUnits, d->fontSizeMapUnitScale );
196 const int roundedPixelSize =
static_cast< int >( std::round( scaleFactor * fontPixelSize + 0.5 ) );
197 font.setPixelSize( roundedPixelSize );
200 font.setLetterSpacing( QFont::AbsoluteSpacing, context.
convertToPainterUnits( d->textFont.letterSpacing(), d->fontSizeUnits, d->fontSizeMapUnitScale ) * scaleFactor );
201 font.setWordSpacing( context.
convertToPainterUnits( d->textFont.wordSpacing(), d->fontSizeUnits, d->fontSizeMapUnitScale ) * scaleFactor * scaleFactor );
205 font.setCapitalization( QFont::SmallCaps );
218 if ( !d->textNamedStyle.isEmpty() )
219 return d->textNamedStyle;
222 return db.styleString( d->textFont );
229 d->textNamedStyle = style;
234 return d->forcedBold;
240 d->textFont.setBold( forced );
241 d->forcedBold =
true;
246 return d->forcedItalic;
252 d->textFont.setItalic( forced );
253 d->forcedItalic =
true;
269 return d->fontSizeUnits;
275 d->fontSizeUnits = unit;
280 return d->fontSizeMapUnitScale;
286 d->fontSizeMapUnitScale = scale;
308 d->textColor =
color;
320 d->opacity *= opacityFactor;
335 return d->textFont.stretch() > 0 ? d->textFont.stretch() : 100;
341 d->textFont.setStretch( factor );
357 return d->multilineHeight;
363 d->multilineHeight = height;
368 return d->multilineHeightUnits;
374 d->multilineHeightUnits = unit;
379 return d->orientation;
393 : d->capitalization ;
400#if defined(HAS_KDE_QT5_SMALL_CAPS_FIX) || QT_VERSION >= QT_VERSION_CHECK(6, 3, 0)
403 d->textFont.setCapitalization( QFont::MixedCase );
409 return d->allowHtmlFormatting;
415 d->allowHtmlFormatting = allow;
420 return d->previewBackgroundColor;
426 d->previewBackgroundColor =
color;
432 QFont appFont = QApplication::font();
434 QString fontFamily = mTextFontFamily;
438 mTextFontFound =
false;
444 fontFamily = appFont.family();
448 mTextFontFound =
true;
453 d->fontSize = appFont.pointSizeF();
457 d->fontSize = layer->
customProperty( QStringLiteral(
"labeling/fontSize" ) ).toDouble();
460 if ( layer->
customProperty( QStringLiteral(
"labeling/fontSizeUnit" ) ).toString().isEmpty() )
462 d->fontSizeUnits = layer->
customProperty( QStringLiteral(
"labeling/fontSizeInMapUnits" ), QVariant(
false ) ).toBool() ?
472 if ( layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitScale" ) ).toString().isEmpty() )
475 double oldMin = layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitMinScale" ), 0.0 ).toDouble();
476 d->fontSizeMapUnitScale.minScale = oldMin != 0 ? 1.0 / oldMin : 0;
477 double oldMax = layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitMaxScale" ), 0.0 ).toDouble();
478 d->fontSizeMapUnitScale.maxScale = oldMax != 0 ? 1.0 / oldMax : 0;
484 int fontWeight = layer->
customProperty( QStringLiteral(
"labeling/fontWeight" ) ).toInt();
485 bool fontItalic = layer->
customProperty( QStringLiteral(
"labeling/fontItalic" ) ).toBool();
490 d->textFont.setUnderline( layer->
customProperty( QStringLiteral(
"labeling/fontUnderline" ) ).toBool() );
491 d->textFont.setStrikeOut( layer->
customProperty( QStringLiteral(
"labeling/fontStrikeout" ) ).toBool() );
492 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, layer->
customProperty( QStringLiteral(
"labeling/fontLetterSpacing" ), QVariant( 0.0 ) ).toDouble() );
493 d->textFont.setWordSpacing( layer->
customProperty( QStringLiteral(
"labeling/fontWordSpacing" ), QVariant( 0.0 ) ).toDouble() );
495 if ( layer->
customProperty( QStringLiteral(
"labeling/textOpacity" ) ).toString().isEmpty() )
497 d->opacity = ( 1 - layer->
customProperty( QStringLiteral(
"labeling/textTransp" ) ).toInt() / 100.0 );
501 d->opacity = ( layer->
customProperty( QStringLiteral(
"labeling/textOpacity" ) ).toDouble() );
505 d->multilineHeight = layer->
customProperty( QStringLiteral(
"labeling/multilineHeight" ), QVariant( 1.0 ) ).toDouble();
516 QDomElement textStyleElem;
517 if ( elem.nodeName() == QLatin1String(
"text-style" ) )
518 textStyleElem = elem;
520 textStyleElem = elem.firstChildElement( QStringLiteral(
"text-style" ) );
521 QFont appFont = QApplication::font();
523 QString fontFamily = mTextFontFamily;
525 const QDomElement familiesElem = textStyleElem.firstChildElement( QStringLiteral(
"families" ) );
526 const QDomNodeList familyNodes = familiesElem.childNodes();
528 families.reserve( familyNodes.size() );
529 for (
int i = 0; i < familyNodes.count(); ++i )
531 const QDomElement familyElem = familyNodes.at( i ).toElement();
532 families << familyElem.attribute( QStringLiteral(
"name" ) );
536 mTextFontFound =
false;
542 mTextFontFound =
true;
546 for (
const QString &family : std::as_const(
families ) )
552 mTextFontFound =
true;
553 fontFamily = processedFamily;
558 if ( !mTextFontFound )
561 fontFamily = appFont.family();
567 mTextFontFound =
true;
570 if ( !mTextFontFound )
572 context.
pushMessage( QObject::tr(
"Font “%1” not available on system" ).arg( mTextFontFamily ) );
575 if ( textStyleElem.hasAttribute( QStringLiteral(
"fontSize" ) ) )
577 d->fontSize = textStyleElem.attribute( QStringLiteral(
"fontSize" ) ).toDouble();
581 d->fontSize = appFont.pointSizeF();
584 if ( !textStyleElem.hasAttribute( QStringLiteral(
"fontSizeUnit" ) ) )
586 d->fontSizeUnits = textStyleElem.attribute( QStringLiteral(
"fontSizeInMapUnits" ) ).toUInt() == 0 ?
Qgis::RenderUnit::Points
594 if ( !textStyleElem.hasAttribute( QStringLiteral(
"fontSizeMapUnitScale" ) ) )
597 double oldMin = textStyleElem.attribute( QStringLiteral(
"fontSizeMapUnitMinScale" ), QStringLiteral(
"0" ) ).toDouble();
598 d->fontSizeMapUnitScale.minScale = oldMin != 0 ? 1.0 / oldMin : 0;
599 double oldMax = textStyleElem.attribute( QStringLiteral(
"fontSizeMapUnitMaxScale" ), QStringLiteral(
"0" ) ).toDouble();
600 d->fontSizeMapUnitScale.maxScale = oldMax != 0 ? 1.0 / oldMax : 0;
606 int fontWeight = textStyleElem.attribute( QStringLiteral(
"fontWeight" ) ).toInt();
607 bool fontItalic = textStyleElem.attribute( QStringLiteral(
"fontItalic" ) ).toInt();
609 d->textFont.setPointSizeF( d->fontSize );
612 d->forcedBold = textStyleElem.attribute( QStringLiteral(
"forcedBold" ) ).toInt();
613 d->forcedItalic = textStyleElem.attribute( QStringLiteral(
"forcedItalic" ) ).toInt();
614 d->textFont.setUnderline( textStyleElem.attribute( QStringLiteral(
"fontUnderline" ) ).toInt() );
615 d->textFont.setStrikeOut( textStyleElem.attribute( QStringLiteral(
"fontStrikeout" ) ).toInt() );
616 d->textFont.setKerning( textStyleElem.attribute( QStringLiteral(
"fontKerning" ), QStringLiteral(
"1" ) ).toInt() );
617 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, textStyleElem.attribute( QStringLiteral(
"fontLetterSpacing" ), QStringLiteral(
"0" ) ).toDouble() );
618 d->textFont.setWordSpacing( textStyleElem.attribute( QStringLiteral(
"fontWordSpacing" ), QStringLiteral(
"0" ) ).toDouble() );
620 if ( !textStyleElem.hasAttribute( QStringLiteral(
"textOpacity" ) ) )
622 d->opacity = ( 1 - textStyleElem.attribute( QStringLiteral(
"textTransp" ) ).toInt() / 100.0 );
626 d->opacity = ( textStyleElem.attribute( QStringLiteral(
"textOpacity" ) ).toDouble() );
628#ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
629 d->textFont.setStretch( textStyleElem.attribute( QStringLiteral(
"stretchFactor" ), QStringLiteral(
"100" ) ).toInt() );
637 if ( !textStyleElem.hasAttribute( QStringLiteral(
"multilineHeight" ) ) )
639 QDomElement textFormatElem = elem.firstChildElement( QStringLiteral(
"text-format" ) );
640 d->multilineHeight = textFormatElem.attribute( QStringLiteral(
"multilineHeight" ), QStringLiteral(
"1" ) ).toDouble();
644 d->multilineHeight = textStyleElem.attribute( QStringLiteral(
"multilineHeight" ), QStringLiteral(
"1" ) ).toDouble();
647 d->multilineHeightUnits =
QgsUnitTypes::decodeRenderUnit( textStyleElem.attribute( QStringLiteral(
"multilineHeightUnit" ), QStringLiteral(
"percent" ) ), &ok );
649 if ( textStyleElem.hasAttribute( QStringLiteral(
"capitalization" ) ) )
652 d->capitalization =
static_cast< Qgis::Capitalization >( textStyleElem.attribute( QStringLiteral(
"fontCapitals" ), QStringLiteral(
"0" ) ).toUInt() );
655 d->textFont.setCapitalization( QFont::SmallCaps );
657 d->allowHtmlFormatting = textStyleElem.attribute( QStringLiteral(
"allowHtml" ), QStringLiteral(
"0" ) ).toInt();
659 if ( textStyleElem.firstChildElement( QStringLiteral(
"text-buffer" ) ).isNull() )
661 mBufferSettings.
readXml( elem );
665 mBufferSettings.
readXml( textStyleElem );
667 if ( textStyleElem.firstChildElement( QStringLiteral(
"text-mask" ) ).isNull() )
673 mMaskSettings.
readXml( textStyleElem );
675 if ( textStyleElem.firstChildElement( QStringLiteral(
"shadow" ) ).isNull() )
677 mShadowSettings.
readXml( elem );
681 mShadowSettings.
readXml( textStyleElem );
683 if ( textStyleElem.firstChildElement( QStringLiteral(
"background" ) ).isNull() )
685 mBackgroundSettings.
readXml( elem, context );
689 mBackgroundSettings.
readXml( textStyleElem, context );
692 QDomElement ddElem = textStyleElem.firstChildElement( QStringLiteral(
"dd_properties" ) );
693 if ( ddElem.isNull() )
695 ddElem = elem.firstChildElement( QStringLiteral(
"dd_properties" ) );
697 if ( !ddElem.isNull() )
704 d->mDataDefinedProperties.clear();
711 QDomElement textStyleElem = doc.createElement( QStringLiteral(
"text-style" ) );
712 textStyleElem.setAttribute( QStringLiteral(
"fontFamily" ), d->textFont.family() );
714 QDomElement familiesElem = doc.createElement( QStringLiteral(
"families" ) );
715 for (
const QString &family : std::as_const( d->families ) )
717 QDomElement familyElem = doc.createElement( QStringLiteral(
"family" ) );
718 familyElem.setAttribute( QStringLiteral(
"name" ), family );
719 familiesElem.appendChild( familyElem );
721 textStyleElem.appendChild( familiesElem );
724 textStyleElem.setAttribute( QStringLiteral(
"fontSize" ), d->fontSize );
727 textStyleElem.setAttribute( QStringLiteral(
"fontWeight" ), d->textFont.weight() );
728 textStyleElem.setAttribute( QStringLiteral(
"fontItalic" ), d->textFont.italic() );
729 textStyleElem.setAttribute( QStringLiteral(
"fontStrikeout" ), d->textFont.strikeOut() );
730 textStyleElem.setAttribute( QStringLiteral(
"fontUnderline" ), d->textFont.underline() );
731 textStyleElem.setAttribute( QStringLiteral(
"forcedBold" ), d->forcedBold );
732 textStyleElem.setAttribute( QStringLiteral(
"forcedItalic" ), d->forcedItalic );
735 textStyleElem.setAttribute( QStringLiteral(
"fontLetterSpacing" ), d->textFont.letterSpacing() );
736 textStyleElem.setAttribute( QStringLiteral(
"fontWordSpacing" ), d->textFont.wordSpacing() );
737 textStyleElem.setAttribute( QStringLiteral(
"fontKerning" ), d->textFont.kerning() );
738 textStyleElem.setAttribute( QStringLiteral(
"textOpacity" ), d->opacity );
739#ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
740 if ( d->textFont.stretch() > 0 )
741 textStyleElem.setAttribute( QStringLiteral(
"stretchFactor" ), d->textFont.stretch() );
745 textStyleElem.setAttribute( QStringLiteral(
"multilineHeight" ), d->multilineHeight );
746 textStyleElem.setAttribute( QStringLiteral(
"multilineHeightUnit" ),
QgsUnitTypes::encodeUnit( d->multilineHeightUnits ) );
748 textStyleElem.setAttribute( QStringLiteral(
"allowHtml" ), d->allowHtmlFormatting ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
749 textStyleElem.setAttribute( QStringLiteral(
"capitalization" ), QString::number(
static_cast< int >( d->capitalization ) ) );
751 QDomElement ddElem = doc.createElement( QStringLiteral(
"dd_properties" ) );
754 textStyleElem.appendChild( mBufferSettings.
writeXml( doc ) );
755 textStyleElem.appendChild( mMaskSettings.
writeXml( doc ) );
756 textStyleElem.appendChild( mBackgroundSettings.
writeXml( doc, context ) );
757 textStyleElem.appendChild( mShadowSettings.
writeXml( doc ) );
758 textStyleElem.appendChild( ddElem );
760 return textStyleElem;
767 QMimeData *mimeData =
new QMimeData;
768 mimeData->setColorData( QVariant(
color() ) );
771 QDomDocument textDoc;
772 QDomElement textElem =
writeXml( textDoc, rwContext );
773 textDoc.appendChild( textElem );
774 mimeData->setText( textDoc.toString() );
783 if (
font.pointSizeF() > 0 )
788 else if (
font.pixelSize() > 0 )
803 f.setPointSizeF(
size() );
807 f.setPointSizeF(
size() * 2.83464567 );
811 f.setPointSizeF(
size() * 72 );
815 f.setPixelSize(
static_cast< int >( std::round(
size() ) ) );
836 QString text = data->text();
837 if ( !text.isEmpty() )
843 if ( doc.setContent( text ) )
845 elem = doc.documentElement();
847 format.
readXml( elem, rwContext );
858 if ( d->blendMode != QPainter::CompositionMode_SourceOver )
861 if ( mBufferSettings.
enabled() && mBufferSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
864 if ( mBackgroundSettings.
enabled() && mBackgroundSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
867 if ( mShadowSettings.
enabled() && mShadowSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
876 return d->mDataDefinedProperties;
881 return d->mDataDefinedProperties;
886 QSet< QString > fields = d->mDataDefinedProperties.referencedFields( context.
expressionContext(),
true );
897 d->mDataDefinedProperties = collection;
903 if ( !d->mDataDefinedProperties.hasActiveProperties() )
906 QString ddFontFamily;
911 QString family = exprVal.toString().trimmed();
913 if ( d->textFont.family() != family )
919 ddFontFamily = family;
930 QString fontstyle = exprVal.toString().trimmed();
931 ddFontStyle = fontstyle;
941 bool ddItalic =
false;
951 QFontDatabase fontDb;
952 QFont appFont = QApplication::font();
953 bool newFontBuilt =
false;
954 if ( ddBold || ddItalic )
959 newFont.setBold( ddBold );
960 newFont.setItalic( ddItalic );
962 else if ( !ddFontStyle.isEmpty()
963 && ddFontStyle.compare( QLatin1String(
"Ignore" ), Qt::CaseInsensitive ) != 0 )
965 if ( !ddFontFamily.isEmpty() )
968 QFont styledfont = fontDb.font( ddFontFamily, ddFontStyle, appFont.pointSize() );
969 if ( appFont != styledfont )
971 newFont = styledfont;
979 else if ( !ddFontFamily.isEmpty() )
981 if ( ddFontStyle.compare( QLatin1String(
"Ignore" ), Qt::CaseInsensitive ) != 0 )
984 QFont styledfont = fontDb.font( ddFontFamily, d->textNamedStyle, appFont.pointSize() );
985 if ( appFont != styledfont )
987 newFont = styledfont;
1001 newFont.setUnderline( d->textFont.underline() );
1002 newFont.setStrikeOut( d->textFont.strikeOut() );
1003 newFont.setWordSpacing( d->textFont.wordSpacing() );
1004 newFont.setLetterSpacing( QFont::AbsoluteSpacing, d->textFont.letterSpacing() );
1005 d->textFont = newFont;
1035 QString units = exprVal.toString();
1036 if ( !units.isEmpty() )
1041 d->fontSizeUnits = res;
1051 d->opacity = val.toDouble() / 100.0;
1055#ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
1062 d->textFont.setStretch( val.toInt() );
1080 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, val.toDouble() );
1090 d->textFont.setWordSpacing( val.toDouble() );
1097 QString blendstr = exprVal.toString().trimmed();
1098 if ( !blendstr.isEmpty() )
1112 QPixmap pixmap(
size * devicePixelRatio );
1113 pixmap.fill( Qt::transparent );
1114 pixmap.setDevicePixelRatio( devicePixelRatio );
1117 painter.begin( &pixmap );
1119 painter.setRenderHint( QPainter::Antialiasing );
1121 const QRectF rect( 0, 0,
size.width(),
size.height() );
1124 painter.setPen( Qt::NoPen );
1126 if ( ( background1.lightnessF() < 0.7 ) )
1128 background1 = background1.darker( 125 );
1132 background1 = background1.lighter( 125 );
1135 QLinearGradient linearGrad( QPointF( 0, 0 ), QPointF( 0, rect.height() ) );
1136 linearGrad.setColorAt( 0, background1 );
1137 linearGrad.setColorAt( 1, background2 );
1138 painter.setBrush( QBrush( linearGrad ) );
1139 if (
size.width() > 30 )
1141 painter.drawRoundedRect( rect, 6, 6 );
1146 painter.drawRect( rect );
1148 painter.setBrush( Qt::NoBrush );
1149 painter.setPen( Qt::NoPen );
1163 QWidget *activeWindow = QApplication::activeWindow();
1164 if ( QScreen *screen = activeWindow ? activeWindow->screen() : nullptr )
1186 ? fontSize * tempFormat.
buffer().
size() / 100
1191 double ytrans = 0.0;
1194 ? fontSize * tempFormat.
buffer().
size() / 100
1199 const QStringList text = QStringList() << ( previewText.isEmpty() ? QObject::tr(
"Aa" ) : previewText );
1201 QRectF textRect = rect;
1202 textRect.setLeft( xtrans + padding );
1203 textRect.setWidth( rect.width() - xtrans - 2 * padding );
1205 if ( textRect.width() > 2000 )
1206 textRect.setWidth( 2000 - 2 * padding );
1208 const double bottom = textRect.height() / 2 + textHeight / 2;
1209 textRect.setTop( bottom - textHeight );
1210 textRect.setBottom( bottom );
1215 painter.setBrush( Qt::NoBrush );
1217 if (
size.width() > 30 )
1219 painter.drawRoundedRect( rect, 6, 6 );
1224 painter.drawRect( rect );
1237 css += QStringLiteral(
"line-height: %1%;" ).arg(
lineHeight() * 100 );
1240 css += QStringLiteral(
"line-height: %1px;" ).arg(
lineHeight() );
1244 css += QStringLiteral(
"line-height: %1px;" ).arg(
lineHeight() * pointToPixelMultiplier );
1248 css += QStringLiteral(
"line-height: %1px;" ).arg(
lineHeight() * 2.83464567 * pointToPixelMultiplier );
1256 css += QStringLiteral(
"color: rgba(%1,%2,%3,%4);" ).arg(
color().red() ).arg(
color().green() ).arg(
color().blue() ).arg( QString::number(
color().alphaF(),
'f', 4 ) );
1260 f.setPointSizeF(
size() / 0.352778 );
@ Rectangle
Text within rectangle layout mode.
BlendMode
Blending modes defining the available composition modes that can be used when painting.
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)
TextOrientation
Text orientations.
RenderUnit
Rendering size units.
@ Percentage
Percentage of another measurement (e.g., canvas size, feature size)
@ Millimeters
Millimeters.
@ Points
Points (e.g., for font sizes)
@ Unknown
Mixed or unknown units.
@ MetersInMapUnits
Meters value as Map units.
@ Antialiasing
Use antialiasing while drawing.
static QgsFontManager * fontManager()
Returns the application font manager, which manages available fonts and font installation for the QGI...
static QColor colorFromString(const QString &string)
Decodes a string into a color value.
static QString colorToString(const QColor &color)
Encodes a color into a string value.
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
QString processFontFamilyName(const QString &name) const
Processes a font family name, applying any matching fontFamilyReplacements() to the name.
static QString asCSS(const QFont &font, double pointToPixelMultiplier=1.0)
Returns a CSS string representing the specified font as closely as possible.
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 QFont createFont(const QString &family, int pointSize=-1, int weight=-1, bool italic=false)
Creates a font with the specified family.
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 Qgis::BlendMode getBlendModeEnum(QPainter::CompositionMode blendMode)
Returns a Qgis::BlendMode corresponding to a QPainter::CompositionMode.
static QPainter::CompositionMode getCompositionMode(Qgis::BlendMode blendMode)
Returns a QPainter::CompositionMode corresponding to a Qgis::BlendMode.
@ FontSizeUnit
Font size units.
@ FontStyle
Font style name.
@ Italic
Use italic style.
@ FontStretchFactor
Font stretch factor, since QGIS 3.24.
@ Strikeout
Use strikeout.
@ Underline
Use underline.
@ FontBlendMode
Text blend mode.
@ FontOpacity
Text opacity.
@ FontWordSpacing
Word spacing.
@ FontLetterSpacing
Letter spacing.
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 setDevicePixelRatio(float ratio)
Sets the device pixel ratio.
void setUseAdvancedEffects(bool enabled)
Used to enable or disable advanced effects such as blend modes.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
QgsExpressionContext & expressionContext()
Gets the expression context.
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.
Stores properties relating to a screen.
double devicePixelRatio() const
Returns the ratio between physical pixels and device-independent pixels for the screen.
bool isValid() const
Returns true if the properties are valid.
void updateRenderContextForScreen(QgsRenderContext &context) const
Updates the settings in a render context to match the screen settings.
static QString encodeMapUnitScale(const QgsMapUnitScale &mapUnitScale)
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....
void setOpacity(double opacity)
Sets the background shape's opacity.
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.
double opacity() const
Returns the background shape's opacity.
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.
Qgis::RenderUnit sizeUnit() const
Returns the units used for the shape's size.
Container for settings relating to a text buffer.
Qgis::RenderUnit sizeUnit() const
Returns the units for the buffer size.
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.
void setOpacity(double opacity)
Sets the buffer opacity.
QgsMapUnitScale sizeMapUnitScale() const
Returns the map unit scale object for the buffer size.
bool enabled() const
Returns whether the buffer is enabled.
double opacity() const
Returns the buffer opacity.
QDomElement writeXml(QDomDocument &doc) const
Write settings into a DOM element.
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 setOrientation(Qgis::TextOrientation orientation)
Sets the orientation for the text.
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.
void setSizeUnit(Qgis::RenderUnit unit)
Sets the units for the size of rendered text.
int stretchFactor() const
Returns the text's stretch factor.
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 multiplyOpacity(double opacityFactor)
Multiply opacity by opacityFactor.
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
void setAllowHtmlFormatting(bool allow)
Sets whether text should be treated as a HTML document and HTML tags should be used for formatting th...
void setLineHeightUnit(Qgis::RenderUnit unit)
Sets the unit for the line height for text.
Qgis::RenderUnit lineHeightUnit() const
Returns the units for the line height for text.
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.
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.
Qgis::RenderUnit sizeUnit() const
Returns the units for the size of rendered text.
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.
bool operator!=(const QgsTextFormat &other) const
double opacity() const
Returns the text's opacity.
Qgis::TextOrientation orientation() const
Returns the orientation of the text.
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)
static QPixmap textFormatPreviewPixmap(const QgsTextFormat &format, QSize size, const QString &previewText=QString(), int padding=0, const QgsScreenProperties &screen=QgsScreenProperties())
Returns a pixmap preview for a text format.
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.
QString asCSS(double pointToPixelMultiplier=1.0) const
Returns a CSS string representing the specified text format as closely as possible.
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.
double opacity() const
Returns the mask's opacity.
void setOpacity(double opacity)
Sets the mask's opacity.
static Qgis::TextOrientation decodeTextOrientation(const QString &name, bool *ok=nullptr)
Attempts to decode a string representation of 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 QString encodeTextOrientation(Qgis::TextOrientation orientation)
Encodes a text orientation.
static int sizeToPixel(double size, const QgsRenderContext &c, Qgis::RenderUnit unit, const QgsMapUnitScale &mapUnitScale=QgsMapUnitScale())
Calculates pixel size (considering output size should be in pixel or map units, scale factors and opt...
static void drawText(const QRectF &rect, double rotation, Qgis::TextHorizontalAlignment alignment, const QStringList &textLines, QgsRenderContext &context, const QgsTextFormat &format, bool drawAsOutlines=true, Qgis::TextVerticalAlignment vAlignment=Qgis::TextVerticalAlignment::Top, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags(), Qgis::TextLayoutMode mode=Qgis::TextLayoutMode::Rectangle)
Draws text within a rectangle using the specified settings.
static double textHeight(const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, Qgis::TextLayoutMode mode=Qgis::TextLayoutMode::Point, QFontMetricsF *fontMetrics=nullptr, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags(), double maxLineWidth=0)
Returns the height of a text based on a given format.
Container for settings relating to a text shadow.
bool enabled() const
Returns whether the shadow is enabled.
double opacity() const
Returns the shadow's opacity.
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.
void setOpacity(double opacity)
Sets the shadow's opacity.
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 Qgis::RenderUnit decodeRenderUnit(const QString &string, bool *ok=nullptr)
Decodes a render unit from a string.
static Q_INVOKABLE QString encodeUnit(Qgis::DistanceUnit unit)
Encodes a distance unit to a string.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
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)