QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
qgslayoutpropertieswidget.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutpropertieswidget.cpp
3 -----------------------------
4 begin : July 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8/***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16
18#include "moc_qgslayoutpropertieswidget.cpp"
19#include "qgslayout.h"
20#include "qgslayoutsnapper.h"
22#include "qgslayoutundostack.h"
23#include "qgslayoutitemmap.h"
25#include "qgsprintlayout.h"
26#include "qgslayoutatlas.h"
28#include "qgsmargins.h"
29
31 : QgsPanelWidget( parent )
32 , mLayout( layout )
33{
34 Q_ASSERT( mLayout );
35
36 setupUi( this );
37 setPanelTitle( tr( "Layout Properties" ) );
38 blockSignals( true );
39
40 mVariableEditor->setMinimumHeight( mVariableEditor->fontMetrics().height() * 15 );
41
42 updateSnappingElements();
43
44 mGridSpacingUnitsCombo->linkToWidget( mGridResolutionSpinBox );
45 mGridOffsetUnitsComboBox->linkToWidget( mOffsetXSpinBox );
46 mGridOffsetUnitsComboBox->linkToWidget( mOffsetYSpinBox );
47
48 blockSignals( false );
49
50 connect( mSnapToleranceSpinBox, static_cast < void ( QSpinBox::* )( int ) > ( &QSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::snapToleranceChanged );
51
52 connect( mGridOffsetUnitsComboBox, &QgsLayoutUnitsComboBox::unitChanged, this, &QgsLayoutPropertiesWidget::gridOffsetUnitsChanged );
53 connect( mGridSpacingUnitsCombo, &QgsLayoutUnitsComboBox::unitChanged, this, &QgsLayoutPropertiesWidget::gridResolutionUnitsChanged );
54 connect( mGridResolutionSpinBox, static_cast < void ( QgsDoubleSpinBox::* )( double ) > ( &QgsDoubleSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::gridResolutionChanged );
55 connect( mOffsetXSpinBox, static_cast < void ( QgsDoubleSpinBox::* )( double ) > ( &QgsDoubleSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::gridOffsetXChanged );
56 connect( mOffsetYSpinBox, static_cast < void ( QgsDoubleSpinBox::* )( double ) > ( &QgsDoubleSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::gridOffsetYChanged );
57
58 const double leftMargin = mLayout->customProperty( QStringLiteral( "resizeToContentsLeftMargin" ) ).toDouble();
59 const double topMargin = mLayout->customProperty( QStringLiteral( "resizeToContentsTopMargin" ) ).toDouble();
60 const double bottomMargin = mLayout->customProperty( QStringLiteral( "resizeToContentsBottomMargin" ) ).toDouble();
61 const double rightMargin = mLayout->customProperty( QStringLiteral( "resizeToContentsRightMargin" ) ).toDouble();
62 const Qgis::LayoutUnit marginUnit = static_cast< Qgis::LayoutUnit >(
63 mLayout->customProperty( QStringLiteral( "imageCropMarginUnit" ), static_cast< int >( Qgis::LayoutUnit::Millimeters ) ).toInt() );
64
65 const bool exportWorldFile = mLayout->customProperty( QStringLiteral( "exportWorldFile" ), false ).toBool();
66 mGenerateWorldFileCheckBox->setChecked( exportWorldFile );
67 connect( mGenerateWorldFileCheckBox, &QCheckBox::toggled, this, &QgsLayoutPropertiesWidget::worldFileToggled );
68
69 connect( mRasterizeCheckBox, &QCheckBox::toggled, this, &QgsLayoutPropertiesWidget::rasterizeToggled );
70 connect( mForceVectorCheckBox, &QCheckBox::toggled, this, &QgsLayoutPropertiesWidget::forceVectorToggled );
71
72 mTopMarginSpinBox->setValue( topMargin );
73 mMarginUnitsComboBox->linkToWidget( mTopMarginSpinBox );
74 mRightMarginSpinBox->setValue( rightMargin );
75 mMarginUnitsComboBox->linkToWidget( mRightMarginSpinBox );
76 mBottomMarginSpinBox->setValue( bottomMargin );
77 mMarginUnitsComboBox->linkToWidget( mBottomMarginSpinBox );
78 mLeftMarginSpinBox->setValue( leftMargin );
79 mMarginUnitsComboBox->linkToWidget( mLeftMarginSpinBox );
80 mMarginUnitsComboBox->setUnit( marginUnit );
81 mMarginUnitsComboBox->setConverter( &mLayout->renderContext().measurementConverter() );
82
83 connect( mTopMarginSpinBox, static_cast < void ( QDoubleSpinBox::* )( double ) > ( &QDoubleSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::resizeMarginsChanged );
84 connect( mRightMarginSpinBox, static_cast < void ( QDoubleSpinBox::* )( double ) > ( &QDoubleSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::resizeMarginsChanged );
85 connect( mBottomMarginSpinBox, static_cast < void ( QDoubleSpinBox::* )( double ) > ( &QDoubleSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::resizeMarginsChanged );
86 connect( mLeftMarginSpinBox, static_cast < void ( QDoubleSpinBox::* )( double ) > ( &QDoubleSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::resizeMarginsChanged );
87 connect( mResizePageButton, &QPushButton::clicked, this, &QgsLayoutPropertiesWidget::resizeToContents );
88
89 connect( mResolutionSpinBox, static_cast < void ( QSpinBox::* )( int ) > ( &QSpinBox::valueChanged ), this, &QgsLayoutPropertiesWidget::dpiChanged );
90
91 mReferenceMapComboBox->setCurrentLayout( mLayout );
92 mReferenceMapComboBox->setItemType( QgsLayoutItemRegistry::LayoutMap );
93 connect( mReferenceMapComboBox, &QgsLayoutItemComboBox::itemChanged, this, &QgsLayoutPropertiesWidget::referenceMapChanged );
94
96
97 updateVariables();
98 connect( mVariableEditor, &QgsVariableEditorWidget::scopeChanged, this, &QgsLayoutPropertiesWidget::variablesChanged );
99 // listen out for variable edits
100 connect( QgsApplication::instance(), &QgsApplication::customVariablesChanged, this, &QgsLayoutPropertiesWidget::updateVariables );
101 connect( QgsProject::instance(), &QgsProject::customVariablesChanged, this, &QgsLayoutPropertiesWidget::updateVariables );
102 connect( QgsProject::instance(), &QgsProject::metadataChanged, this, &QgsLayoutPropertiesWidget::updateVariables );
103 connect( &mLayout->renderContext(), &QgsLayoutRenderContext::dpiChanged, this, &QgsLayoutPropertiesWidget::updateVariables );
104 connect( mLayout->pageCollection(), &QgsLayoutPageCollection::changed, this, &QgsLayoutPropertiesWidget::updateVariables );
105 connect( mLayout, &QgsLayout::variablesChanged, this, &QgsLayoutPropertiesWidget::updateVariables );
106
107 updateGui();
108}
109
111{
112 if ( QgsPrintLayout *printLayout = dynamic_cast< QgsPrintLayout * >( masterLayout ) )
113 {
114 connect( printLayout, &QgsPrintLayout::nameChanged, this, &QgsLayoutPropertiesWidget::updateVariables );
115 connect( printLayout->atlas(), &QgsLayoutAtlas::coverageLayerChanged, this, &QgsLayoutPropertiesWidget::updateVariables );
116 }
117}
118
120{
121 whileBlocking( mReferenceMapComboBox )->setItem( mLayout->referenceMap() );
122 whileBlocking( mResolutionSpinBox )->setValue( mLayout->renderContext().dpi() );
123
124 const bool rasterize = mLayout->customProperty( QStringLiteral( "rasterize" ), false ).toBool();
125 whileBlocking( mRasterizeCheckBox )->setChecked( rasterize );
126
127 const bool forceVectors = mLayout->customProperty( QStringLiteral( "forceVector" ), false ).toBool();
128 whileBlocking( mForceVectorCheckBox )->setChecked( forceVectors );
129
130 if ( rasterize )
131 {
132 mForceVectorCheckBox->setChecked( false );
133 mForceVectorCheckBox->setEnabled( false );
134 }
135 else
136 {
137 mForceVectorCheckBox->setEnabled( true );
138 }
139}
140
141void QgsLayoutPropertiesWidget::updateSnappingElements()
142{
143 mSnapToleranceSpinBox->setValue( mLayout->snapper().snapTolerance() );
144
145 mGridSpacingUnitsCombo->setUnit( mLayout->gridSettings().resolution().units() );
146 mGridResolutionSpinBox->setValue( mLayout->gridSettings().resolution().length() );
147
148 mGridOffsetUnitsComboBox->setUnit( mLayout->gridSettings().offset().units() );
149 mOffsetXSpinBox->setValue( mLayout->gridSettings().offset().x() );
150 mOffsetYSpinBox->setValue( mLayout->gridSettings().offset().y() );
151}
152
153void QgsLayoutPropertiesWidget::gridResolutionChanged( double d )
154{
156 m.setLength( d );
157 mLayout->gridSettings().setResolution( m );
158 mLayout->pageCollection()->redraw();
159}
160
161void QgsLayoutPropertiesWidget::gridResolutionUnitsChanged( Qgis::LayoutUnit unit )
162{
164 m.setUnits( unit );
165 mLayout->gridSettings().setResolution( m );
166 mLayout->pageCollection()->redraw();
167}
168
169void QgsLayoutPropertiesWidget::gridOffsetXChanged( double d )
170{
171 QgsLayoutPoint o = mLayout->gridSettings().offset();
172 o.setX( d );
173 mLayout->gridSettings().setOffset( o );
174 mLayout->pageCollection()->redraw();
175}
176
177void QgsLayoutPropertiesWidget::gridOffsetYChanged( double d )
178{
179 QgsLayoutPoint o = mLayout->gridSettings().offset();
180 o.setY( d );
181 mLayout->gridSettings().setOffset( o );
182 mLayout->pageCollection()->redraw();
183}
184
185void QgsLayoutPropertiesWidget::gridOffsetUnitsChanged( Qgis::LayoutUnit unit )
186{
187 QgsLayoutPoint o = mLayout->gridSettings().offset();
188 o.setUnits( unit );
189 mLayout->gridSettings().setOffset( o );
190 mLayout->pageCollection()->redraw();
191}
192
193void QgsLayoutPropertiesWidget::snapToleranceChanged( int tolerance )
194{
195 mLayout->snapper().setSnapTolerance( tolerance );
196}
197
198void QgsLayoutPropertiesWidget::resizeMarginsChanged()
199{
200 mLayout->setCustomProperty( QStringLiteral( "resizeToContentsLeftMargin" ), mLeftMarginSpinBox->value() );
201 mLayout->setCustomProperty( QStringLiteral( "resizeToContentsTopMargin" ), mTopMarginSpinBox->value() );
202 mLayout->setCustomProperty( QStringLiteral( "resizeToContentsBottomMargin" ), mBottomMarginSpinBox->value() );
203 mLayout->setCustomProperty( QStringLiteral( "resizeToContentsRightMargin" ), mRightMarginSpinBox->value() );
204 mLayout->setCustomProperty( QStringLiteral( "imageCropMarginUnit" ), static_cast< int >( mMarginUnitsComboBox->unit() ) );
205}
206
207void QgsLayoutPropertiesWidget::resizeToContents()
208{
209 mLayout->undoStack()->beginMacro( tr( "Resize to Contents" ) );
210
211 mLayout->pageCollection()->resizeToContents( QgsMargins( mLeftMarginSpinBox->value(),
212 mTopMarginSpinBox->value(),
213 mRightMarginSpinBox->value(),
214 mBottomMarginSpinBox->value() ),
215 mMarginUnitsComboBox->unit() );
216
217 mLayout->undoStack()->endMacro();
218}
219
220void QgsLayoutPropertiesWidget::referenceMapChanged( QgsLayoutItem *item )
221{
222 mLayout->undoStack()->beginCommand( mLayout, tr( "Set Reference Map" ) );
223 QgsLayoutItemMap *map = qobject_cast< QgsLayoutItemMap * >( item );
224 mLayout->setReferenceMap( map );
225 mLayout->undoStack()->endCommand();
226}
227
228void QgsLayoutPropertiesWidget::dpiChanged( int value )
229{
230 mLayout->undoStack()->beginCommand( mLayout, tr( "Set Default DPI" ), QgsLayout::UndoLayoutDpi );
231 mLayout->renderContext().setDpi( value );
232 mLayout->undoStack()->endCommand();
233
234 mLayout->refresh();
235}
236
237void QgsLayoutPropertiesWidget::worldFileToggled()
238{
239 mLayout->setCustomProperty( QStringLiteral( "exportWorldFile" ), mGenerateWorldFileCheckBox->isChecked() );
240}
241
242void QgsLayoutPropertiesWidget::rasterizeToggled()
243{
244 mLayout->setCustomProperty( QStringLiteral( "rasterize" ), mRasterizeCheckBox->isChecked() );
245
246 if ( mRasterizeCheckBox->isChecked() )
247 {
248 mForceVectorCheckBox->setChecked( false );
249 mForceVectorCheckBox->setEnabled( false );
250 }
251 else
252 {
253 mForceVectorCheckBox->setEnabled( true );
254 }
255}
256
257void QgsLayoutPropertiesWidget::forceVectorToggled()
258{
259 mLayout->setCustomProperty( QStringLiteral( "forceVector" ), mForceVectorCheckBox->isChecked() );
260}
261
262void QgsLayoutPropertiesWidget::variablesChanged()
263{
264 mBlockVariableUpdates = true;
265 QgsExpressionContextUtils::setLayoutVariables( mLayout, mVariableEditor->variablesInActiveScope() );
266 mBlockVariableUpdates = false;
267}
268
269void QgsLayoutPropertiesWidget::updateVariables()
270{
271 if ( mBlockVariableUpdates )
272 return;
273
274 QgsExpressionContext context;
278 mVariableEditor->setContext( &context );
279 mVariableEditor->setEditableScopeIndex( 2 );
280}
281
282void QgsLayoutPropertiesWidget::blockSignals( bool block )
283{
284 mGridResolutionSpinBox->blockSignals( block );
285 mOffsetXSpinBox->blockSignals( block );
286 mOffsetYSpinBox->blockSignals( block );
287 mSnapToleranceSpinBox->blockSignals( block );
288}
289
LayoutUnit
Layout measurement units.
Definition qgis.h:4867
@ Millimeters
Millimeters.
void customVariablesChanged()
Emitted whenever a custom global variable changes.
static QgsApplication * instance()
Returns the singleton instance of the QgsApplication.
The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value.
static QgsExpressionContextScope * layoutScope(const QgsLayout *layout)
Creates a new scope which contains variables and functions relating to a QgsLayout layout.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static void setLayoutVariables(QgsLayout *layout, const QVariantMap &variables)
Sets all layout context variables.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void coverageLayerChanged(QgsVectorLayer *layer)
Emitted when the coverage layer for the atlas changes.
QgsLayoutMeasurement resolution() const
Returns the page/snap grid resolution.
QgsLayoutPoint offset() const
Returns the offset of the page/snap grid.
void setOffset(const QgsLayoutPoint &offset)
Sets the offset of the page/snap grid.
void setResolution(QgsLayoutMeasurement resolution)
Sets the page/snap grid resolution.
void itemChanged(QgsLayoutItem *item)
Emitted whenever the currently selected item changes.
Layout graphical items for displaying a map.
Base class for graphical items within a QgsLayout.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
void setLength(const double length)
Sets the length of the measurement.
Qgis::LayoutUnit units() const
Returns the units for the measurement.
void setUnits(const Qgis::LayoutUnit units)
Sets the units for the measurement.
double length() const
Returns the length of the measurement.
void changed()
Emitted when pages are added or removed from the collection.
void resizeToContents(const QgsMargins &margins, Qgis::LayoutUnit marginUnits)
Resizes the layout to a single page which fits the current contents of the layout.
void redraw()
Triggers a redraw for all pages.
This class provides a method of storing points, consisting of an x and y coordinate,...
double x() const
Returns x coordinate of point.
void setX(const double x)
Sets the x coordinate of point.
void setUnits(const Qgis::LayoutUnit units)
Sets the units for the point.
double y() const
Returns y coordinate of point.
Qgis::LayoutUnit units() const
Returns the units for the point.
void setY(const double y)
Sets y coordinate of point.
void setMasterLayout(QgsMasterLayoutInterface *masterLayout)
Sets the master layout.
void updateGui()
Refreshes the gui to reflect the current layout settings.
QgsLayoutPropertiesWidget(QWidget *parent, QgsLayout *layout)
constructor
void setDpi(double dpi)
Sets the dpi for outputting the layout.
void dpiChanged()
Emitted when the context's DPI is changed.
double dpi() const
Returns the dpi for outputting the layout.
const QgsLayoutMeasurementConverter & measurementConverter() const
Returns the layout measurement converter to be used in the layout.
int snapTolerance() const
Returns the snap tolerance (in pixels) to use when snapping.
void setSnapTolerance(int snapTolerance)
Sets the snap tolerance (in pixels) to use when snapping.
void endCommand()
Saves final state of an object and pushes the active command to the undo history.
void beginMacro(const QString &commandText)
Starts a macro command, with the given descriptive commandText.
void beginCommand(QgsLayoutUndoObjectInterface *object, const QString &commandText, int id=0)
Begins a new undo command for the specified object.
void endMacro()
Ends a macro command.
void unitChanged(Qgis::LayoutUnit unit)
Emitted when the unit is changed.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:49
void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for the layout.
QgsLayoutSnapper & snapper()
Returns a reference to the layout's snapper, which stores handles layout snap grids and lines and sna...
Definition qgslayout.h:407
QgsLayoutRenderContext & renderContext()
Returns a reference to the layout's render context, which stores information relating to the current ...
QgsLayoutPageCollection * pageCollection()
Returns a pointer to the layout's page collection, which stores and manages page items in the layout.
void variablesChanged()
Emitted whenever the expression variables stored in the layout have been changed.
QgsLayoutItemMap * referenceMap() const
Returns the map item which will be used to generate corresponding world files when the layout is expo...
void changed()
Emitted when properties of the layout change.
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from the layout.
QgsLayoutGridSettings & gridSettings()
Returns a reference to the layout's grid settings, which stores settings relating to grid appearance,...
Definition qgslayout.h:419
void refresh()
Forces the layout, and all items contained within it, to refresh.
void setReferenceMap(QgsLayoutItemMap *map)
Sets the map item which will be used to generate corresponding world files when the layout is exporte...
QgsLayoutUndoStack * undoStack()
Returns a pointer to the layout's undo stack, which manages undo/redo states for the layout and it's ...
@ UndoLayoutDpi
Change layout default DPI.
Definition qgslayout.h:70
The QgsMargins class defines the four margins of a rectangle.
Definition qgsmargins.h:37
Interface for master layout type objects, such as print layouts and reports.
Base class for any widget that can be shown as a inline panel.
void setPanelTitle(const QString &panelTitle)
Set the title of the panel when shown in the interface.
Print layout, a QgsLayout subclass for static or atlas-based layouts.
void nameChanged(const QString &name)
Emitted when the layout's name is changed.
static QgsProject * instance()
Returns the QgsProject singleton instance.
void metadataChanged()
Emitted when the project's metadata is changed.
void customVariablesChanged()
Emitted whenever the expression variables stored in the project have been changed.
void scopeChanged()
Emitted when the user has modified a scope using the widget.
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition qgis.h:5862