QGIS API Documentation 3.29.0-Master (8c80f25a4f)
qgslabelengineconfigdialog.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslabelengineconfigdialog.cpp
3 ---------------------
4 begin : May 2010
5 copyright : (C) 2010 by Marco Hugentobler
6 email : marco dot hugentobler at sourcepole dot ch
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
16
18#include "qgsproject.h"
19#include "pal/pal.h"
20#include "qgshelp.h"
21#include "qgsmessagebar.h"
22#include "qgsmapcanvas.h"
23#include "qgsgui.h"
24#include "qgsapplication.h"
25#include "qgsrendercontext.h"
26#include <QAction>
27#include <QDialogButtonBox>
28#include <QPushButton>
29#include <QMessageBox>
30#include <QMenu>
31
33 : QgsPanelWidget( parent ), mCanvas( canvas )
34{
35 setupUi( this );
36
37 setPanelTitle( tr( "Placement Engine Settings" ) );
38
39 mMessageBar = new QgsMessageBar();
40 mMessageBar->setSizePolicy( QSizePolicy::Minimum, QSizePolicy::Fixed );
41 verticalLayout->insertWidget( 0, mMessageBar );
42
44
45 mTextRenderFormatComboBox->addItem( tr( "Always Render Labels as Paths (Recommended)" ), static_cast< int >( Qgis::TextRenderFormat::AlwaysOutlines ) );
46 mTextRenderFormatComboBox->addItem( tr( "Always Render Labels as Text" ), static_cast< int >( Qgis::TextRenderFormat::AlwaysText ) );
47
48 mPlacementVersionComboBox->addItem( tr( "Version 1" ), static_cast< int >( Qgis::LabelPlacementEngineVersion::Version1 ) );
49 mPlacementVersionComboBox->addItem( tr( "Version 2 (Recommended)" ), static_cast< int >( Qgis::LabelPlacementEngineVersion::Version2 ) );
50
51 mPreviousEngineVersion = engineSettings.placementVersion();
52 mPlacementVersionComboBox->setCurrentIndex( mPlacementVersionComboBox->findData( static_cast< int >( mPreviousEngineVersion ) ) );
53 connect( mPlacementVersionComboBox, &QComboBox::currentTextChanged, this, [ = ]()
54 {
55 if ( static_cast< Qgis::LabelPlacementEngineVersion >( mPlacementVersionComboBox->currentData().toInt() ) != mPreviousEngineVersion )
56 {
57 mMessageBar->pushMessage( QString(), tr( "Version changes will alter label placement in the project." ), Qgis::MessageLevel::Warning );
58 }
59 } );
60
61 spinCandLine->setClearValue( 5 );
62 spinCandPolygon->setClearValue( 2.5 );
63
64 // candidate numbers
65 spinCandLine->setValue( engineSettings.maximumLineCandidatesPerCm() );
66 spinCandPolygon->setValue( engineSettings.maximumPolygonCandidatesPerCmSquared() );
67
68 chkShowCandidates->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::DrawCandidates ) );
69 chkShowMetrics->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::DrawLabelMetrics ) );
70 chkShowAllLabels->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::UseAllLabels ) );
71 chkShowUnplaced->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::DrawUnplacedLabels ) );
72 chkShowPartialsLabels->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::UsePartialCandidates ) );
73
74 mUnplacedColorButton->setColor( engineSettings.unplacedLabelColor() );
75 mUnplacedColorButton->setAllowOpacity( false );
76 mUnplacedColorButton->setDefaultColor( QColor( 255, 0, 0 ) );
77 mUnplacedColorButton->setWindowTitle( tr( "Unplaced Label Color" ) );
78
79 mTextRenderFormatComboBox->setCurrentIndex( mTextRenderFormatComboBox->findData( static_cast< int >( engineSettings.defaultTextRenderFormat() ) ) );
80
81 connect( spinCandLine, qOverload<double>( &QgsDoubleSpinBox::valueChanged ), this, &QgsLabelEngineConfigWidget::widgetChanged );
82 connect( spinCandPolygon, qOverload<double>( &QgsDoubleSpinBox::valueChanged ), this, &QgsLabelEngineConfigWidget::widgetChanged );
83 connect( chkShowCandidates, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
84 connect( chkShowAllLabels, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
85 connect( chkShowUnplaced, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
86 connect( chkShowPartialsLabels, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
87 connect( chkShowMetrics, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
88 connect( mTextRenderFormatComboBox, qOverload<int>( &QComboBox::currentIndexChanged ), this, &QgsLabelEngineConfigWidget::widgetChanged );
89 connect( mUnplacedColorButton, &QgsColorButton::colorChanged, this, &QgsLabelEngineConfigWidget::widgetChanged );
90 connect( mPlacementVersionComboBox, qOverload<int>( &QComboBox::currentIndexChanged ), this, &QgsLabelEngineConfigWidget::widgetChanged );
91
92 mWidgetMenu = new QMenu( this );
93 QAction *resetAction = new QAction( tr( "Restore Defaults" ), this );
94 mWidgetMenu->addAction( resetAction );
95 connect( resetAction, &QAction::triggered, this, &QgsLabelEngineConfigWidget::setDefaults );
96 QAction *helpAction = new QAction( QgsApplication::getThemeIcon( QStringLiteral( "/mActionHelpContents.svg" ) ), tr( "Help…" ), this );
97 mWidgetMenu->addAction( helpAction );
98 connect( helpAction, &QAction::triggered, this, &QgsLabelEngineConfigWidget::showHelp );
99}
100
102{
103 return mWidgetMenu;
104}
105
107{
108 return tr( "Additional Options" );
109}
110
112{
113 QgsLabelingEngineSettings engineSettings;
114
115 // save
116 engineSettings.setMaximumLineCandidatesPerCm( spinCandLine->value() );
117 engineSettings.setMaximumPolygonCandidatesPerCmSquared( spinCandPolygon->value() );
118
119 engineSettings.setFlag( Qgis::LabelingFlag::DrawCandidates, chkShowCandidates->isChecked() );
120 engineSettings.setFlag( Qgis::LabelingFlag::UseAllLabels, chkShowAllLabels->isChecked() );
121 engineSettings.setFlag( Qgis::LabelingFlag::DrawUnplacedLabels, chkShowUnplaced->isChecked() );
122 engineSettings.setFlag( Qgis::LabelingFlag::UsePartialCandidates, chkShowPartialsLabels->isChecked() );
123 engineSettings.setFlag( Qgis::LabelingFlag::DrawLabelMetrics, chkShowMetrics->isChecked() );
124
125 engineSettings.setDefaultTextRenderFormat( static_cast< Qgis::TextRenderFormat >( mTextRenderFormatComboBox->currentData().toInt() ) );
126
127 engineSettings.setUnplacedLabelColor( mUnplacedColorButton->color() );
128
129 engineSettings.setPlacementVersion( static_cast< Qgis::LabelPlacementEngineVersion>( mPlacementVersionComboBox->currentData().toInt() ) );
130
132 mCanvas->refreshAllLayers();
133}
134
136{
137 const pal::Pal p;
138 spinCandLine->setValue( 5 );
139 spinCandPolygon->setValue( 10 );
140 chkShowCandidates->setChecked( false );
141 chkShowMetrics->setChecked( false );
142 chkShowAllLabels->setChecked( false );
143 chkShowPartialsLabels->setChecked( p.showPartialLabels() );
144 mTextRenderFormatComboBox->setCurrentIndex( mTextRenderFormatComboBox->findData( static_cast< int >( Qgis::TextRenderFormat::AlwaysOutlines ) ) );
145 mPlacementVersionComboBox->setCurrentIndex( mPlacementVersionComboBox->findData( static_cast< int >( Qgis::LabelPlacementEngineVersion::Version2 ) ) );
146}
147
149{
150 QgsHelp::openHelp( QStringLiteral( "working_with_vector/vector_properties.html#setting-the-automated-placement-engine" ) );
151}
152
153//
154// QgsLabelEngineConfigDialog
155//
156
158 : QDialog( parent )
159{
160 mWidget = new QgsLabelEngineConfigWidget( canvas );
161 setWindowTitle( mWidget->windowTitle() );
162 QVBoxLayout *vLayout = new QVBoxLayout();
163 vLayout->addWidget( mWidget );
164 QDialogButtonBox *bbox = new QDialogButtonBox( QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Help | QDialogButtonBox::RestoreDefaults, Qt::Horizontal );
165 connect( bbox, &QDialogButtonBox::accepted, this, &QDialog::accept );
166 connect( bbox, &QDialogButtonBox::rejected, this, &QDialog::reject );
167 connect( bbox, &QDialogButtonBox::helpRequested, mWidget, &QgsLabelEngineConfigWidget::showHelp );
168 connect( bbox->button( QDialogButtonBox::RestoreDefaults ), &QAbstractButton::clicked,
170 vLayout->addWidget( bbox );
171 setLayout( vLayout );
172
173 setObjectName( QStringLiteral( "QgsLabelSettingsWidgetDialog" ) );
175}
176
178{
179 mWidget->apply();
180 QDialog::accept();
181}
@ DrawCandidates
Whether to draw rectangles of generated candidates (good for debugging)
@ DrawLabelMetrics
Whether to render label metric guides (for debugging). Since QGIS 3.30.
@ DrawUnplacedLabels
Whether to render unplaced labels as an indicator/warning for users.
@ UseAllLabels
Whether to draw all labels even if there would be collisions.
@ UsePartialCandidates
Whether to use also label candidates that are partially outside of the map view.
TextRenderFormat
Options for rendering text.
Definition: qgis.h:1557
LabelPlacementEngineVersion
Labeling placement engine version.
Definition: qgis.h:1602
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
void colorChanged(const QColor &color)
Emitted whenever a new color is set for the button.
static void enableAutoGeometryRestore(QWidget *widget, const QString &key=QString())
Register the widget to allow its position to be automatically saved and restored when open and closed...
Definition: qgsgui.cpp:178
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Definition: qgshelp.cpp:38
QgsLabelEngineConfigDialog(QgsMapCanvas *canvas, QWidget *parent=nullptr)
constructor
Widget for configuring the labeling engine.
QMenu * menuButtonMenu() override
Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.
QString menuButtonTooltip() const override
Returns the (translated) tooltip text to use for the menu button for this panel.
QgsLabelEngineConfigWidget(QgsMapCanvas *canvas, QWidget *parent=nullptr)
constructor
void setDefaults()
Resets the settings to the defaults.
Stores global configuration for labeling engine.
Qgis::TextRenderFormat defaultTextRenderFormat() const
Returns the default text rendering format for the labels.
void setDefaultTextRenderFormat(Qgis::TextRenderFormat format)
Sets the default text rendering format for the labels.
void setFlag(Qgis::LabelingFlag f, bool enabled=true)
Sets whether a particual flag is enabled.
void setPlacementVersion(Qgis::LabelPlacementEngineVersion version)
Sets the placement engine version, which dictates how the label placement problem is solved.
void setMaximumPolygonCandidatesPerCmSquared(double candidates)
Sets the maximum number of polygon label candidates per centimeter squared.
QColor unplacedLabelColor() const
Returns the color to use when rendering unplaced labels.
Qgis::LabelPlacementEngineVersion placementVersion() const
Returns the placement engine version, which dictates how the label placement problem is solved.
bool testFlag(Qgis::LabelingFlag f) const
Test whether a particular flag is enabled.
void setUnplacedLabelColor(const QColor &color)
Sets the color to use when rendering unplaced labels.
double maximumPolygonCandidatesPerCmSquared() const
Returns the maximum number of polygon label candidate positions per centimeter squared.
void setMaximumLineCandidatesPerCm(double candidates)
Sets the maximum number of line label candidates per centimeter.
double maximumLineCandidatesPerCm() const
Returns the maximum number of line label candidate positions per centimeter.
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:90
void refreshAllLayers()
Reload all layers (including refreshing layer properties from their data sources),...
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:61
Base class for any widget that can be shown as a inline panel.
void widgetChanged()
Emitted when the widget state changes.
void setPanelTitle(const QString &panelTitle)
Set the title of the panel when shown in the interface.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:476
void setLabelingEngineSettings(const QgsLabelingEngineSettings &settings)
Sets project's global labeling engine settings.
const QgsLabelingEngineSettings & labelingEngineSettings() const
Returns project's global labeling engine settings.
Main Pal labeling class.
Definition: pal.h:79
bool showPartialLabels() const
Returns whether partial labels should be allowed.
Definition: pal.cpp:675