QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
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#include "moc_qgslabelengineconfigdialog.cpp"
17
19#include "qgsproject.h"
20#include "pal/pal.h"
21#include "qgshelp.h"
22#include "qgsmessagebar.h"
23#include "qgsmapcanvas.h"
24#include "qgsgui.h"
25#include "qgsapplication.h"
26#include "qgsrendercontext.h"
27#include <QAction>
28#include <QDialogButtonBox>
29#include <QPushButton>
30#include <QMessageBox>
31#include <QMenu>
32
34 : QgsPanelWidget( parent ), mCanvas( canvas )
35{
36 setupUi( this );
37
38 setPanelTitle( tr( "Placement Engine Settings" ) );
39
40 mMessageBar = new QgsMessageBar();
41 mMessageBar->setSizePolicy( QSizePolicy::Minimum, QSizePolicy::Fixed );
42 verticalLayout->insertWidget( 0, mMessageBar );
43
45
46 mTextRenderFormatComboBox->addItem( tr( "Always Render Labels as Paths (Recommended)" ), QVariant::fromValue( Qgis::TextRenderFormat::AlwaysOutlines ) );
47 mTextRenderFormatComboBox->addItem( tr( "Always Render Labels as Text" ), QVariant::fromValue( Qgis::TextRenderFormat::AlwaysText ) );
48 mTextRenderFormatComboBox->addItem( tr( "Prefer Rendering Labels as Text" ), QVariant::fromValue( Qgis::TextRenderFormat::PreferText ) );
49
50 mPlacementVersionComboBox->addItem( tr( "Version 1" ), static_cast< int >( Qgis::LabelPlacementEngineVersion::Version1 ) );
51 mPlacementVersionComboBox->addItem( tr( "Version 2 (Recommended)" ), static_cast< int >( Qgis::LabelPlacementEngineVersion::Version2 ) );
52
53 mPreviousEngineVersion = engineSettings.placementVersion();
54 mPlacementVersionComboBox->setCurrentIndex( mPlacementVersionComboBox->findData( static_cast< int >( mPreviousEngineVersion ) ) );
55 connect( mPlacementVersionComboBox, &QComboBox::currentTextChanged, this, [ = ]()
56 {
57 if ( static_cast< Qgis::LabelPlacementEngineVersion >( mPlacementVersionComboBox->currentData().toInt() ) != mPreviousEngineVersion )
58 {
59 mMessageBar->pushMessage( QString(), tr( "Version changes will alter label placement in the project." ), Qgis::MessageLevel::Warning );
60 }
61 } );
62
63 spinCandLine->setClearValue( 5 );
64 spinCandPolygon->setClearValue( 2.5 );
65
66 // candidate numbers
67 spinCandLine->setValue( engineSettings.maximumLineCandidatesPerCm() );
68 spinCandPolygon->setValue( engineSettings.maximumPolygonCandidatesPerCmSquared() );
69
70 chkShowCandidates->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::DrawCandidates ) );
71 chkShowMetrics->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::DrawLabelMetrics ) );
72 chkShowAllLabels->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::UseAllLabels ) );
73 chkShowUnplaced->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::DrawUnplacedLabels ) );
74 chkShowPartialsLabels->setChecked( engineSettings.testFlag( Qgis::LabelingFlag::UsePartialCandidates ) );
75
76 mUnplacedColorButton->setColor( engineSettings.unplacedLabelColor() );
77 mUnplacedColorButton->setAllowOpacity( false );
78 mUnplacedColorButton->setDefaultColor( QColor( 255, 0, 0 ) );
79 mUnplacedColorButton->setWindowTitle( tr( "Unplaced Label Color" ) );
80
81 mTextRenderFormatComboBox->setCurrentIndex( mTextRenderFormatComboBox->findData( QVariant::fromValue( engineSettings.defaultTextRenderFormat() ) ) );
82
83 connect( spinCandLine, qOverload<double>( &QgsDoubleSpinBox::valueChanged ), this, &QgsLabelEngineConfigWidget::widgetChanged );
84 connect( spinCandPolygon, qOverload<double>( &QgsDoubleSpinBox::valueChanged ), this, &QgsLabelEngineConfigWidget::widgetChanged );
85 connect( chkShowCandidates, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
86 connect( chkShowAllLabels, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
87 connect( chkShowUnplaced, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
88 connect( chkShowPartialsLabels, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
89 connect( chkShowMetrics, &QCheckBox::toggled, this, &QgsLabelEngineConfigWidget::widgetChanged );
90 connect( mTextRenderFormatComboBox, qOverload<int>( &QComboBox::currentIndexChanged ), this, &QgsLabelEngineConfigWidget::widgetChanged );
91 connect( mUnplacedColorButton, &QgsColorButton::colorChanged, this, &QgsLabelEngineConfigWidget::widgetChanged );
92 connect( mPlacementVersionComboBox, qOverload<int>( &QComboBox::currentIndexChanged ), this, &QgsLabelEngineConfigWidget::widgetChanged );
93
94 mWidgetMenu = new QMenu( this );
95 QAction *resetAction = new QAction( tr( "Restore Defaults" ), this );
96 mWidgetMenu->addAction( resetAction );
97 connect( resetAction, &QAction::triggered, this, &QgsLabelEngineConfigWidget::setDefaults );
98 QAction *helpAction = new QAction( QgsApplication::getThemeIcon( QStringLiteral( "/mActionHelpContents.svg" ) ), tr( "Help…" ), this );
99 mWidgetMenu->addAction( helpAction );
100 connect( helpAction, &QAction::triggered, this, &QgsLabelEngineConfigWidget::showHelp );
101}
102
104{
105 return mWidgetMenu;
106}
107
109{
110 return tr( "Additional Options" );
111}
112
114{
116
117 // save
118 engineSettings.setMaximumLineCandidatesPerCm( spinCandLine->value() );
119 engineSettings.setMaximumPolygonCandidatesPerCmSquared( spinCandPolygon->value() );
120
121 engineSettings.setFlag( Qgis::LabelingFlag::DrawCandidates, chkShowCandidates->isChecked() );
122 engineSettings.setFlag( Qgis::LabelingFlag::UseAllLabels, chkShowAllLabels->isChecked() );
123 engineSettings.setFlag( Qgis::LabelingFlag::DrawUnplacedLabels, chkShowUnplaced->isChecked() );
124 engineSettings.setFlag( Qgis::LabelingFlag::UsePartialCandidates, chkShowPartialsLabels->isChecked() );
125 engineSettings.setFlag( Qgis::LabelingFlag::DrawLabelMetrics, chkShowMetrics->isChecked() );
126
127 engineSettings.setDefaultTextRenderFormat( mTextRenderFormatComboBox->currentData().value< Qgis::TextRenderFormat >() );
128
129 engineSettings.setUnplacedLabelColor( mUnplacedColorButton->color() );
130
131 engineSettings.setPlacementVersion( static_cast< Qgis::LabelPlacementEngineVersion>( mPlacementVersionComboBox->currentData().toInt() ) );
132
134 mCanvas->refreshAllLayers();
135}
136
138{
139 const pal::Pal p;
140 spinCandLine->setValue( 5 );
141 spinCandPolygon->setValue( 10 );
142 chkShowCandidates->setChecked( false );
143 chkShowMetrics->setChecked( false );
144 chkShowAllLabels->setChecked( false );
145 chkShowPartialsLabels->setChecked( p.showPartialLabels() );
146 mTextRenderFormatComboBox->setCurrentIndex( mTextRenderFormatComboBox->findData( QVariant::fromValue( Qgis::TextRenderFormat::AlwaysOutlines ) ) );
147 mPlacementVersionComboBox->setCurrentIndex( mPlacementVersionComboBox->findData( static_cast< int >( Qgis::LabelPlacementEngineVersion::Version2 ) ) );
148}
149
151{
152 QgsHelp::openHelp( QStringLiteral( "working_with_vector/vector_properties.html#setting-the-automated-placement-engine" ) );
153}
154
155//
156// QgsLabelEngineConfigDialog
157//
158
160 : QDialog( parent )
161{
162 mWidget = new QgsLabelEngineConfigWidget( canvas );
163 setWindowTitle( mWidget->windowTitle() );
164 QVBoxLayout *vLayout = new QVBoxLayout();
165 vLayout->addWidget( mWidget );
166 QDialogButtonBox *bbox = new QDialogButtonBox( QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Help | QDialogButtonBox::RestoreDefaults, Qt::Horizontal );
167 connect( bbox, &QDialogButtonBox::accepted, this, &QDialog::accept );
168 connect( bbox, &QDialogButtonBox::rejected, this, &QDialog::reject );
169 connect( bbox, &QDialogButtonBox::helpRequested, mWidget, &QgsLabelEngineConfigWidget::showHelp );
170 connect( bbox->button( QDialogButtonBox::RestoreDefaults ), &QAbstractButton::clicked,
172 vLayout->addWidget( bbox );
173 setLayout( vLayout );
174
175 setObjectName( QStringLiteral( "QgsLabelSettingsWidgetDialog" ) );
177}
178
180{
181 mWidget->apply();
182 QDialog::accept();
183}
@ DrawCandidates
Whether to draw rectangles of generated candidates (good for debugging)
@ DrawLabelMetrics
Whether to render label metric guides (for debugging)
@ 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:2624
@ PreferText
Render text as text objects, unless doing so results in rendering artifacts or poor quality rendering...
@ AlwaysOutlines
Always render text using path objects (AKA outlines/curves). This setting guarantees the best quality...
@ AlwaysText
Always render text as text objects. While this mode preserves text objects as text for post-processin...
LabelPlacementEngineVersion
Labeling placement engine version.
Definition qgis.h:2670
@ Version2
Version 2 (default for new projects since QGIS 3.12)
@ Version1
Version 1, matches placement from QGIS <= 3.10.1.
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:209
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Definition qgshelp.cpp:39
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.
void refreshAllLayers()
Reload all layers (including refreshing layer properties from their data sources),...
A bar for displaying non-blocking messages to the user.
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.
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:83
bool showPartialLabels() const
Returns whether partial labels should be allowed.
Definition pal.cpp:797