QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
qgsvectortilelayerproperties.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectortilelayerproperties.cpp
3 --------------------------------------
4 Date : May 2020
5 Copyright : (C) 2020 by Martin Dobias
6 Email : wonder dot sk at gmail dot com
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 ***************************************************************************/
15
17#include "qgshelp.h"
23#include "qgsvectortilelayer.h"
24#include "qgsvectortileutils.h"
25#include "qgsgui.h"
26#include "qgsapplication.h"
27#include "qgsjsonutils.h"
28#include "qgsmetadatawidget.h"
33
34#include <QFileDialog>
35#include <QMenu>
36#include <QMessageBox>
37#include <QDesktopServices>
38#include <QTextStream>
39
40QgsVectorTileLayerProperties::QgsVectorTileLayerProperties( QgsVectorTileLayer *lyr, QgsMapCanvas *canvas, QgsMessageBar *messageBar, QWidget *parent, Qt::WindowFlags flags )
41 : QgsLayerPropertiesDialog( lyr, canvas, QStringLiteral( "VectorTileLayerProperties" ), parent, flags )
42 , mLayer( lyr )
43{
44 setupUi( this );
45
46 mRendererWidget = new QgsVectorTileBasicRendererWidget( nullptr, canvas, messageBar, this );
47 mOptsPage_Style->layout()->addWidget( mRendererWidget );
48 mOptsPage_Style->layout()->setContentsMargins( 0, 0, 0, 0 );
49
50 mLabelingWidget = new QgsVectorTileBasicLabelingWidget( nullptr, canvas, messageBar, this );
51 mOptsPage_Labeling->layout()->addWidget( mLabelingWidget );
52 mOptsPage_Labeling->layout()->setContentsMargins( 0, 0, 0, 0 );
53
54 connect( this, &QDialog::accepted, this, &QgsVectorTileLayerProperties::apply );
55 connect( this, &QDialog::rejected, this, &QgsVectorTileLayerProperties::rollback );
56 connect( buttonBox->button( QDialogButtonBox::Apply ), &QAbstractButton::clicked, this, &QgsVectorTileLayerProperties::apply );
57 connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsVectorTileLayerProperties::showHelp );
58
59 connect( mCrsSelector, &QgsProjectionSelectionWidget::crsChanged, this, &QgsVectorTileLayerProperties::crsChanged );
60
61 // scale based layer visibility related widgets
62 mScaleRangeWidget->setMapCanvas( mCanvas );
63
64 // QgsOptionsDialogBase handles saving/restoring of geometry, splitter and current tab states,
65 // switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left),
66 // and connecting QDialogButtonBox's accepted/rejected signals to dialog's accept/reject slots
67 initOptionsBase( false );
68
69 mSourceGroupBox->hide();
70
71#ifdef WITH_QTWEBKIT
72 // Setup information tab
73
74 const int horizontalDpi = logicalDpiX();
75
76 // Adjust zoom: text is ok, but HTML seems rather big at least on Linux/KDE
77 if ( horizontalDpi > 96 )
78 {
79 mMetadataViewer->setZoomFactor( mMetadataViewer->zoomFactor() * 0.9 );
80 }
81 mMetadataViewer->page()->setLinkDelegationPolicy( QWebPage::LinkDelegationPolicy::DelegateAllLinks );
82 connect( mMetadataViewer->page(), &QWebPage::linkClicked, this, &QgsVectorTileLayerProperties::openUrl );
83 mMetadataViewer->page()->settings()->setAttribute( QWebSettings::DeveloperExtrasEnabled, true );
84 mMetadataViewer->page()->settings()->setAttribute( QWebSettings::JavascriptEnabled, true );
85
86#endif
87 mOptsPage_Information->setContentsMargins( 0, 0, 0, 0 );
88
89 QVBoxLayout *layout = new QVBoxLayout( metadataFrame );
90 layout->setContentsMargins( 0, 0, 0, 0 );
91 metadataFrame->setContentsMargins( 0, 0, 0, 0 );
92 mMetadataWidget = new QgsMetadataWidget( this, mLayer );
93 mMetadataWidget->layout()->setContentsMargins( 0, 0, 0, 0 );
94 mMetadataWidget->setMapCanvas( mCanvas );
95 layout->addWidget( mMetadataWidget );
96 metadataFrame->setLayout( layout );
97 mOptsPage_Metadata->setContentsMargins( 0, 0, 0, 0 );
98
99 setMetadataWidget( mMetadataWidget, mOptsPage_Metadata );
100
101 // update based on lyr's current state
102 syncToLayer();
103
104 QgsSettings settings;
105 // if dialog hasn't been opened/closed yet, default to Styles tab, which is used most often
106 // this will be read by restoreOptionsBaseUi()
107 if ( !settings.contains( QStringLiteral( "/Windows/VectorTileLayerProperties/tab" ) ) )
108 {
109 settings.setValue( QStringLiteral( "Windows/VectorTileLayerProperties/tab" ),
110 mOptStackedWidget->indexOf( mOptsPage_Style ) );
111 }
112
113 mBtnStyle = new QPushButton( tr( "Style" ) );
114 QMenu *menuStyle = new QMenu( this );
115 menuStyle->addAction( tr( "Load Style…" ), this, &QgsVectorTileLayerProperties::loadStyle );
116 menuStyle->addAction( tr( "Save Style…" ), this, &QgsVectorTileLayerProperties::saveStyleToFile );
117 menuStyle->addSeparator();
118 menuStyle->addAction( tr( "Save as Default" ), this, &QgsVectorTileLayerProperties::saveStyleAsDefault );
119 menuStyle->addAction( tr( "Restore Default" ), this, &QgsVectorTileLayerProperties::loadDefaultStyle );
120 mBtnStyle->setMenu( menuStyle );
121 connect( menuStyle, &QMenu::aboutToShow, this, &QgsVectorTileLayerProperties::aboutToShowStyleMenu );
122
123 buttonBox->addButton( mBtnStyle, QDialogButtonBox::ResetRole );
124
125 mBtnMetadata = new QPushButton( tr( "Metadata" ), this );
126 QMenu *menuMetadata = new QMenu( this );
127 mActionLoadMetadata = menuMetadata->addAction( tr( "Load Metadata…" ), this, &QgsVectorTileLayerProperties::loadMetadataFromFile );
128 mActionSaveMetadataAs = menuMetadata->addAction( tr( "Save Metadata…" ), this, &QgsVectorTileLayerProperties::saveMetadataToFile );
129 mBtnMetadata->setMenu( menuMetadata );
130 buttonBox->addButton( mBtnMetadata, QDialogButtonBox::ResetRole );
131
132 initialize();
133}
134
135void QgsVectorTileLayerProperties::apply()
136{
137 if ( mSourceWidget )
138 {
139 const QString newSource = mSourceWidget->sourceUri();
140 if ( newSource != mLayer->source() )
141 {
142 mLayer->setDataSource( newSource, mLayer->name(), mLayer->providerType(), QgsDataProvider::ProviderOptions() );
143 }
144 }
145
146 mLayer->setName( mLayerOrigNameLineEd->text() );
147 mLayer->setCrs( mCrsSelector->crs() );
148
149 mRendererWidget->apply();
150 mLabelingWidget->apply();
151 mMetadataWidget->acceptMetadata();
152
153 mLayer->setScaleBasedVisibility( chkUseScaleDependentRendering->isChecked() );
154 mLayer->setMinimumScale( mScaleRangeWidget->minimumScale() );
155 mLayer->setMaximumScale( mScaleRangeWidget->maximumScale() );
156}
157
158void QgsVectorTileLayerProperties::syncToLayer()
159{
160 /*
161 * Information Tab
162 */
164 // Inject the stylesheet
165 const QString html { mLayer->htmlMetadata().replace( QLatin1String( "<head>" ), QStringLiteral( R"raw(<head><style type="text/css">%1</style>)raw" ) ).arg( myStyle ) };
166 mMetadataViewer->setHtml( html );
167
168 /*
169 * Source
170 */
171
172 mLayerOrigNameLineEd->setText( mLayer->name() );
173 mCrsSelector->setCrs( mLayer->crs() );
174
175 if ( !mSourceWidget )
176 {
177 mSourceWidget = QgsGui::sourceWidgetProviderRegistry()->createWidget( mLayer );
178 if ( mSourceWidget )
179 {
180 QHBoxLayout *layout = new QHBoxLayout();
181 layout->addWidget( mSourceWidget );
182 mSourceGroupBox->setLayout( layout );
183 mSourceGroupBox->show();
184
185 connect( mSourceWidget, &QgsProviderSourceWidget::validChanged, this, [ = ]( bool isValid )
186 {
187 buttonBox->button( QDialogButtonBox::Apply )->setEnabled( isValid );
188 buttonBox->button( QDialogButtonBox::Ok )->setEnabled( isValid );
189 } );
190 }
191 }
192
193 if ( mSourceWidget )
194 {
195 mSourceWidget->setMapCanvas( mCanvas );
196 mSourceWidget->setSourceUri( mLayer->source() );
197 }
198
199 /*
200 * Symbology Tab
201 */
202 mRendererWidget->syncToLayer( mLayer );
203
204 /*
205 * Labels Tab
206 */
207 mLabelingWidget->setLayer( mLayer );
208
209 /*
210 * Rendering
211 */
212 chkUseScaleDependentRendering->setChecked( mLayer->hasScaleBasedVisibility() );
213 mScaleRangeWidget->setScaleRange( mLayer->minimumScale(), mLayer->maximumScale() );
214}
215
220
222{
223 const QgsSettings settings; // where we keep last used filter in persistent state
224
225 QgsMapLayerLoadStyleDialog dlg( mLayer );
226
227 if ( dlg.exec() )
228 {
229 mOldStyle = mLayer->styleManager()->style( mLayer->styleManager()->currentStyle() );
230 const QgsMapLayer::StyleCategories categories = dlg.styleCategories();
231 const QString type = dlg.fileExtension();
232 if ( type.compare( QLatin1String( "qml" ), Qt::CaseInsensitive ) == 0 )
233 {
234 QString message;
235 bool defaultLoadedFlag = false;
236 const QString filePath = dlg.filePath();
237 message = mLayer->loadNamedStyle( filePath, defaultLoadedFlag, categories );
238
239 //reset if the default style was loaded OK only
240 if ( defaultLoadedFlag )
241 {
242 syncToLayer();
243 }
244 else
245 {
246 //let the user know what went wrong
247 QMessageBox::warning( this, tr( "Load Style" ), message );
248 }
249 }
250 else if ( type.compare( QLatin1String( "json" ), Qt::CaseInsensitive ) == 0 )
251 {
252 QFile file( dlg.filePath() );
253 if ( !file.open( QIODevice::ReadOnly | QIODevice::Text ) )
254 {
255 QMessageBox::warning( this, tr( "Load Style" ), tr( "Could not read %1" ).arg( QDir::toNativeSeparators( dlg.filePath() ) ) );
256 }
257 else
258 {
259 QTextStream in( &file );
260#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
261 in.setCodec( "UTF-8" );
262#endif
263 const QString content = in.readAll();
264
266 // convert automatically from pixel sizes to millimeters, because pixel sizes
267 // are a VERY edge case in QGIS and don't play nice with hidpi map renders or print layouts
269 //assume source uses 96 dpi
270 context.setPixelSizeConversionFactor( 25.4 / 96.0 );
271
272 //load sprites
273 QVariantMap styleDefinition = QgsJsonUtils::parseJson( content ).toMap();
274
275 QFileInfo fi( dlg.filePath() );
276 QgsVectorTileUtils::loadSprites( styleDefinition, context, QStringLiteral( "file://" ) + fi.absolutePath() );
277
279
280 if ( converter.convert( content, &context ) != QgsMapBoxGlStyleConverter::Success )
281 {
282 QMessageBox::warning( this, tr( "Load Style" ), converter.errorMessage() );
283 }
284 else
285 {
287 {
288 mLayer->setRenderer( converter.renderer() );
289 }
291 {
292 mLayer->setLabeling( converter.labeling() );
293 }
294 syncToLayer();
295 }
296 }
297 }
298 activateWindow(); // set focus back to properties dialog
299 }
300}
301
306
307void QgsVectorTileLayerProperties::aboutToShowStyleMenu()
308{
309 QMenu *m = qobject_cast<QMenu *>( sender() );
310
312 // re-add style manager actions!
313 m->addSeparator();
315}
316
317void QgsVectorTileLayerProperties::showHelp()
318{
319 const QVariant helpPage = mOptionsStackedWidget->currentWidget()->property( "helpPage" );
320
321 if ( helpPage.isValid() )
322 {
323 QgsHelp::openHelp( helpPage.toString() );
324 }
325 else
326 {
327 QgsHelp::openHelp( QStringLiteral( "working_with_vector_tiles/vector_tiles_properties.html" ) );
328 }
329}
330
331void QgsVectorTileLayerProperties::crsChanged( const QgsCoordinateReferenceSystem &crs )
332{
333 QgsDatumTransformDialog::run( crs, QgsProject::instance()->crs(), this, mCanvas, tr( "Select Transformation" ) );
334 mLayer->setCrs( crs );
335 mMetadataWidget->crsChanged();
336}
337
@ Millimeters
Millimeters.
static QString reportStyleSheet(QgsApplication::StyleSheetType styleSheetType=QgsApplication::StyleSheetType::Qt)
Returns a css style sheet for reports, the styleSheetType argument determines what type of stylesheet...
@ WebBrowser
StyleSheet for Qt GUI widgets (based on QLabel or QTextBrowser), supports basic CSS and Qt extensions...
This class represents a coordinate reference system (CRS).
static bool run(const QgsCoordinateReferenceSystem &sourceCrs=QgsCoordinateReferenceSystem(), const QgsCoordinateReferenceSystem &destinationCrs=QgsCoordinateReferenceSystem(), QWidget *parent=nullptr, QgsMapCanvas *mapCanvas=nullptr, const QString &windowTitle=QString())
Runs the dialog (if required) prompting for the desired transform to use from sourceCrs to destinatio...
static QgsProviderSourceWidgetProviderRegistry * sourceWidgetProviderRegistry()
Returns the registry of provider source widget providers.
Definition qgsgui.cpp:114
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Definition qgshelp.cpp:38
static QVariant parseJson(const std::string &jsonString)
Converts JSON jsonString to a QVariant, in case of parsing error an invalid QVariant is returned and ...
Base class for "layer properties" dialogs, containing common utilities for handling functionality in ...
void saveMetadataToFile()
Allows the user to save the layer's metadata as a file.
virtual void rollback()
Rolls back changes made to the layer.
void saveStyleAsDefault()
Saves the current layer style as the default for the layer.
void setMetadataWidget(QgsMetadataWidget *widget, QWidget *page)
Sets the metadata widget and page associated with the dialog.
void loadDefaultStyle()
Reloads the default style for the layer.
void saveStyleToFile()
Allows the user to save the layer's style to a file.
QgsMapCanvas * mCanvas
Associated map canvas.
QgsMapLayerStyle mOldStyle
Previous layer style.
void loadMetadataFromFile()
Allows the user to load layer metadata from a file.
void initialize()
Initialize the dialog.
void openUrl(const QUrl &url)
Handles opening a url from the dialog.
Context for a MapBox GL style conversion operation.
void setTargetUnit(Qgis::RenderUnit targetUnit)
Sets the target unit type.
void setPixelSizeConversionFactor(double sizeConversionFactor)
Sets the pixel size conversion factor, used to scale the original pixel sizes when converting styles.
Handles conversion of MapBox GL styles to QGIS vector tile renderers and labeling settings.
QgsVectorTileRenderer * renderer() const
Returns a new instance of a vector tile renderer representing the converted style,...
QgsVectorTileLabeling * labeling() const
Returns a new instance of a vector tile labeling representing the converted style,...
Result convert(const QVariantMap &style, QgsMapBoxGlStyleConversionContext *context=nullptr)
Converts a JSON style map, and returns the resultant status of the conversion.
@ Success
Conversion was successful.
QString errorMessage() const
Returns a descriptive error message if an error was encountered during the style conversion,...
Map canvas is a class for displaying all GIS data types on a canvas.
A reusable dialog which allows users to select stored layer styles and categories to load for a map l...
QgsMapLayer::StyleCategories styleCategories() const
Returns the list of selected style categories the user has opted to load.
QString filePath() const
Returns the full path to the selected layer style source file.
QString fileExtension() const
Returns the file extension for the selected layer style source file.
void removesExtraMenuSeparators(QMenu *m)
removes extra separators from the menu
void addStyleManagerActions(QMenu *m, QgsMapLayer *layer)
adds actions to the menu in accordance to the layer
static QgsMapLayerStyleGuiUtils * instance()
returns a singleton instance of this class
QString currentStyle() const
Returns name of the current style.
QgsMapLayerStyle style(const QString &name) const
Returns data of a stored style - accessed by its unique name.
QString name
Definition qgsmaplayer.h:77
QString source() const
Returns the source for the layer.
QString providerType() const
Returns the provider type (provider key) for this layer.
void setMinimumScale(double scale)
Sets the minimum map scale (i.e.
QgsCoordinateReferenceSystem crs
Definition qgsmaplayer.h:80
void setMaximumScale(double scale)
Sets the maximum map scale (i.e.
void setScaleBasedVisibility(bool enabled)
Sets whether scale based visibility is enabled for the layer.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
virtual QString loadNamedStyle(const QString &theURI, bool &resultFlag, bool loadFromLocalDb, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories)
Loads a named style from file/local db/datasource db.
void setName(const QString &name)
Set the display name of the layer.
void setDataSource(const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false)
Updates the data source of the layer.
double minimumScale() const
Returns the minimum map scale (i.e.
QgsMapLayerStyleManager * styleManager() const
Gets access to the layer's style manager.
@ Symbology
Symbology.
@ Labeling
Labeling.
double maximumScale() const
Returns the maximum map scale (i.e.
void setCrs(const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
Sets layer's spatial reference system.
A bar for displaying non-blocking messages to the user.
A wizard to edit metadata on a map layer.
void acceptMetadata()
Saves the metadata to the layer.
void crsChanged()
If the CRS is updated.
void setMapCanvas(QgsMapCanvas *canvas)
Sets a map canvas associated with the widget.
QStackedWidget * mOptStackedWidget
void initOptionsBase(bool restoreUi=true, const QString &title=QString())
Set up the base ui connections for vertical tabs.
static QgsProject * instance()
Returns the QgsProject singleton instance.
void crsChanged(const QgsCoordinateReferenceSystem &)
Emitted when the selected CRS is changed.
QgsProviderSourceWidget * createWidget(QgsMapLayer *layer, QWidget *parent=nullptr)
Creates a new widget to configure the source of the specified layer.
void validChanged(bool isValid)
Emitted whenever the validation status of the widget changes.
virtual QString sourceUri() const =0
Returns the source URI as currently defined by the widget.
virtual void setMapCanvas(QgsMapCanvas *mapCanvas)
Sets a map canvas associated with the widget.
virtual void setSourceUri(const QString &uri)=0
Sets the source uri to show in the widget.
This class is a composition of two QSettings instances:
Definition qgssettings.h:63
bool contains(const QString &key, QgsSettings::Section section=QgsSettings::NoSection) const
Returns true if there exists a setting called key; returns false otherwise.
void setValue(const QString &key, const QVariant &value, QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.
Q_DECL_DEPRECATED void saveDefaultStyle() SIP_DEPRECATED
Saves the default style when appropriate button is pressed.
Q_DECL_DEPRECATED void saveStyleAs() SIP_DEPRECATED
Saves a style when appriate button is pressed.
void loadStyle()
Loads a saved style when appropriate button is pressed.
QgsVectorTileLayerProperties(QgsVectorTileLayer *lyr, QgsMapCanvas *canvas, QgsMessageBar *messageBar, QWidget *parent=nullptr, Qt::WindowFlags=QgsGuiUtils::ModalDialogFlags)
Constructor.
Implements a map layer that is dedicated to rendering of vector tiles.
void setRenderer(QgsVectorTileRenderer *r)
Sets renderer for the map layer.
void setLabeling(QgsVectorTileLabeling *labeling)
Sets labeling for the map layer.
QString htmlMetadata() const override
Obtain a formatted HTML string containing assorted metadata for this layer.
static void loadSprites(const QVariantMap &styleDefinition, QgsMapBoxGlStyleConversionContext &context, const QString &styleUrl=QString())
Downloads the sprite image and sets it to the conversion context.
const QgsCoordinateReferenceSystem & crs
Setting options for creating vector data providers.