37#include <QCoreApplication>
49 mHtmlUnitsToLayoutUnits = htmlUnitsToLayoutUnits();
53 const QString defaultFontString = settings.
value( QStringLiteral(
"LayoutDesigner/defaultFont" ), QVariant(),
QgsSettings::Gui ).toString();
54 if ( !defaultFontString.isEmpty() )
56 QFont f = mFormat.
font();
57 f.setFamily( defaultFontString );
70 refreshExpressionContext();
73 if ( QThread::currentThread() == QApplication::instance()->thread() )
83 mWebPage->setIdentifier( tr(
"Layout label item" ) );
87 QPalette palette = mWebPage->palette();
88 palette.setBrush( QPalette::Base, Qt::transparent );
89 mWebPage->setPalette( palette );
91 mWebPage->mainFrame()->setZoomFactor( 10.0 );
92 mWebPage->mainFrame()->setScrollBarPolicy( Qt::Horizontal, Qt::ScrollBarAlwaysOff );
93 mWebPage->mainFrame()->setScrollBarPolicy( Qt::Vertical, Qt::ScrollBarAlwaysOff );
95 connect( mWebPage.get(), &QWebPage::loadFinished,
this, &QgsLayoutItemLabel::loadingHtmlFinished );
119 double rectScale = 1.0;
130 const double penWidth =
frameEnabled() ? ( pen().widthF() / 2.0 ) : 0;
131 const double xPenAdjust = mMarginX < 0 ? -penWidth : penWidth;
132 const double yPenAdjust = mMarginY < 0 ? -penWidth : penWidth;
133 const QRectF painterRect( ( xPenAdjust + mMarginX ) * rectScale,
134 ( yPenAdjust + mMarginY ) * rectScale,
135 ( rect().width() - 2 * xPenAdjust - 2 * mMarginX ) * rectScale,
136 ( rect().height() - 2 * yPenAdjust - 2 * mMarginY ) * rectScale );
145 mFirstRender =
false;
150 painter->scale( 1.0 / mHtmlUnitsToLayoutUnits / 10.0, 1.0 / mHtmlUnitsToLayoutUnits / 10.0 );
151 mWebPage->setViewportSize( QSize( painterRect.width() * mHtmlUnitsToLayoutUnits * 10.0, painterRect.height() * mHtmlUnitsToLayoutUnits * 10.0 ) );
152 mWebPage->settings()->setUserStyleSheetUrl( createStylesheetUrl() );
153 mWebPage->mainFrame()->render( painter );
174void QgsLayoutItemLabel::contentChanged()
192 const QUrl baseUrl = QUrl::fromLocalFile(
mLayout->project()->absoluteFilePath() );
193 mWebPage->mainFrame()->setHtml( textToDraw, baseUrl );
201 if ( !mHtmlLoaded && ( !
mLayout || !
mLayout->renderContext().isPreviewRender() ) )
207 connect( mWebPage.get(), &QWebPage::loadFinished, &loop, &QEventLoop::quit );
211 timeoutTimer.setSingleShot(
true );
212 connect( &timeoutTimer, &QTimer::timeout, &loop, &QEventLoop::quit );
213 timeoutTimer.start( 20000 );
216 loop.exec( QEventLoop::ExcludeUserInputEvents );
226void QgsLayoutItemLabel::loadingHtmlFinished(
bool result )
234double QgsLayoutItemLabel::htmlUnitsToLayoutUnits()
255 mLayout->itemsModel()->updateItemDisplayName(
this );
269 if (
mLayout &&
id().isEmpty() )
272 mLayout->itemsModel()->updateItemDisplayName(
this );
276void QgsLayoutItemLabel::refreshExpressionContext()
285 mDistanceArea->setSourceCrs( layer->
crs(),
mLayout->project()->transformContext() );
292 mDistanceArea->setSourceCrs( referenceMap->
crs(),
mLayout->project()->transformContext() );
294 mDistanceArea->setEllipsoid(
mLayout->project()->ellipsoid() );
302 QString displayText = mText;
303 replaceDateText( displayText );
310void QgsLayoutItemLabel::replaceDateText( QString &text )
const
312 const QString constant = QStringLiteral(
"$CURRENT_DATE" );
313 const int currentDatePos =
text.indexOf( constant );
314 if ( currentDatePos != -1 )
318 const int openingBracketPos =
text.indexOf(
'(', currentDatePos );
319 const int closingBracketPos =
text.indexOf(
')', openingBracketPos + 1 );
320 if ( openingBracketPos != -1 &&
321 closingBracketPos != -1 &&
322 ( closingBracketPos - openingBracketPos ) > 1 &&
323 openingBracketPos == currentDatePos + constant.size() )
325 formatText =
text.mid( openingBracketPos + 1, closingBracketPos - openingBracketPos - 1 );
326 text.replace( currentDatePos, closingBracketPos - currentDatePos + 1, QDate::currentDate().toString( formatText ) );
330 text.replace( QLatin1String(
"$CURRENT_DATE" ), QDate::currentDate().toString() );
338 if ( f.pointSizeF() > 0 )
339 mFormat.
setSize( f.pointSizeF() );
356 prepareGeometryChange();
362 prepareGeometryChange();
368 prepareGeometryChange();
379 itemShiftAdjustSize( newSize.width(), newSize.height(), xShift, yShift );
382 attemptSetSceneRect( QRectF( pos().x() + xShift, pos().y() + yShift, newSize.width(), newSize.height() ) );
389 const QStringList lines =
currentText().split(
'\n' );
393 const double penWidth =
frameEnabled() ? ( pen().widthF() / 2.0 ) : 0;
395 const double width = textWidth + 2 * mMarginX + 2 * penWidth;
396 const double height = fontHeight + 2 * mMarginY + 2 * penWidth;
403 return mFormat.
font();
408 layoutLabelElem.setAttribute( QStringLiteral(
"htmlState" ),
static_cast< int >( mMode ) );
410 layoutLabelElem.setAttribute( QStringLiteral(
"labelText" ), mText );
411 layoutLabelElem.setAttribute( QStringLiteral(
"marginX" ), QString::number( mMarginX ) );
412 layoutLabelElem.setAttribute( QStringLiteral(
"marginY" ), QString::number( mMarginY ) );
413 layoutLabelElem.setAttribute( QStringLiteral(
"halign" ), mHAlignment );
414 layoutLabelElem.setAttribute( QStringLiteral(
"valign" ), mVAlignment );
416 QDomElement textElem = mFormat.
writeXml( doc, rwContext );
417 layoutLabelElem.appendChild( textElem );
427 mText = itemElem.attribute( QStringLiteral(
"labelText" ) );
430 mMode =
static_cast< Mode >( itemElem.attribute( QStringLiteral(
"htmlState" ) ).toInt() );
433 bool marginXOk =
false;
434 bool marginYOk =
false;
435 mMarginX = itemElem.attribute( QStringLiteral(
"marginX" ) ).toDouble( &marginXOk );
436 mMarginY = itemElem.attribute( QStringLiteral(
"marginY" ) ).toDouble( &marginYOk );
437 if ( !marginXOk || !marginYOk )
440 const double margin = itemElem.attribute( QStringLiteral(
"margin" ), QStringLiteral(
"1.0" ) ).toDouble();
446 mHAlignment =
static_cast< Qt::AlignmentFlag
>( itemElem.attribute( QStringLiteral(
"halign" ) ).toInt() );
449 mVAlignment =
static_cast< Qt::AlignmentFlag
>( itemElem.attribute( QStringLiteral(
"valign" ) ).toInt() );
452 QDomNodeList textFormatNodeList = itemElem.elementsByTagName( QStringLiteral(
"text-style" ) );
453 if ( !textFormatNodeList.isEmpty() )
455 QDomElement textFormatElem = textFormatNodeList.at( 0 ).toElement();
456 mFormat.
readXml( textFormatElem, context );
463 f.fromString( itemElem.attribute( QStringLiteral(
"font" ), QString() ) );
466 if ( f.pointSizeF() > 0 )
468 mFormat.
setSize( f.pointSizeF() );
471 else if ( f.pixelSize() > 0 )
473 mFormat.
setSize( f.pixelSize() );
478 const QDomNodeList fontColorList = itemElem.elementsByTagName( QStringLiteral(
"FontColor" ) );
479 if ( !fontColorList.isEmpty() )
481 const QDomElement fontColorElem = fontColorList.at( 0 ).toElement();
482 const int red = fontColorElem.attribute( QStringLiteral(
"red" ), QStringLiteral(
"0" ) ).toInt();
483 const int green = fontColorElem.attribute( QStringLiteral(
"green" ), QStringLiteral(
"0" ) ).toInt();
484 const int blue = fontColorElem.attribute( QStringLiteral(
"blue" ), QStringLiteral(
"0" ) ).toInt();
485 const int alpha = fontColorElem.attribute( QStringLiteral(
"alpha" ), QStringLiteral(
"255" ) ).toInt();
486 mFormat.
setColor( QColor( red, green, blue, alpha ) );
488 else if ( textFormatNodeList.isEmpty() )
490 mFormat.
setColor( QColor( 0, 0, 0 ) );
499 if ( !
id().isEmpty() )
507 return tr(
"<HTML Label>" );
513 const QString
text = mText;
514 if (
text.isEmpty() )
516 return tr(
"<Label>" );
518 if (
text.length() > 25 )
520 return QString( tr(
"%1…" ) ).arg(
text.left( 25 ).simplified() );
524 return text.simplified();
533 QRectF rectangle = rect();
534 const double penWidth =
frameEnabled() ? ( pen().widthF() / 2.0 ) : 0;
535 rectangle.adjust( -penWidth, -penWidth, penWidth, penWidth );
539 rectangle.adjust( mMarginX, 0, -mMarginX, 0 );
543 rectangle.adjust( 0, mMarginY, 0, -mMarginY );
552 prepareGeometryChange();
558 prepareGeometryChange();
565 refreshExpressionContext();
571 if ( evaluated == mText )
577void QgsLayoutItemLabel::itemShiftAdjustSize(
double newWidth,
double newHeight,
double &xShift,
double &yShift )
const
580 const double currentWidth = rect().width();
581 const double currentHeight = rect().height();
585 const double r = rotation();
586 if ( r >= 0 && r < 90 )
588 if ( mHAlignment == Qt::AlignHCenter )
590 xShift = - ( newWidth - currentWidth ) / 2.0;
592 else if ( mHAlignment == Qt::AlignRight )
594 xShift = - ( newWidth - currentWidth );
596 if ( mVAlignment == Qt::AlignVCenter )
598 yShift = -( newHeight - currentHeight ) / 2.0;
600 else if ( mVAlignment == Qt::AlignBottom )
602 yShift = - ( newHeight - currentHeight );
605 if ( r >= 90 && r < 180 )
607 if ( mHAlignment == Qt::AlignHCenter )
609 yShift = -( newHeight - currentHeight ) / 2.0;
611 else if ( mHAlignment == Qt::AlignRight )
613 yShift = -( newHeight - currentHeight );
615 if ( mVAlignment == Qt::AlignTop )
617 xShift = -( newWidth - currentWidth );
619 else if ( mVAlignment == Qt::AlignVCenter )
621 xShift = -( newWidth - currentWidth / 2.0 );
624 else if ( r >= 180 && r < 270 )
626 if ( mHAlignment == Qt::AlignHCenter )
628 xShift = -( newWidth - currentWidth ) / 2.0;
630 else if ( mHAlignment == Qt::AlignLeft )
632 xShift = -( newWidth - currentWidth );
634 if ( mVAlignment == Qt::AlignVCenter )
636 yShift = ( newHeight - currentHeight ) / 2.0;
638 else if ( mVAlignment == Qt::AlignTop )
640 yShift = ( newHeight - currentHeight );
643 else if ( r >= 270 && r < 360 )
645 if ( mHAlignment == Qt::AlignHCenter )
647 yShift = -( newHeight - currentHeight ) / 2.0;
649 else if ( mHAlignment == Qt::AlignLeft )
651 yShift = -( newHeight - currentHeight );
653 if ( mVAlignment == Qt::AlignBottom )
655 xShift = -( newWidth - currentWidth );
657 else if ( mVAlignment == Qt::AlignVCenter )
659 xShift = -( newWidth - currentWidth / 2.0 );
664QUrl QgsLayoutItemLabel::createStylesheetUrl()
const
667 stylesheet += QStringLiteral(
"body { margin: %1 %2;" ).arg( std::max( mMarginY * mHtmlUnitsToLayoutUnits, 0.0 ) ).arg( std::max( mMarginX * mHtmlUnitsToLayoutUnits, 0.0 ) );
668 QFont f = mFormat.
font();
672 f.setPointSizeF( mFormat.
size() / 0.352778 );
675 f.setPixelSize( mFormat.
size() );
678 f.setPointSizeF( mFormat.
size() );
681 f.setPointSizeF( mFormat.
size() * 72 );
691 stylesheet += QStringLiteral(
"color: rgba(%1,%2,%3,%4);" ).arg( mFormat.
color().red() ).arg( mFormat.
color().green() ).arg( mFormat.
color().blue() ).arg( QString::number( mFormat.
color().alphaF(),
'f', 4 ) );
692 stylesheet += QStringLiteral(
"text-align: %1; }" ).arg( mHAlignment == Qt::AlignLeft ? QStringLiteral(
"left" ) : mHAlignment == Qt::AlignRight ? QStringLiteral(
"right" ) : mHAlignment == Qt::AlignHCenter ? QStringLiteral(
"center" ) : QStringLiteral(
"justify" ) );
695 ba.append( stylesheet.toUtf8() );
696 QUrl cssFileURL = QUrl( QString(
"data:text/css;charset=utf-8;base64," + ba.toBase64() ) );
@ 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 QString asCSS(const QFont &font, double pointToPixelMultiplier=1.0)
Returns a CSS string representing the specified font as closely as possible.
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.
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.
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
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
static QgsNetworkAccessManager * instance(Qt::ConnectionType connectionType=Qt::BlockingQueuedConnection)
Returns a pointer to the active QgsNetworkAccessManager for the current thread.
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.
QPainter * painter()
Returns the destination QPainter for the render operation.
double convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
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.
QgsUnitTypes::RenderUnit sizeUnit() const
Returns the units for the size of rendered text.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
void setSizeUnit(QgsUnitTypes::RenderUnit unit)
Sets 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.
QColor color() const
Returns the color that text will be rendered in.
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 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 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())
Draws text within a rectangle using the specified settings.
static Qgis::TextHorizontalAlignment convertQtHAlignment(Qt::Alignment alignment)
Converts a Qt horizontal alignment flag to a Qgis::TextHorizontalAlignment value.
@ LayoutMillimeters
Millimeters.
@ RenderUnknownUnit
Mixed or unknown units.
@ RenderMetersInMapUnits
Meters value as Map units.
@ RenderPercentage
Percentage of another measurement (e.g., canvas size, feature size)
@ RenderPoints
Points (e.g., for font sizes)
@ RenderMillimeters
Millimeters.
@ RenderMapUnits
Map units.
Represents a vector layer which manages a vector based data sets.
QWebPage subclass which redirects JavaScript errors and console output to the QGIS message log.