38#include <QCoreApplication>
42#include <QTextDocument>
44#include "moc_qgslayoutitemlabel.cpp"
49 mDistanceArea = std::make_unique<QgsDistanceArea>( );
50 mHtmlUnitsToLayoutUnits = htmlUnitsToLayoutUnits();
54 const QString defaultFontString = settings.
value( QStringLiteral(
"LayoutDesigner/defaultFont" ), QVariant(),
QgsSettings::Gui ).toString();
55 if ( !defaultFontString.isEmpty() )
57 QFont f = mFormat.font();
63 mFormat.setSize( 10 );
76 refreshExpressionContext();
99 const double penWidth =
frameEnabled() ? ( pen().widthF() / 2.0 ) : 0;
100 const double xPenAdjust = mMarginX < 0 ? -penWidth : penWidth;
101 const double yPenAdjust = mMarginY < 0 ? -penWidth : penWidth;
107 painterRect = QRectF( ( xPenAdjust + mMarginX ) * rectScale,
108 ( yPenAdjust + mMarginY ) * rectScale,
109 ( rect().width() - 2 * xPenAdjust - 2 * mMarginX ) * rectScale,
110 ( rect().height() - 2 * yPenAdjust - 2 * mMarginY ) * rectScale );
115#if QT_VERSION >= QT_VERSION_CHECK( 6, 7, 0 )
116 constexpr double adjustmentFactor = 4.18;
118 constexpr double adjustmentFactor = 3.77;
122 painterRect = QRectF( 0, 0,
123 ( rect().width() ) * rectScale,
124 ( rect().height() - yPenAdjust - mMarginY ) * rectScale );
133 QTextDocument document;
134 document.setDocumentMargin( 0 );
136 document.setDefaultStyleSheet( createStylesheet() );
138 document.setDefaultFont( createDefaultFont() );
140 QTextOption textOption = document.defaultTextOption();
141 textOption.setAlignment( mHAlignment );
142 document.setDefaultTextOption( textOption );
144 document.setHtml( QStringLiteral(
"<body>%1</body>" ).arg(
currentText() ) );
145 document.drawContents( painter, painterRect );
165void QgsLayoutItemLabel::contentChanged()
190 mLayout->itemsModel()->updateItemDisplayName(
this );
204 if (
mLayout &&
id().isEmpty() )
207 mLayout->itemsModel()->updateItemDisplayName(
this );
211void QgsLayoutItemLabel::refreshExpressionContext()
220 mDistanceArea->setSourceCrs( layer->
crs(),
mLayout->project()->transformContext() );
227 mDistanceArea->setSourceCrs( referenceMap->
crs(),
mLayout->project()->transformContext() );
229 mDistanceArea->setEllipsoid(
mLayout->project()->ellipsoid() );
235void QgsLayoutItemLabel::updateBoundingRect()
237 QRectF rectangle = rect();
238 const double frameExtension =
frameEnabled() ? pen().widthF() / 2.0 : 0.0;
239 if ( frameExtension > 0 )
240 rectangle.adjust( -frameExtension, -frameExtension, frameExtension, frameExtension );
244 rectangle.adjust( mMarginX, 0, -mMarginX, 0 );
248 rectangle.adjust( 0, mMarginY, 0, -mMarginY );
251 if ( rectangle != mCurrentRectangle )
253 prepareGeometryChange();
254 mCurrentRectangle = rectangle;
261 QString displayText = mText;
262 replaceDateText( displayText );
269void QgsLayoutItemLabel::replaceDateText( QString &text )
const
271 const QString constant = QStringLiteral(
"$CURRENT_DATE" );
272 const int currentDatePos =
text.indexOf( constant );
273 if ( currentDatePos != -1 )
277 const int openingBracketPos =
text.indexOf(
'(', currentDatePos );
278 const int closingBracketPos =
text.indexOf(
')', openingBracketPos + 1 );
279 if ( openingBracketPos != -1 &&
280 closingBracketPos != -1 &&
281 ( closingBracketPos - openingBracketPos ) > 1 &&
282 openingBracketPos == currentDatePos + constant.size() )
284 formatText =
text.mid( openingBracketPos + 1, closingBracketPos - openingBracketPos - 1 );
285 text.replace( currentDatePos, closingBracketPos - currentDatePos + 1, QDate::currentDate().toString( formatText ) );
289 text.replace( QLatin1String(
"$CURRENT_DATE" ), QDate::currentDate().toString() );
296 mFormat.setFont( f );
297 if ( f.pointSizeF() > 0 )
298 mFormat.setSize( f.pointSizeF() );
317 updateBoundingRect();
323 updateBoundingRect();
329 updateBoundingRect();
340 itemShiftAdjustSize( newSize.width(), newSize.height(), xShift, yShift );
343 attemptSetSceneRect( QRectF( pos().x() + xShift, pos().y() + yShift, newSize.width(), newSize.height() ) );
349 const double newWidth = newSize.width();
350 const double newHeight = newSize.height();
351 const double currentWidth = rect().width();
352 const double currentHeight = rect().height();
364 xShift = - ( newWidth - currentWidth ) / 2.0;
369 xShift = - ( newWidth - currentWidth );
375 yShift = -( newHeight - currentHeight ) / 2.0;
379 xShift = - ( newWidth - currentWidth ) / 2.0;
380 yShift = -( newHeight - currentHeight ) / 2.0;
384 xShift = - ( newWidth - currentWidth );
385 yShift = -( newHeight - currentHeight ) / 2.0;
390 yShift = - ( newHeight - currentHeight );
394 xShift = - ( newWidth - currentWidth ) / 2.0;
395 yShift = - ( newHeight - currentHeight );
399 xShift = - ( newWidth - currentWidth );
400 yShift = - ( newHeight - currentHeight );
405 attemptSetSceneRect( QRectF( pos().x() + xShift, pos().y() + yShift, newSize.width(), newSize.height() ) );
413 const QStringList lines =
currentText().split(
'\n' );
417 const double penWidth =
frameEnabled() ? ( pen().widthF() / 2.0 ) : 0;
419 const double width = textWidth + 2 * mMarginX + 2 * penWidth;
420 const double height = fontHeight + 2 * mMarginY + 2 * penWidth;
427 return mFormat.font();
432 layoutLabelElem.setAttribute( QStringLiteral(
"htmlState" ),
static_cast< int >( mMode ) );
434 layoutLabelElem.setAttribute( QStringLiteral(
"labelText" ), mText );
435 layoutLabelElem.setAttribute( QStringLiteral(
"marginX" ), QString::number( mMarginX ) );
436 layoutLabelElem.setAttribute( QStringLiteral(
"marginY" ), QString::number( mMarginY ) );
437 layoutLabelElem.setAttribute( QStringLiteral(
"halign" ), mHAlignment );
438 layoutLabelElem.setAttribute( QStringLiteral(
"valign" ), mVAlignment );
440 QDomElement textElem = mFormat.writeXml( doc, rwContext );
441 layoutLabelElem.appendChild( textElem );
451 mText = itemElem.attribute( QStringLiteral(
"labelText" ) );
454 mMode =
static_cast< Mode >( itemElem.attribute( QStringLiteral(
"htmlState" ) ).toInt() );
457 bool marginXOk =
false;
458 bool marginYOk =
false;
459 mMarginX = itemElem.attribute( QStringLiteral(
"marginX" ) ).toDouble( &marginXOk );
460 mMarginY = itemElem.attribute( QStringLiteral(
"marginY" ) ).toDouble( &marginYOk );
461 if ( !marginXOk || !marginYOk )
464 const double margin = itemElem.attribute( QStringLiteral(
"margin" ), QStringLiteral(
"1.0" ) ).toDouble();
470 mHAlignment =
static_cast< Qt::AlignmentFlag
>( itemElem.attribute( QStringLiteral(
"halign" ) ).toInt() );
473 mVAlignment =
static_cast< Qt::AlignmentFlag
>( itemElem.attribute( QStringLiteral(
"valign" ) ).toInt() );
476 QDomNodeList textFormatNodeList = itemElem.elementsByTagName( QStringLiteral(
"text-style" ) );
477 if ( !textFormatNodeList.isEmpty() )
479 QDomElement textFormatElem = textFormatNodeList.at( 0 ).toElement();
480 mFormat.readXml( textFormatElem, context );
487 f.fromString( itemElem.attribute( QStringLiteral(
"font" ), QString() ) );
489 mFormat.setFont( f );
490 if ( f.pointSizeF() > 0 )
492 mFormat.setSize( f.pointSizeF() );
495 else if ( f.pixelSize() > 0 )
497 mFormat.setSize( f.pixelSize() );
502 const QDomNodeList fontColorList = itemElem.elementsByTagName( QStringLiteral(
"FontColor" ) );
503 if ( !fontColorList.isEmpty() )
505 const QDomElement fontColorElem = fontColorList.at( 0 ).toElement();
506 const int red = fontColorElem.attribute( QStringLiteral(
"red" ), QStringLiteral(
"0" ) ).toInt();
507 const int green = fontColorElem.attribute( QStringLiteral(
"green" ), QStringLiteral(
"0" ) ).toInt();
508 const int blue = fontColorElem.attribute( QStringLiteral(
"blue" ), QStringLiteral(
"0" ) ).toInt();
509 const int alpha = fontColorElem.attribute( QStringLiteral(
"alpha" ), QStringLiteral(
"255" ) ).toInt();
510 mFormat.setColor( QColor( red, green, blue, alpha ) );
512 else if ( textFormatNodeList.isEmpty() )
514 mFormat.setColor( QColor( 0, 0, 0 ) );
518 updateBoundingRect();
525 if ( !
id().isEmpty() )
533 return tr(
"<HTML Label>" );
539 const QString
text = mText;
540 if (
text.isEmpty() )
542 return tr(
"<Label>" );
544 if (
text.length() > 25 )
546 return QString( tr(
"%1…" ) ).arg(
text.left( 25 ).simplified() );
550 return text.simplified();
559 return mCurrentRectangle;
565 updateBoundingRect();
571 updateBoundingRect();
578 refreshExpressionContext();
584 if ( evaluated == mText )
590void QgsLayoutItemLabel::itemShiftAdjustSize(
double newWidth,
double newHeight,
double &xShift,
double &yShift )
const
593 const double currentWidth = rect().width();
594 const double currentHeight = rect().height();
598 const double r = rotation();
599 if ( r >= 0 && r < 90 )
601 if ( mHAlignment == Qt::AlignHCenter )
603 xShift = - ( newWidth - currentWidth ) / 2.0;
605 else if ( mHAlignment == Qt::AlignRight )
607 xShift = - ( newWidth - currentWidth );
609 if ( mVAlignment == Qt::AlignVCenter )
611 yShift = -( newHeight - currentHeight ) / 2.0;
613 else if ( mVAlignment == Qt::AlignBottom )
615 yShift = - ( newHeight - currentHeight );
618 if ( r >= 90 && r < 180 )
620 if ( mHAlignment == Qt::AlignHCenter )
622 yShift = -( newHeight - currentHeight ) / 2.0;
624 else if ( mHAlignment == Qt::AlignRight )
626 yShift = -( newHeight - currentHeight );
628 if ( mVAlignment == Qt::AlignTop )
630 xShift = -( newWidth - currentWidth );
632 else if ( mVAlignment == Qt::AlignVCenter )
634 xShift = -( newWidth - currentWidth / 2.0 );
637 else if ( r >= 180 && r < 270 )
639 if ( mHAlignment == Qt::AlignHCenter )
641 xShift = -( newWidth - currentWidth ) / 2.0;
643 else if ( mHAlignment == Qt::AlignLeft )
645 xShift = -( newWidth - currentWidth );
647 if ( mVAlignment == Qt::AlignVCenter )
649 yShift = ( newHeight - currentHeight ) / 2.0;
651 else if ( mVAlignment == Qt::AlignTop )
653 yShift = ( newHeight - currentHeight );
656 else if ( r >= 270 && r < 360 )
658 if ( mHAlignment == Qt::AlignHCenter )
660 yShift = -( newHeight - currentHeight ) / 2.0;
662 else if ( mHAlignment == Qt::AlignLeft )
664 yShift = -( newHeight - currentHeight );
666 if ( mVAlignment == Qt::AlignBottom )
668 xShift = -( newWidth - currentWidth );
670 else if ( mVAlignment == Qt::AlignVCenter )
672 xShift = -( newWidth - currentWidth / 2.0 );
677QFont QgsLayoutItemLabel::createDefaultFont()
const
679 QFont f = mFormat.font();
680 switch ( mFormat.sizeUnit() )
683 f.setPointSizeF( mFormat.size() / 0.352778 );
686 f.setPixelSize( mFormat.size() );
689 f.setPointSizeF( mFormat.size() );
692 f.setPointSizeF( mFormat.size() * 72 );
703double QgsLayoutItemLabel::htmlUnitsToLayoutUnits()
714QString QgsLayoutItemLabel::createStylesheet()
const
718 stylesheet += QStringLiteral(
"body { margin: %1 %2;" ).arg( std::max( mMarginY * mHtmlUnitsToLayoutUnits, 0.0 ) ).arg( std::max( mMarginX * mHtmlUnitsToLayoutUnits, 0.0 ) );
719 stylesheet += mFormat.asCSS( 0.352778 * mHtmlUnitsToLayoutUnits );
720 stylesheet += QStringLiteral(
"text-align: %1; }" ).arg( mHAlignment == Qt::AlignLeft ? QStringLiteral(
"left" ) : mHAlignment == Qt::AlignRight ? QStringLiteral(
"right" ) : mHAlignment == Qt::AlignHCenter ? QStringLiteral(
"center" ) : QStringLiteral(
"justify" ) );
725QUrl QgsLayoutItemLabel::createStylesheetUrl()
const
728 ba.append( createStylesheet().toUtf8() );
729 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.
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.
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.
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.
virtual void drawFrame(QgsRenderContext &context)
Draws the frame around the item.
virtual void setFrameStrokeWidth(QgsLayoutMeasurement width)
Sets the frame stroke width.
QgsLayoutItem(QgsLayout *layout, bool manageZValue=true)
Constructor for QgsLayoutItem, with the specified parent layout.
ReferencePoint referencePoint() const
Returns the reference point for positioning of the layout item.
ReferencePoint
Fixed position reference point.
@ LowerMiddle
Lower center of item.
@ MiddleLeft
Middle left of item.
@ UpperRight
Upper right corner of item.
@ LowerLeft
Lower left corner of item.
@ UpperLeft
Upper left corner of item.
@ UpperMiddle
Upper center of item.
@ MiddleRight
Middle right of item.
@ LowerRight
Lower right corner of item.
friend class QgsLayoutItemMap
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.
Provides a method of storing measurements for use in QGIS layouts using a variety of different measur...
const QgsLayout * layout() const
Returns the layout the object is attached to.
void changed()
Emitted when the object's properties change.
QPointer< QgsLayout > mLayout
Provides a method of storing sizes, consisting of a width and height, for use in QGIS layouts.
static QgsRenderContext createRenderContextForLayout(QgsLayout *layout, QPainter *painter, double dpi=-1)
Creates a render context suitable for the specified layout and painter destination.
QgsCoordinateReferenceSystem crs
A container for the context for various read/write operations on 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.
Stores settings for use within QGIS.
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.
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 dataset.