35#include <QCoreApplication>
39#include <QTextDocument>
45 mHtmlUnitsToLayoutUnits = htmlUnitsToLayoutUnits();
49 const QString defaultFontString = settings.
value( QStringLiteral(
"LayoutDesigner/defaultFont" ), QVariant(),
QgsSettings::Gui ).toString();
50 if ( !defaultFontString.isEmpty() )
52 QFont f = mFormat.
font();
71 refreshExpressionContext();
94 const double penWidth =
frameEnabled() ? ( pen().widthF() / 2.0 ) : 0;
95 const double xPenAdjust = mMarginX < 0 ? -penWidth : penWidth;
96 const double yPenAdjust = mMarginY < 0 ? -penWidth : penWidth;
102 painterRect = QRectF( ( xPenAdjust + mMarginX ) * rectScale,
103 ( yPenAdjust + mMarginY ) * rectScale,
104 ( rect().width() - 2 * xPenAdjust - 2 * mMarginX ) * rectScale,
105 ( rect().height() - 2 * yPenAdjust - 2 * mMarginY ) * rectScale );
110 const double adjustmentFactor = 3.77;
113 painterRect = QRectF( 0, 0,
114 ( rect().width() ) * rectScale,
115 ( rect().height() - yPenAdjust - mMarginY ) * rectScale );
124 QTextDocument document;
125 document.setDocumentMargin( 0 );
127 document.setDefaultStyleSheet( createStylesheet() );
129 document.setDefaultFont( createDefaultFont() );
131 QTextOption textOption = document.defaultTextOption();
132 textOption.setAlignment( mHAlignment );
133 document.setDefaultTextOption( textOption );
135 document.setHtml( QStringLiteral(
"<body>%1</body>" ).arg(
currentText() ) );
136 document.drawContents( painter, painterRect );
156void QgsLayoutItemLabel::contentChanged()
181 mLayout->itemsModel()->updateItemDisplayName(
this );
195 if (
mLayout &&
id().isEmpty() )
198 mLayout->itemsModel()->updateItemDisplayName(
this );
202void QgsLayoutItemLabel::refreshExpressionContext()
211 mDistanceArea->setSourceCrs( layer->
crs(),
mLayout->project()->transformContext() );
218 mDistanceArea->setSourceCrs( referenceMap->
crs(),
mLayout->project()->transformContext() );
220 mDistanceArea->setEllipsoid(
mLayout->project()->ellipsoid() );
226void QgsLayoutItemLabel::updateBoundingRect()
228 QRectF rectangle = rect();
229 const double frameExtension =
frameEnabled() ? pen().widthF() / 2.0 : 0.0;
230 if ( frameExtension > 0 )
231 rectangle.adjust( -frameExtension, -frameExtension, frameExtension, frameExtension );
235 rectangle.adjust( mMarginX, 0, -mMarginX, 0 );
239 rectangle.adjust( 0, mMarginY, 0, -mMarginY );
242 if ( rectangle != mCurrentRectangle )
244 prepareGeometryChange();
245 mCurrentRectangle = rectangle;
252 QString displayText = mText;
253 replaceDateText( displayText );
260void QgsLayoutItemLabel::replaceDateText( QString &text )
const
262 const QString constant = QStringLiteral(
"$CURRENT_DATE" );
263 const int currentDatePos =
text.indexOf( constant );
264 if ( currentDatePos != -1 )
268 const int openingBracketPos =
text.indexOf(
'(', currentDatePos );
269 const int closingBracketPos =
text.indexOf(
')', openingBracketPos + 1 );
270 if ( openingBracketPos != -1 &&
271 closingBracketPos != -1 &&
272 ( closingBracketPos - openingBracketPos ) > 1 &&
273 openingBracketPos == currentDatePos + constant.size() )
275 formatText =
text.mid( openingBracketPos + 1, closingBracketPos - openingBracketPos - 1 );
276 text.replace( currentDatePos, closingBracketPos - currentDatePos + 1, QDate::currentDate().toString( formatText ) );
280 text.replace( QLatin1String(
"$CURRENT_DATE" ), QDate::currentDate().toString() );
288 if ( f.pointSizeF() > 0 )
289 mFormat.
setSize( f.pointSizeF() );
308 updateBoundingRect();
314 updateBoundingRect();
320 updateBoundingRect();
331 itemShiftAdjustSize( newSize.width(), newSize.height(), xShift, yShift );
334 attemptSetSceneRect( QRectF( pos().x() + xShift, pos().y() + yShift, newSize.width(), newSize.height() ) );
341 const QStringList lines =
currentText().split(
'\n' );
345 const double penWidth =
frameEnabled() ? ( pen().widthF() / 2.0 ) : 0;
347 const double width = textWidth + 2 * mMarginX + 2 * penWidth;
348 const double height = fontHeight + 2 * mMarginY + 2 * penWidth;
355 return mFormat.
font();
360 layoutLabelElem.setAttribute( QStringLiteral(
"htmlState" ),
static_cast< int >( mMode ) );
362 layoutLabelElem.setAttribute( QStringLiteral(
"labelText" ), mText );
363 layoutLabelElem.setAttribute( QStringLiteral(
"marginX" ), QString::number( mMarginX ) );
364 layoutLabelElem.setAttribute( QStringLiteral(
"marginY" ), QString::number( mMarginY ) );
365 layoutLabelElem.setAttribute( QStringLiteral(
"halign" ), mHAlignment );
366 layoutLabelElem.setAttribute( QStringLiteral(
"valign" ), mVAlignment );
368 QDomElement textElem = mFormat.
writeXml( doc, rwContext );
369 layoutLabelElem.appendChild( textElem );
379 mText = itemElem.attribute( QStringLiteral(
"labelText" ) );
382 mMode =
static_cast< Mode >( itemElem.attribute( QStringLiteral(
"htmlState" ) ).toInt() );
385 bool marginXOk =
false;
386 bool marginYOk =
false;
387 mMarginX = itemElem.attribute( QStringLiteral(
"marginX" ) ).toDouble( &marginXOk );
388 mMarginY = itemElem.attribute( QStringLiteral(
"marginY" ) ).toDouble( &marginYOk );
389 if ( !marginXOk || !marginYOk )
392 const double margin = itemElem.attribute( QStringLiteral(
"margin" ), QStringLiteral(
"1.0" ) ).toDouble();
398 mHAlignment =
static_cast< Qt::AlignmentFlag
>( itemElem.attribute( QStringLiteral(
"halign" ) ).toInt() );
401 mVAlignment =
static_cast< Qt::AlignmentFlag
>( itemElem.attribute( QStringLiteral(
"valign" ) ).toInt() );
404 QDomNodeList textFormatNodeList = itemElem.elementsByTagName( QStringLiteral(
"text-style" ) );
405 if ( !textFormatNodeList.isEmpty() )
407 QDomElement textFormatElem = textFormatNodeList.at( 0 ).toElement();
408 mFormat.
readXml( textFormatElem, context );
415 f.fromString( itemElem.attribute( QStringLiteral(
"font" ), QString() ) );
418 if ( f.pointSizeF() > 0 )
420 mFormat.
setSize( f.pointSizeF() );
423 else if ( f.pixelSize() > 0 )
425 mFormat.
setSize( f.pixelSize() );
430 const QDomNodeList fontColorList = itemElem.elementsByTagName( QStringLiteral(
"FontColor" ) );
431 if ( !fontColorList.isEmpty() )
433 const QDomElement fontColorElem = fontColorList.at( 0 ).toElement();
434 const int red = fontColorElem.attribute( QStringLiteral(
"red" ), QStringLiteral(
"0" ) ).toInt();
435 const int green = fontColorElem.attribute( QStringLiteral(
"green" ), QStringLiteral(
"0" ) ).toInt();
436 const int blue = fontColorElem.attribute( QStringLiteral(
"blue" ), QStringLiteral(
"0" ) ).toInt();
437 const int alpha = fontColorElem.attribute( QStringLiteral(
"alpha" ), QStringLiteral(
"255" ) ).toInt();
438 mFormat.
setColor( QColor( red, green, blue, alpha ) );
440 else if ( textFormatNodeList.isEmpty() )
442 mFormat.
setColor( QColor( 0, 0, 0 ) );
446 updateBoundingRect();
453 if ( !
id().isEmpty() )
461 return tr(
"<HTML Label>" );
467 const QString
text = mText;
468 if (
text.isEmpty() )
470 return tr(
"<Label>" );
472 if (
text.length() > 25 )
474 return QString( tr(
"%1…" ) ).arg(
text.left( 25 ).simplified() );
478 return text.simplified();
487 return mCurrentRectangle;
493 updateBoundingRect();
499 updateBoundingRect();
506 refreshExpressionContext();
512 if ( evaluated == mText )
518void QgsLayoutItemLabel::itemShiftAdjustSize(
double newWidth,
double newHeight,
double &xShift,
double &yShift )
const
521 const double currentWidth = rect().width();
522 const double currentHeight = rect().height();
526 const double r = rotation();
527 if ( r >= 0 && r < 90 )
529 if ( mHAlignment == Qt::AlignHCenter )
531 xShift = - ( newWidth - currentWidth ) / 2.0;
533 else if ( mHAlignment == Qt::AlignRight )
535 xShift = - ( newWidth - currentWidth );
537 if ( mVAlignment == Qt::AlignVCenter )
539 yShift = -( newHeight - currentHeight ) / 2.0;
541 else if ( mVAlignment == Qt::AlignBottom )
543 yShift = - ( newHeight - currentHeight );
546 if ( r >= 90 && r < 180 )
548 if ( mHAlignment == Qt::AlignHCenter )
550 yShift = -( newHeight - currentHeight ) / 2.0;
552 else if ( mHAlignment == Qt::AlignRight )
554 yShift = -( newHeight - currentHeight );
556 if ( mVAlignment == Qt::AlignTop )
558 xShift = -( newWidth - currentWidth );
560 else if ( mVAlignment == Qt::AlignVCenter )
562 xShift = -( newWidth - currentWidth / 2.0 );
565 else if ( r >= 180 && r < 270 )
567 if ( mHAlignment == Qt::AlignHCenter )
569 xShift = -( newWidth - currentWidth ) / 2.0;
571 else if ( mHAlignment == Qt::AlignLeft )
573 xShift = -( newWidth - currentWidth );
575 if ( mVAlignment == Qt::AlignVCenter )
577 yShift = ( newHeight - currentHeight ) / 2.0;
579 else if ( mVAlignment == Qt::AlignTop )
581 yShift = ( newHeight - currentHeight );
584 else if ( r >= 270 && r < 360 )
586 if ( mHAlignment == Qt::AlignHCenter )
588 yShift = -( newHeight - currentHeight ) / 2.0;
590 else if ( mHAlignment == Qt::AlignLeft )
592 yShift = -( newHeight - currentHeight );
594 if ( mVAlignment == Qt::AlignBottom )
596 xShift = -( newWidth - currentWidth );
598 else if ( mVAlignment == Qt::AlignVCenter )
600 xShift = -( newWidth - currentWidth / 2.0 );
605QFont QgsLayoutItemLabel::createDefaultFont()
const
607 QFont f = mFormat.
font();
611 f.setPointSizeF( mFormat.
size() / 0.352778 );
614 f.setPixelSize( mFormat.
size() );
617 f.setPointSizeF( mFormat.
size() );
620 f.setPointSizeF( mFormat.
size() * 72 );
631double QgsLayoutItemLabel::htmlUnitsToLayoutUnits()
642QString QgsLayoutItemLabel::createStylesheet()
const
646 stylesheet += QStringLiteral(
"body { margin: %1 %2;" ).arg( std::max( mMarginY * mHtmlUnitsToLayoutUnits, 0.0 ) ).arg( std::max( mMarginX * mHtmlUnitsToLayoutUnits, 0.0 ) );
647 stylesheet += mFormat.
asCSS( 0.352778 * mHtmlUnitsToLayoutUnits );
648 stylesheet += QStringLiteral(
"text-align: %1; }" ).arg( mHAlignment == Qt::AlignLeft ? QStringLiteral(
"left" ) : mHAlignment == Qt::AlignRight ? QStringLiteral(
"right" ) : mHAlignment == Qt::AlignHCenter ? QStringLiteral(
"center" ) : QStringLiteral(
"justify" ) );
653QUrl QgsLayoutItemLabel::createStylesheetUrl()
const
656 ba.append( createStylesheet().toUtf8() );
657 QUrl cssFileURL = QUrl( QString(
"data:text/css;charset=utf-8;base64," + ba.toBase64() ) );
@ Millimeters
Millimeters.
@ 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.
@ ApplyScalingWorkaroundForTextRendering
Whether a scaling workaround designed to stablise the rendering of small font sizes (or for painters ...
@ WrapLines
Automatically wrap long lines of text.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
static QString replaceExpressionText(const QString &action, const QgsExpressionContext *context, const QgsDistanceArea *distanceArea=nullptr)
This function replaces each expression between [% and %] in the string with the result of its evaluat...
static bool setFromXmlChildNode(QFont &font, const QDomElement &element, const QString &childNode)
Sets the properties of a font to match the properties stored in an XML child node.
static void setFontFamily(QFont &font, const QString &family)
Sets the family for a font object.
A layout item subclass for text labels.
Mode mode() const
Returns the label's current mode.
void setMarginX(double margin)
Sets the horizontal margin between the edge of the frame and the label contents, in layout units.
void setFrameEnabled(bool drawFrame) override
Sets whether this item has a frame drawn around it or not.
QRectF boundingRect() const override
QSizeF sizeForText() const
Returns the required item size (in layout units) for the label's text to fill the item.
void setMargin(double margin)
Sets the margin between the edge of the frame and the label contents.
int type() const override
static QgsLayoutItemLabel * create(QgsLayout *layout)
Returns a new label item for the specified layout.
bool readPropertiesFromElement(const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
Sets item state from a DOM element.
Q_DECL_DEPRECATED QFont font() const
Returns the label's current font.
QgsLayoutItemLabel(QgsLayout *layout)
Constructor for QgsLayoutItemLabel, with the specified parent layout.
void setText(const QString &text)
Sets the label's preset text.
void setFrameStrokeWidth(QgsLayoutMeasurement strokeWidth) override
Sets the frame stroke width.
void setMarginY(double margin)
Sets the vertical margin between the edge of the frame and the label contents, in layout units.
void draw(QgsLayoutItemRenderContext &context) override
Draws the item's contents using the specified item render context.
Q_DECL_DEPRECATED void setFont(const QFont &font)
Sets the label's current font.
bool writePropertiesToElement(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
Stores item state within an XML DOM element.
void setMode(Mode mode)
Sets the label's current mode, allowing the label to switch between font based and HTML based renderi...
QString displayName() const override
Gets item display name.
QString text() const
Returns the label's preset text.
void convertToStaticText()
Converts the label's text() to a static string, by evaluating any expressions included in the text an...
QgsTextFormat textFormat() const
Returns the text format used for drawing text in the label.
void setTextFormat(const QgsTextFormat &format)
Sets the text format used for drawing text in the label.
QString currentText() const
Returns the text as it appears on the label (with evaluated expressions and other dynamic content).
QIcon icon() const override
Returns the item's icon.
void adjustSizeToText()
Resizes the item so that the label's text fits to the item.
@ ModeHtml
Label displays rendered HTML content.
@ ModeFont
Label displays text rendered using a single font.
Layout graphical items for displaying a map.
QgsCoordinateReferenceSystem crs() const
Returns coordinate reference system used for rendering the map.
Contains settings and helpers relating to a render of a QgsLayoutItem.
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
Base class for graphical items within a QgsLayout.
virtual void drawFrame(QgsRenderContext &context)
Draws the frame around the item.
virtual void setFrameStrokeWidth(QgsLayoutMeasurement width)
Sets the frame stroke width.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
virtual void setFrameEnabled(bool drawFrame)
Sets whether this item has a frame drawn around it or not.
void sizePositionChanged()
Emitted when the item's size or position changes.
virtual void invalidateCache()
Forces a deferred update of any cached image the item uses.
QString id() const
Returns the item's ID name.
bool frameEnabled() const
Returns true if the item includes a frame.
void refresh() override
Refreshes the item, causing a recalculation of any property overrides and recalculation of its positi...
void attemptSetSceneRect(const QRectF &rect, bool includesFrame=false)
Attempts to update the item's position and size to match the passed rect in layout coordinates.
void setBackgroundEnabled(bool drawBackground)
Sets whether this item has a background drawn under it or not.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
const QgsLayout * layout() const
Returns the layout the object is attached to.
void changed()
Emitted when the object's properties change.
QPointer< QgsLayout > mLayout
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
static QgsRenderContext createRenderContextForLayout(QgsLayout *layout, QPainter *painter, double dpi=-1)
Creates a render context suitable for the specified layout and painter destination.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
QgsCoordinateReferenceSystem crs
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
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).
QPainter * painter()
Returns the destination QPainter for the render operation.
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
Scoped object for saving and restoring a QPainter object's state.
This class is a composition of two QSettings instances:
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
Container for all settings relating to text rendering.
void setColor(const QColor &color)
Sets the color that text will be rendered in.
void setSize(double size)
Sets the size for rendered text.
void setFont(const QFont &font)
Sets the font used for rendering text.
void setSizeUnit(Qgis::RenderUnit unit)
Sets the units for the size of rendered text.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
Qgis::RenderUnit sizeUnit() const
Returns the units for the size of rendered text.
double size() const
Returns the size for rendered text.
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.
QFont font() const
Returns the font used for rendering text.
static Qgis::TextVerticalAlignment convertQtVAlignment(Qt::Alignment alignment)
Converts a Qt vertical alignment flag to a Qgis::TextVerticalAlignment value.
static double textWidth(const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, QFontMetricsF *fontMetrics=nullptr)
Returns the width of a text based on a given format.
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.
static Qgis::TextHorizontalAlignment convertQtHAlignment(Qt::Alignment alignment)
Converts a Qt horizontal alignment flag to a Qgis::TextHorizontalAlignment value.
Represents a vector layer which manages a vector based data sets.