30#include <QFontDatabase>
37 d =
new QgsTextSettingsPrivate();
41 : mBufferSettings( other.mBufferSettings )
42 , mBackgroundSettings( other.mBackgroundSettings )
43 , mShadowSettings( other.mShadowSettings )
44 , mMaskSettings( other.mMaskSettings )
45 , mTextFontFamily( other.mTextFontFamily )
46 , mTextFontFound( other.mTextFontFound )
55 mBufferSettings = other.mBufferSettings;
56 mBackgroundSettings = other.mBackgroundSettings;
57 mShadowSettings = other.mShadowSettings;
58 mMaskSettings = other.mMaskSettings;
59 mTextFontFamily = other.mTextFontFamily;
60 mTextFontFound = other.mTextFontFound;
71 if ( d->isValid != other.
isValid()
72 || d->textFont != other.
font()
74 || d->fontSizeUnits != other.
sizeUnit()
76 || d->fontSize != other.
size()
77 || d->textColor != other.
color()
78 || d->opacity != other.
opacity()
88 || mBufferSettings != other.mBufferSettings
89 || mBackgroundSettings != other.mBackgroundSettings
90 || mShadowSettings != other.mShadowSettings
91 || mMaskSettings != other.mMaskSettings
101 return !( *
this == other );
117 return mBufferSettings;
123 mBufferSettings = bufferSettings;
129 return mBackgroundSettings;
135 mBackgroundSettings = backgroundSettings;
141 return mShadowSettings;
147 mShadowSettings = shadowSettings;
153 return mMaskSettings;
159 mMaskSettings = maskSettings;
172 QFont
font = d->textFont;
173 if ( scaleFactor == 1 )
176 d->fontSizeMapUnitScale );
177 if ( fontPixelSize == 0 )
184 font.setPixelSize( fontPixelSize );
188 double fontPixelSize = context.
convertToPainterUnits( d->fontSize, d->fontSizeUnits, d->fontSizeMapUnitScale );
195 const int roundedPixelSize =
static_cast< int >( std::round( scaleFactor * fontPixelSize + 0.5 ) );
196 font.setPixelSize( roundedPixelSize );
199 font.setLetterSpacing( QFont::AbsoluteSpacing, context.
convertToPainterUnits( d->textFont.letterSpacing(), d->fontSizeUnits, d->fontSizeMapUnitScale ) * scaleFactor );
200 font.setWordSpacing( context.
convertToPainterUnits( d->textFont.wordSpacing(), d->fontSizeUnits, d->fontSizeMapUnitScale ) * scaleFactor * scaleFactor );
204 font.setCapitalization( QFont::SmallCaps );
217 if ( !d->textNamedStyle.isEmpty() )
218 return d->textNamedStyle;
221 return db.styleString( d->textFont );
228 d->textNamedStyle = style;
233 return d->forcedBold;
239 d->textFont.setBold( forced );
240 d->forcedBold =
true;
245 return d->forcedItalic;
251 d->textFont.setItalic( forced );
252 d->forcedItalic =
true;
268 return d->fontSizeUnits;
274 d->fontSizeUnits = unit;
279 return d->fontSizeMapUnitScale;
285 d->fontSizeMapUnitScale = scale;
307 d->textColor =
color;
319 d->opacity *= opacityFactor;
334 return d->textFont.stretch() > 0 ? d->textFont.stretch() : 100;
340 d->textFont.setStretch( factor );
356 return d->multilineHeight;
362 d->multilineHeight = height;
367 return d->multilineHeightUnits;
373 d->multilineHeightUnits = unit;
378 return d->orientation;
392 : d->capitalization ;
399#if defined(HAS_KDE_QT5_SMALL_CAPS_FIX) || QT_VERSION >= QT_VERSION_CHECK(6, 3, 0)
402 d->textFont.setCapitalization( QFont::MixedCase );
408 return d->allowHtmlFormatting;
414 d->allowHtmlFormatting = allow;
419 return d->previewBackgroundColor;
425 d->previewBackgroundColor =
color;
431 QFont appFont = QApplication::font();
433 QString fontFamily = mTextFontFamily;
437 mTextFontFound =
false;
443 fontFamily = appFont.family();
447 mTextFontFound =
true;
452 d->fontSize = appFont.pointSizeF();
456 d->fontSize = layer->
customProperty( QStringLiteral(
"labeling/fontSize" ) ).toDouble();
459 if ( layer->
customProperty( QStringLiteral(
"labeling/fontSizeUnit" ) ).toString().isEmpty() )
461 d->fontSizeUnits = layer->
customProperty( QStringLiteral(
"labeling/fontSizeInMapUnits" ), QVariant(
false ) ).toBool() ?
471 if ( layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitScale" ) ).toString().isEmpty() )
474 double oldMin = layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitMinScale" ), 0.0 ).toDouble();
475 d->fontSizeMapUnitScale.minScale = oldMin != 0 ? 1.0 / oldMin : 0;
476 double oldMax = layer->
customProperty( QStringLiteral(
"labeling/fontSizeMapUnitMaxScale" ), 0.0 ).toDouble();
477 d->fontSizeMapUnitScale.maxScale = oldMax != 0 ? 1.0 / oldMax : 0;
483 int fontWeight = layer->
customProperty( QStringLiteral(
"labeling/fontWeight" ) ).toInt();
484 bool fontItalic = layer->
customProperty( QStringLiteral(
"labeling/fontItalic" ) ).toBool();
489 d->textFont.setUnderline( layer->
customProperty( QStringLiteral(
"labeling/fontUnderline" ) ).toBool() );
490 d->textFont.setStrikeOut( layer->
customProperty( QStringLiteral(
"labeling/fontStrikeout" ) ).toBool() );
491 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, layer->
customProperty( QStringLiteral(
"labeling/fontLetterSpacing" ), QVariant( 0.0 ) ).toDouble() );
492 d->textFont.setWordSpacing( layer->
customProperty( QStringLiteral(
"labeling/fontWordSpacing" ), QVariant( 0.0 ) ).toDouble() );
494 if ( layer->
customProperty( QStringLiteral(
"labeling/textOpacity" ) ).toString().isEmpty() )
496 d->opacity = ( 1 - layer->
customProperty( QStringLiteral(
"labeling/textTransp" ) ).toInt() / 100.0 );
500 d->opacity = ( layer->
customProperty( QStringLiteral(
"labeling/textOpacity" ) ).toDouble() );
504 d->multilineHeight = layer->
customProperty( QStringLiteral(
"labeling/multilineHeight" ), QVariant( 1.0 ) ).toDouble();
515 QDomElement textStyleElem;
516 if ( elem.nodeName() == QLatin1String(
"text-style" ) )
517 textStyleElem = elem;
519 textStyleElem = elem.firstChildElement( QStringLiteral(
"text-style" ) );
520 QFont appFont = QApplication::font();
522 QString fontFamily = mTextFontFamily;
524 const QDomElement familiesElem = textStyleElem.firstChildElement( QStringLiteral(
"families" ) );
525 const QDomNodeList familyNodes = familiesElem.childNodes();
527 families.reserve( familyNodes.size() );
528 for (
int i = 0; i < familyNodes.count(); ++i )
530 const QDomElement familyElem = familyNodes.at( i ).toElement();
531 families << familyElem.attribute( QStringLiteral(
"name" ) );
535 mTextFontFound =
false;
541 mTextFontFound =
true;
545 for (
const QString &family : std::as_const(
families ) )
551 mTextFontFound =
true;
552 fontFamily = processedFamily;
557 if ( !mTextFontFound )
560 fontFamily = appFont.family();
566 mTextFontFound =
true;
569 if ( !mTextFontFound )
571 context.
pushMessage( QObject::tr(
"Font “%1” not available on system" ).arg( mTextFontFamily ) );
574 if ( textStyleElem.hasAttribute( QStringLiteral(
"fontSize" ) ) )
576 d->fontSize = textStyleElem.attribute( QStringLiteral(
"fontSize" ) ).toDouble();
580 d->fontSize = appFont.pointSizeF();
583 if ( !textStyleElem.hasAttribute( QStringLiteral(
"fontSizeUnit" ) ) )
585 d->fontSizeUnits = textStyleElem.attribute( QStringLiteral(
"fontSizeInMapUnits" ) ).toUInt() == 0 ?
Qgis::RenderUnit::Points
593 if ( !textStyleElem.hasAttribute( QStringLiteral(
"fontSizeMapUnitScale" ) ) )
596 double oldMin = textStyleElem.attribute( QStringLiteral(
"fontSizeMapUnitMinScale" ), QStringLiteral(
"0" ) ).toDouble();
597 d->fontSizeMapUnitScale.minScale = oldMin != 0 ? 1.0 / oldMin : 0;
598 double oldMax = textStyleElem.attribute( QStringLiteral(
"fontSizeMapUnitMaxScale" ), QStringLiteral(
"0" ) ).toDouble();
599 d->fontSizeMapUnitScale.maxScale = oldMax != 0 ? 1.0 / oldMax : 0;
605 int fontWeight = textStyleElem.attribute( QStringLiteral(
"fontWeight" ) ).toInt();
606 bool fontItalic = textStyleElem.attribute( QStringLiteral(
"fontItalic" ) ).toInt();
608 d->textFont.setPointSizeF( d->fontSize );
611 d->forcedBold = textStyleElem.attribute( QStringLiteral(
"forcedBold" ) ).toInt();
612 d->forcedItalic = textStyleElem.attribute( QStringLiteral(
"forcedItalic" ) ).toInt();
613 d->textFont.setUnderline( textStyleElem.attribute( QStringLiteral(
"fontUnderline" ) ).toInt() );
614 d->textFont.setStrikeOut( textStyleElem.attribute( QStringLiteral(
"fontStrikeout" ) ).toInt() );
615 d->textFont.setKerning( textStyleElem.attribute( QStringLiteral(
"fontKerning" ), QStringLiteral(
"1" ) ).toInt() );
616 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, textStyleElem.attribute( QStringLiteral(
"fontLetterSpacing" ), QStringLiteral(
"0" ) ).toDouble() );
617 d->textFont.setWordSpacing( textStyleElem.attribute( QStringLiteral(
"fontWordSpacing" ), QStringLiteral(
"0" ) ).toDouble() );
619 if ( !textStyleElem.hasAttribute( QStringLiteral(
"textOpacity" ) ) )
621 d->opacity = ( 1 - textStyleElem.attribute( QStringLiteral(
"textTransp" ) ).toInt() / 100.0 );
625 d->opacity = ( textStyleElem.attribute( QStringLiteral(
"textOpacity" ) ).toDouble() );
627#ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
628 d->textFont.setStretch( textStyleElem.attribute( QStringLiteral(
"stretchFactor" ), QStringLiteral(
"100" ) ).toInt() );
636 if ( !textStyleElem.hasAttribute( QStringLiteral(
"multilineHeight" ) ) )
638 QDomElement textFormatElem = elem.firstChildElement( QStringLiteral(
"text-format" ) );
639 d->multilineHeight = textFormatElem.attribute( QStringLiteral(
"multilineHeight" ), QStringLiteral(
"1" ) ).toDouble();
643 d->multilineHeight = textStyleElem.attribute( QStringLiteral(
"multilineHeight" ), QStringLiteral(
"1" ) ).toDouble();
646 d->multilineHeightUnits =
QgsUnitTypes::decodeRenderUnit( textStyleElem.attribute( QStringLiteral(
"multilineHeightUnit" ), QStringLiteral(
"percent" ) ), &ok );
648 if ( textStyleElem.hasAttribute( QStringLiteral(
"capitalization" ) ) )
651 d->capitalization =
static_cast< Qgis::Capitalization >( textStyleElem.attribute( QStringLiteral(
"fontCapitals" ), QStringLiteral(
"0" ) ).toUInt() );
654 d->textFont.setCapitalization( QFont::SmallCaps );
656 d->allowHtmlFormatting = textStyleElem.attribute( QStringLiteral(
"allowHtml" ), QStringLiteral(
"0" ) ).toInt();
658 if ( textStyleElem.firstChildElement( QStringLiteral(
"text-buffer" ) ).isNull() )
660 mBufferSettings.
readXml( elem );
664 mBufferSettings.
readXml( textStyleElem );
666 if ( textStyleElem.firstChildElement( QStringLiteral(
"text-mask" ) ).isNull() )
672 mMaskSettings.
readXml( textStyleElem );
674 if ( textStyleElem.firstChildElement( QStringLiteral(
"shadow" ) ).isNull() )
676 mShadowSettings.
readXml( elem );
680 mShadowSettings.
readXml( textStyleElem );
682 if ( textStyleElem.firstChildElement( QStringLiteral(
"background" ) ).isNull() )
684 mBackgroundSettings.
readXml( elem, context );
688 mBackgroundSettings.
readXml( textStyleElem, context );
691 QDomElement ddElem = textStyleElem.firstChildElement( QStringLiteral(
"dd_properties" ) );
692 if ( ddElem.isNull() )
694 ddElem = elem.firstChildElement( QStringLiteral(
"dd_properties" ) );
696 if ( !ddElem.isNull() )
703 d->mDataDefinedProperties.clear();
710 QDomElement textStyleElem = doc.createElement( QStringLiteral(
"text-style" ) );
711 textStyleElem.setAttribute( QStringLiteral(
"fontFamily" ), d->textFont.family() );
713 QDomElement familiesElem = doc.createElement( QStringLiteral(
"families" ) );
714 for (
const QString &family : std::as_const( d->families ) )
716 QDomElement familyElem = doc.createElement( QStringLiteral(
"family" ) );
717 familyElem.setAttribute( QStringLiteral(
"name" ), family );
718 familiesElem.appendChild( familyElem );
720 textStyleElem.appendChild( familiesElem );
723 textStyleElem.setAttribute( QStringLiteral(
"fontSize" ), d->fontSize );
726 textStyleElem.setAttribute( QStringLiteral(
"fontWeight" ), d->textFont.weight() );
727 textStyleElem.setAttribute( QStringLiteral(
"fontItalic" ), d->textFont.italic() );
728 textStyleElem.setAttribute( QStringLiteral(
"fontStrikeout" ), d->textFont.strikeOut() );
729 textStyleElem.setAttribute( QStringLiteral(
"fontUnderline" ), d->textFont.underline() );
730 textStyleElem.setAttribute( QStringLiteral(
"forcedBold" ), d->forcedBold );
731 textStyleElem.setAttribute( QStringLiteral(
"forcedItalic" ), d->forcedItalic );
734 textStyleElem.setAttribute( QStringLiteral(
"fontLetterSpacing" ), d->textFont.letterSpacing() );
735 textStyleElem.setAttribute( QStringLiteral(
"fontWordSpacing" ), d->textFont.wordSpacing() );
736 textStyleElem.setAttribute( QStringLiteral(
"fontKerning" ), d->textFont.kerning() );
737 textStyleElem.setAttribute( QStringLiteral(
"textOpacity" ), d->opacity );
738#ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
739 if ( d->textFont.stretch() > 0 )
740 textStyleElem.setAttribute( QStringLiteral(
"stretchFactor" ), d->textFont.stretch() );
744 textStyleElem.setAttribute( QStringLiteral(
"multilineHeight" ), d->multilineHeight );
745 textStyleElem.setAttribute( QStringLiteral(
"multilineHeightUnit" ),
QgsUnitTypes::encodeUnit( d->multilineHeightUnits ) );
747 textStyleElem.setAttribute( QStringLiteral(
"allowHtml" ), d->allowHtmlFormatting ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
748 textStyleElem.setAttribute( QStringLiteral(
"capitalization" ), QString::number(
static_cast< int >( d->capitalization ) ) );
750 QDomElement ddElem = doc.createElement( QStringLiteral(
"dd_properties" ) );
753 textStyleElem.appendChild( mBufferSettings.
writeXml( doc ) );
754 textStyleElem.appendChild( mMaskSettings.
writeXml( doc ) );
755 textStyleElem.appendChild( mBackgroundSettings.
writeXml( doc, context ) );
756 textStyleElem.appendChild( mShadowSettings.
writeXml( doc ) );
757 textStyleElem.appendChild( ddElem );
759 return textStyleElem;
766 QMimeData *mimeData =
new QMimeData;
767 mimeData->setColorData( QVariant(
color() ) );
770 QDomDocument textDoc;
771 QDomElement textElem =
writeXml( textDoc, rwContext );
772 textDoc.appendChild( textElem );
773 mimeData->setText( textDoc.toString() );
782 if (
font.pointSizeF() > 0 )
787 else if (
font.pixelSize() > 0 )
802 f.setPointSizeF(
size() );
806 f.setPointSizeF(
size() * 2.83464567 );
810 f.setPointSizeF(
size() * 72 );
814 f.setPixelSize(
static_cast< int >( std::round(
size() ) ) );
835 QString text = data->text();
836 if ( !text.isEmpty() )
842 if ( doc.setContent( text ) )
844 elem = doc.documentElement();
846 format.
readXml( elem, rwContext );
857 if ( d->blendMode != QPainter::CompositionMode_SourceOver )
860 if ( mBufferSettings.
enabled() && mBufferSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
863 if ( mBackgroundSettings.
enabled() && mBackgroundSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
866 if ( mShadowSettings.
enabled() && mShadowSettings.
blendMode() != QPainter::CompositionMode_SourceOver )
875 return d->mDataDefinedProperties;
880 return d->mDataDefinedProperties;
885 QSet< QString > fields = d->mDataDefinedProperties.referencedFields( context.
expressionContext(),
true );
896 d->mDataDefinedProperties = collection;
902 if ( !d->mDataDefinedProperties.hasActiveProperties() )
905 QString ddFontFamily;
910 QString family = exprVal.toString().trimmed();
912 if ( d->textFont.family() != family )
918 ddFontFamily = family;
929 QString fontstyle = exprVal.toString().trimmed();
930 ddFontStyle = fontstyle;
940 bool ddItalic =
false;
950 QFontDatabase fontDb;
951 QFont appFont = QApplication::font();
952 bool newFontBuilt =
false;
953 if ( ddBold || ddItalic )
958 newFont.setBold( ddBold );
959 newFont.setItalic( ddItalic );
961 else if ( !ddFontStyle.isEmpty()
962 && ddFontStyle.compare( QLatin1String(
"Ignore" ), Qt::CaseInsensitive ) != 0 )
964 if ( !ddFontFamily.isEmpty() )
967 QFont styledfont = fontDb.font( ddFontFamily, ddFontStyle, appFont.pointSize() );
968 if ( appFont != styledfont )
970 newFont = styledfont;
978 else if ( !ddFontFamily.isEmpty() )
980 if ( ddFontStyle.compare( QLatin1String(
"Ignore" ), Qt::CaseInsensitive ) != 0 )
983 QFont styledfont = fontDb.font( ddFontFamily, d->textNamedStyle, appFont.pointSize() );
984 if ( appFont != styledfont )
986 newFont = styledfont;
1000 newFont.setUnderline( d->textFont.underline() );
1001 newFont.setStrikeOut( d->textFont.strikeOut() );
1002 newFont.setWordSpacing( d->textFont.wordSpacing() );
1003 newFont.setLetterSpacing( QFont::AbsoluteSpacing, d->textFont.letterSpacing() );
1004 d->textFont = newFont;
1034 QString units = exprVal.toString();
1035 if ( !units.isEmpty() )
1040 d->fontSizeUnits = res;
1050 d->opacity = val.toDouble() / 100.0;
1054#ifdef HAS_KDE_QT5_FONT_STRETCH_FIX
1061 d->textFont.setStretch( val.toInt() );
1079 d->textFont.setLetterSpacing( QFont::AbsoluteSpacing, val.toDouble() );
1089 d->textFont.setWordSpacing( val.toDouble() );
1096 QString blendstr = exprVal.toString().trimmed();
1097 if ( !blendstr.isEmpty() )
1111 QPixmap pixmap(
size * devicePixelRatio );
1112 pixmap.fill( Qt::transparent );
1113 pixmap.setDevicePixelRatio( devicePixelRatio );
1116 painter.begin( &pixmap );
1118 painter.setRenderHint( QPainter::Antialiasing );
1120 const QRectF rect( 0, 0,
size.width(),
size.height() );
1123 painter.setPen( Qt::NoPen );
1125 if ( ( background1.lightnessF() < 0.7 ) )
1127 background1 = background1.darker( 125 );
1131 background1 = background1.lighter( 125 );
1134 QLinearGradient linearGrad( QPointF( 0, 0 ), QPointF( 0, rect.height() ) );
1135 linearGrad.setColorAt( 0, background1 );
1136 linearGrad.setColorAt( 1, background2 );
1137 painter.setBrush( QBrush( linearGrad ) );
1138 if (
size.width() > 30 )
1140 painter.drawRoundedRect( rect, 6, 6 );
1145 painter.drawRect( rect );
1147 painter.setBrush( Qt::NoBrush );
1148 painter.setPen( Qt::NoPen );
1162 QWidget *activeWindow = QApplication::activeWindow();
1163 if ( QScreen *screen = activeWindow ? activeWindow->screen() : nullptr )
1185 ? fontSize * tempFormat.
buffer().
size() / 100
1190 double ytrans = 0.0;
1193 ? fontSize * tempFormat.
buffer().
size() / 100
1198 const QStringList text = QStringList() << ( previewText.isEmpty() ? QObject::tr(
"Aa" ) : previewText );
1200 QRectF textRect = rect;
1201 textRect.setLeft( xtrans + padding );
1202 textRect.setWidth( rect.width() - xtrans - 2 * padding );
1204 if ( textRect.width() > 2000 )
1205 textRect.setWidth( 2000 - 2 * padding );
1207 const double bottom = textRect.height() / 2 + textHeight / 2;
1208 textRect.setTop( bottom - textHeight );
1209 textRect.setBottom( bottom );
1214 painter.setBrush( Qt::NoBrush );
1216 if (
size.width() > 30 )
1218 painter.drawRoundedRect( rect, 6, 6 );
1223 painter.drawRect( rect );
1236 css += QStringLiteral(
"line-height: %1%;" ).arg(
lineHeight() * 100 );
1239 css += QStringLiteral(
"line-height: %1px;" ).arg(
lineHeight() );
1243 css += QStringLiteral(
"line-height: %1px;" ).arg(
lineHeight() * pointToPixelMultiplier );
1247 css += QStringLiteral(
"line-height: %1px;" ).arg(
lineHeight() * 2.83464567 * pointToPixelMultiplier );
1255 css += QStringLiteral(
"color: rgba(%1,%2,%3,%4);" ).arg(
color().red() ).arg(
color().green() ).arg(
color().blue() ).arg( QString::number(
color().alphaF(),
'f', 4 ) );
1259 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...
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.
@ 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 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 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....
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)
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)