QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
qgslayoutlabelwidget.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutlabelwidget.cpp
3 ------------------------
4 begin : October 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
19#include "qgslayoutitemlabel.h"
20#include "qgslayout.h"
22#include "qgslayoutitemmap.h"
23#include "qgsvectorlayer.h"
24#include "qgsprojoperation.h"
26#include "qgsexpressionfinder.h"
27
28#include <QColorDialog>
29#include <QFontDialog>
30#include <QWidget>
31#include <QAction>
32#include <QMenu>
33
35 : QgsLayoutItemBaseWidget( nullptr, label )
36 , mLabel( label )
37{
38 Q_ASSERT( mLabel );
39
40 setupUi( this );
41 connect( mHtmlCheckBox, &QCheckBox::stateChanged, this, &QgsLayoutLabelWidget::mHtmlCheckBox_stateChanged );
42 connect( mTextEdit, &QPlainTextEdit::textChanged, this, &QgsLayoutLabelWidget::mTextEdit_textChanged );
43 connect( mInsertExpressionButton, &QPushButton::clicked, this, &QgsLayoutLabelWidget::mInsertExpressionButton_clicked );
44 connect( mMarginXDoubleSpinBox, static_cast < void ( QDoubleSpinBox::* )( double ) > ( &QDoubleSpinBox::valueChanged ), this, &QgsLayoutLabelWidget::mMarginXDoubleSpinBox_valueChanged );
45 connect( mMarginYDoubleSpinBox, static_cast < void ( QDoubleSpinBox::* )( double ) > ( &QDoubleSpinBox::valueChanged ), this, &QgsLayoutLabelWidget::mMarginYDoubleSpinBox_valueChanged );
46
47 mHAlignmentComboBox->setAvailableAlignments( Qt::AlignLeft | Qt::AlignHCenter | Qt::AlignRight | Qt::AlignJustify );
48 mVAlignmentComboBox->setAvailableAlignments( Qt::AlignTop | Qt::AlignVCenter | Qt::AlignBottom );
49
50 connect( mHAlignmentComboBox, &QgsAlignmentComboBox::changed, this, &QgsLayoutLabelWidget::horizontalAlignmentChanged );
51 connect( mVAlignmentComboBox, &QgsAlignmentComboBox::changed, this, &QgsLayoutLabelWidget::verticalAlignmentChanged );
52
53 setPanelTitle( tr( "Label Properties" ) );
54
55 mFontButton->setMode( QgsFontButton::ModeTextRenderer );
56 mFontButton->setDialogTitle( tr( "Label Font" ) );
57 mFontButton->registerExpressionContextGenerator( this );
58
59 //add widget for general composer item properties
60 mItemPropertiesWidget = new QgsLayoutItemPropertiesWidget( this, label );
61 mainLayout->addWidget( mItemPropertiesWidget );
62
63 mMarginXDoubleSpinBox->setClearValue( 0.0 );
64 mMarginYDoubleSpinBox->setClearValue( 0.0 );
65
66 setGuiElementValues();
67 connect( mLabel, &QgsLayoutObject::changed, this, &QgsLayoutLabelWidget::setGuiElementValues );
68
69 connect( mFontButton, &QgsFontButton::changed, this, &QgsLayoutLabelWidget::fontChanged );
70
71 mDynamicTextMenu = new QMenu( this );
72 mDynamicTextButton->setMenu( mDynamicTextMenu );
73
74 connect( mDynamicTextMenu, &QMenu::aboutToShow, this, [ = ]
75 {
76 mDynamicTextMenu->clear();
77 if ( mLabel->layout() )
78 {
79 // we need to rebuild this on each show, as the content varies depending on other available items...
80 buildInsertDynamicTextMenu( mLabel->layout(), mDynamicTextMenu, [ = ]( const QString & expression )
81 {
82 mLabel->beginCommand( tr( "Insert dynamic text" ) );
83 mTextEdit->insertPlainText( "[%" + expression.trimmed() + "%]" );
84 mLabel->endCommand();
85 } );
86 }
87 } );
88
89 QMenu *expressionMenu = new QMenu( this );
90 QAction *convertToStaticAction = new QAction( tr( "Convert to Static Text" ), this );
91 expressionMenu->addAction( convertToStaticAction );
92 connect( convertToStaticAction, &QAction::triggered, mLabel, &QgsLayoutItemLabel::convertToStaticText );
93 mInsertExpressionButton->setMenu( expressionMenu );
94
95 mFontButton->setLayer( coverageLayer() );
96 if ( mLabel->layout() )
97 {
98 connect( &mLabel->layout()->reportContext(), &QgsLayoutReportContext::layerChanged, mFontButton, &QgsFontButton::setLayer );
99 }
100}
101
103{
104 if ( mItemPropertiesWidget )
105 mItemPropertiesWidget->setMasterLayout( masterLayout );
106}
107
109{
110 return mLabel->createExpressionContext();
111}
112
113void QgsLayoutLabelWidget::buildInsertDynamicTextMenu( QgsLayout *layout, QMenu *menu, const std::function<void ( const QString & )> &callback )
114{
115 Q_ASSERT( layout );
116 auto addExpression = [&callback]( QMenu * menu, const QString & name, const QString & expression )
117 {
118 QAction *action = new QAction( name, menu );
119 connect( action, &QAction::triggered, action, [callback, expression]
120 {
121 callback( expression );
122 } );
123 menu->addAction( action );
124 };
125
126 QMenu *dateMenu = new QMenu( tr( "Current Date" ), menu );
127 for ( const std::pair< QString, QString > &expression :
128 {
129 std::make_pair( tr( "ISO Format (%1)" ).arg( QDateTime::currentDateTime().toString( QStringLiteral( "yyyy-MM-dd" ) ) ), QStringLiteral( "format_date(now(), 'yyyy-MM-dd')" ) ),
130 std::make_pair( tr( "Day/Month/Year (%1)" ).arg( QDateTime::currentDateTime().toString( QStringLiteral( "dd/MM/yyyy" ) ) ), QStringLiteral( "format_date(now(), 'dd/MM/yyyy')" ) ),
131 std::make_pair( tr( "Month/Day/Year (%1)" ).arg( QDateTime::currentDateTime().toString( QStringLiteral( "MM/dd/yyyy" ) ) ), QStringLiteral( "format_date(now(), 'MM/dd/yyyy')" ) ),
132 } )
133 {
134 addExpression( dateMenu, expression.first, expression.second );
135 }
136 menu->addMenu( dateMenu );
137
138 QMenu *mapsMenu = new QMenu( tr( "Map Properties" ), menu );
139 QList< QgsLayoutItemMap * > maps;
140 layout->layoutItems( maps );
141 for ( QgsLayoutItemMap *map : std::as_const( maps ) )
142 {
143 // these expressions require the map to have a non-empty ID set
144 if ( map->id().isEmpty() )
145 continue;
146
147 QMenu *mapMenu = new QMenu( map->displayName(), mapsMenu );
148 for ( const std::pair< QString, QString > &expression :
149 {
150 std::make_pair( tr( "Scale (%1)" ).arg( map->scale() ), QStringLiteral( "format_number(item_variables('%1')['map_scale'], places:=6, omit_group_separators:=true, trim_trailing_zeroes:=true)" ).arg( map->id() ) ),
151 std::make_pair( tr( "Rotation (%1)" ).arg( map->rotation() ), QStringLiteral( "item_variables('%1')['map_rotation']" ).arg( map->id() ) ),
152 } )
153 {
154 addExpression( mapMenu, expression.first, expression.second );
155 }
156 mapMenu->addSeparator();
157 for ( const std::pair< QString, QString > &expression :
158 {
159 std::make_pair( tr( "CRS Identifier (%1)" ).arg( map->crs().authid() ), QStringLiteral( "item_variables('%1')['map_crs']" ).arg( map->id() ) ),
160 std::make_pair( tr( "CRS Name (%1)" ).arg( map->crs().description() ), QStringLiteral( "item_variables('%1')['map_crs_description']" ).arg( map->id() ) ),
161 std::make_pair( tr( "Ellipsoid Name (%1)" ).arg( map->crs().ellipsoidAcronym() ), QStringLiteral( "item_variables('%1')['map_crs_ellipsoid']" ).arg( map->id() ) ),
162 std::make_pair( tr( "Units (%1)" ).arg( QgsUnitTypes::toString( map->crs().mapUnits() ) ), QStringLiteral( "item_variables('%1')['map_units']" ).arg( map->id() ) ),
163 std::make_pair( tr( "Projection (%1)" ).arg( map->crs().operation().description() ), QStringLiteral( "item_variables('%1')['map_crs_projection']" ).arg( map->id() ) ),
164 } )
165 {
166 addExpression( mapMenu, expression.first, expression.second );
167 }
168 mapMenu->addSeparator();
169
170 const QgsRectangle mapExtent = map->extent();
171 const QgsPointXY center = mapExtent.center();
172 for ( const std::pair< QString, QString > &expression :
173 {
174 std::make_pair( tr( "Center (X) (%1)" ).arg( center.x() ), QStringLiteral( "x(item_variables('%1')['map_extent_center'])" ).arg( map->id() ) ),
175 std::make_pair( tr( "Center (Y) (%1)" ).arg( center.y() ), QStringLiteral( "y(item_variables('%1')['map_extent_center'])" ).arg( map->id() ) ),
176 std::make_pair( tr( "X Minimum (%1)" ).arg( mapExtent.xMinimum() ), QStringLiteral( "x_min(item_variables('%1')['map_extent'])" ).arg( map->id() ) ),
177 std::make_pair( tr( "Y Minimum (%1)" ).arg( mapExtent.yMinimum() ), QStringLiteral( "y_min(item_variables('%1')['map_extent'])" ).arg( map->id() ) ),
178 std::make_pair( tr( "X Maximum (%1)" ).arg( mapExtent.xMaximum() ), QStringLiteral( "x_max(item_variables('%1')['map_extent'])" ).arg( map->id() ) ),
179 std::make_pair( tr( "Y Maximum (%1)" ).arg( mapExtent.yMaximum() ), QStringLiteral( "y_max(item_variables('%1')['map_extent'])" ).arg( map->id() ) ),
180 } )
181 {
182 addExpression( mapMenu, expression.first, expression.second );
183 }
184 mapMenu->addSeparator();
185 for ( const std::pair< QString, QString > &expression :
186 {
187 std::make_pair( tr( "Layer Credits" ), QStringLiteral( "array_to_string(map_credits('%1'))" ).arg( map->id() ) ),
188 } )
189 {
190 addExpression( mapMenu, expression.first, expression.second );
191 }
192 mapsMenu->addMenu( mapMenu );
193 }
194 menu->addMenu( mapsMenu );
195 menu->addSeparator();
196
197 if ( layout->reportContext().layer() )
198 {
199 const QgsFields fields = layout->reportContext().layer()->fields();
200
201 QMenu *fieldsMenu = new QMenu( tr( "Field" ), menu );
202 for ( const QgsField &field : fields )
203 {
204 addExpression( fieldsMenu, field.displayName(), QStringLiteral( "\"%1\"" ).arg( field.name() ) );
205 }
206
207 menu->addMenu( fieldsMenu );
208 menu->addSeparator();
209 }
210
211 for ( const std::pair< QString, QString > &expression :
212 {
213 std::make_pair( tr( "Layout Name" ), QStringLiteral( "@layout_name" ) ),
214 std::make_pair( tr( "Layout Page Number" ), QStringLiteral( "@layout_page" ) ),
215 std::make_pair( tr( "Layout Page Count" ), QStringLiteral( "@layout_numpages" ) ),
216 std::make_pair( tr( "Layer Credits" ), QStringLiteral( "array_to_string(map_credits())" ) )
217 } )
218 {
219 addExpression( menu, expression.first, expression.second );
220 }
221 menu->addSeparator();
222 for ( const std::pair< QString, QString > &expression :
223 {
224 std::make_pair( tr( "Project Author" ), QStringLiteral( "@project_author" ) ),
225 std::make_pair( tr( "Project Title" ), QStringLiteral( "@project_title" ) ),
226 std::make_pair( tr( "Project Path" ), QStringLiteral( "@project_path" ) )
227 } )
228 {
229 addExpression( menu, expression.first, expression.second );
230 }
231 menu->addSeparator();
232 for ( const std::pair< QString, QString > &expression :
233 {
234 std::make_pair( tr( "Current User Name" ), QStringLiteral( "@user_full_name" ) ),
235 std::make_pair( tr( "Current User Account" ), QStringLiteral( "@user_account_name" ) )
236 } )
237 {
238 addExpression( menu, expression.first, expression.second );
239 }
240}
241
243{
245 return false;
246
247 if ( mLabel )
248 {
249 disconnect( mLabel, &QgsLayoutObject::changed, this, &QgsLayoutLabelWidget::setGuiElementValues );
250 }
251
252 mLabel = qobject_cast< QgsLayoutItemLabel * >( item );
253 mItemPropertiesWidget->setItem( mLabel );
254
255 if ( mLabel )
256 {
257 connect( mLabel, &QgsLayoutObject::changed, this, &QgsLayoutLabelWidget::setGuiElementValues );
258 }
259
260 setGuiElementValues();
261
262 return true;
263}
264
265void QgsLayoutLabelWidget::mHtmlCheckBox_stateChanged( int state )
266{
267 if ( mLabel )
268 {
269 mVerticalAlignementLabel->setDisabled( state );
270 mVAlignmentComboBox->setDisabled( state );
271
272 mLabel->beginCommand( tr( "Change Label Mode" ) );
273 mLabel->blockSignals( true );
274 mLabel->setMode( state ? QgsLayoutItemLabel::ModeHtml : QgsLayoutItemLabel::ModeFont );
275 mLabel->setText( mTextEdit->toPlainText() );
276 mLabel->update();
277 mLabel->blockSignals( false );
278 mLabel->endCommand();
279 }
280}
281
282void QgsLayoutLabelWidget::mTextEdit_textChanged()
283{
284 if ( mLabel )
285 {
286 mLabel->beginCommand( tr( "Change Label Text" ), QgsLayoutItem::UndoLabelText );
287 mLabel->blockSignals( true );
288 mLabel->setText( mTextEdit->toPlainText() );
289 mLabel->update();
290 mLabel->blockSignals( false );
291 mLabel->endCommand();
292 }
293}
294
295void QgsLayoutLabelWidget::fontChanged()
296{
297 if ( mLabel )
298 {
299 mLabel->beginCommand( tr( "Change Label Font" ), QgsLayoutItem::UndoLabelFont );
300 mLabel->setTextFormat( mFontButton->textFormat() );
301 mLabel->update();
302 mLabel->endCommand();
303 }
304}
305
306void QgsLayoutLabelWidget::mMarginXDoubleSpinBox_valueChanged( double d )
307{
308 if ( mLabel )
309 {
310 mLabel->beginCommand( tr( "Change Label Margin" ), QgsLayoutItem::UndoLabelMargin );
311 mLabel->setMarginX( d );
312 mLabel->update();
313 mLabel->endCommand();
314 }
315}
316
317void QgsLayoutLabelWidget::mMarginYDoubleSpinBox_valueChanged( double d )
318{
319 if ( mLabel )
320 {
321 mLabel->beginCommand( tr( "Change Label Margin" ), QgsLayoutItem::UndoLabelMargin );
322 mLabel->setMarginY( d );
323 mLabel->update();
324 mLabel->endCommand();
325 }
326}
327
328void QgsLayoutLabelWidget::mInsertExpressionButton_clicked()
329{
330 if ( !mLabel )
331 {
332 return;
333 }
334
335 QString expression = QgsExpressionFinder::findAndSelectActiveExpression( mTextEdit );
336
337 // use the atlas coverage layer, if any
338 QgsVectorLayer *layer = coverageLayer();
339
340 QgsExpressionContext context = mLabel->createExpressionContext();
341 QgsExpressionBuilderDialog exprDlg( layer, expression, this, QStringLiteral( "generic" ), context );
342
343 exprDlg.setWindowTitle( tr( "Insert Expression" ) );
344 if ( exprDlg.exec() == QDialog::Accepted )
345 {
346 expression = exprDlg.expressionText();
347 if ( !expression.isEmpty() )
348 {
349 mLabel->beginCommand( tr( "Insert expression" ) );
350 mTextEdit->insertPlainText( "[%" + expression.trimmed() + "%]" );
351 mLabel->endCommand();
352 }
353 }
354}
355
356void QgsLayoutLabelWidget::horizontalAlignmentChanged()
357{
358 if ( mLabel )
359 {
360 mLabel->beginCommand( tr( "Change Label Alignment" ) );
361 mLabel->setHAlign( static_cast< Qt::AlignmentFlag >( static_cast< int >( mHAlignmentComboBox->currentAlignment() ) ) );
362 mLabel->update();
363 mLabel->endCommand();
364 }
365}
366
367void QgsLayoutLabelWidget::verticalAlignmentChanged()
368{
369 if ( mLabel )
370 {
371 mLabel->beginCommand( tr( "Change Label Alignment" ) );
372 mLabel->setVAlign( static_cast< Qt::AlignmentFlag >( static_cast< int >( mVAlignmentComboBox->currentAlignment() ) ) );
373 mLabel->update();
374 mLabel->endCommand();
375 }
376}
377
378void QgsLayoutLabelWidget::setGuiElementValues()
379{
380 blockAllSignals( true );
381 mTextEdit->setPlainText( mLabel->text() );
382 mTextEdit->moveCursor( QTextCursor::End, QTextCursor::MoveAnchor );
383 mMarginXDoubleSpinBox->setValue( mLabel->marginX() );
384 mMarginYDoubleSpinBox->setValue( mLabel->marginY() );
385 mHtmlCheckBox->setChecked( mLabel->mode() == QgsLayoutItemLabel::ModeHtml );
386
387 mHAlignmentComboBox->setCurrentAlignment( mLabel->hAlign() );
388 mVAlignmentComboBox->setCurrentAlignment( mLabel->vAlign() );
389
390 mFontButton->setTextFormat( mLabel->textFormat() );
391 mVerticalAlignementLabel->setDisabled( mLabel->mode() == QgsLayoutItemLabel::ModeHtml );
392 mVAlignmentComboBox->setDisabled( mLabel->mode() == QgsLayoutItemLabel::ModeHtml );
393
394 blockAllSignals( false );
395}
396
397void QgsLayoutLabelWidget::blockAllSignals( bool block )
398{
399 mTextEdit->blockSignals( block );
400 mHtmlCheckBox->blockSignals( block );
401 mMarginXDoubleSpinBox->blockSignals( block );
402 mMarginYDoubleSpinBox->blockSignals( block );
403 mHAlignmentComboBox->blockSignals( block );
404 mVAlignmentComboBox->blockSignals( block );
405 mFontButton->blockSignals( block );
406}
void changed()
Emitted when the alignment is changed.
A generic dialog for building expression strings.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
static QString findAndSelectActiveExpression(QgsCodeEditor *editor, const QString &pattern=QString())
Find the expression under the cursor in the given editor and select it.
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:53
Container of fields for a vector layer.
Definition qgsfields.h:46
@ ModeTextRenderer
Configure font settings for use with QgsTextRenderer.
void setLayer(QgsVectorLayer *layer)
Sets a layer to associate with the widget.
void changed()
Emitted when the widget's text format settings are changed.
A base class for property widgets for layout items.
QgsVectorLayer * coverageLayer() const
Returns the current layout context coverage layer (if set).
A layout item subclass for text labels.
void convertToStaticText()
Converts the label's text() to a static string, by evaluating any expressions included in the text an...
@ ModeHtml
Label displays rendered HTML content.
Layout graphical items for displaying a map.
A widget for controlling the common properties of layout items (e.g.
void setMasterLayout(QgsMasterLayoutInterface *masterLayout)
Sets the master layout associated with the item.
void setItem(QgsLayoutItem *item)
Sets the layout item.
Base class for graphical items within a QgsLayout.
@ UndoLabelMargin
Label margin.
@ UndoLabelFont
Label font.
@ UndoLabelText
Label text.
int type() const override
Returns a unique graphics item type identifier.
void setMasterLayout(QgsMasterLayoutInterface *masterLayout) override
Sets the master layout associated with the item.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
bool setNewItem(QgsLayoutItem *item) override
Attempts to update the widget to show the properties for the specified item.
QgsLayoutLabelWidget(QgsLayoutItemLabel *label)
constructor
static void buildInsertDynamicTextMenu(QgsLayout *layout, QMenu *menu, const std::function< void(const QString &expression) > &callback)
Populates the specified menu with actions reflecting dynamic text expressions applicable for a layout...
void changed()
Emitted when the object's properties change.
void layerChanged(QgsVectorLayer *layer)
Emitted when the context's layer is changed.
QgsVectorLayer * layer() const
Returns the vector layer associated with the layout's context.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:49
void layoutItems(QList< T * > &itemList) const
Returns a list of layout items of a specific type.
Definition qgslayout.h:120
QgsLayoutReportContext & reportContext()
Returns a reference to the layout's report context, which stores information relating to the current ...
Interface for master layout type objects, such as print layouts and reports.
void setPanelTitle(const QString &panelTitle)
Set the title of the panel when shown in the interface.
A class to represent a 2D point.
Definition qgspointxy.h:60
double y
Definition qgspointxy.h:64
double x
Definition qgspointxy.h:63
A rectangle specified with double values.
double xMinimum() const
Returns the x minimum value (left side of rectangle).
double yMinimum() const
Returns the y minimum value (bottom side of rectangle).
double xMaximum() const
Returns the x maximum value (right side of rectangle).
double yMaximum() const
Returns the y maximum value (top side of rectangle).
QgsPointXY center() const
Returns the center point of the rectangle.
static Q_INVOKABLE QString toString(Qgis::DistanceUnit unit)
Returns a translated string representing a distance unit.
Represents a vector layer which manages a vector based data sets.