QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
qgsmaplayerstylemanagerwidget.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsmaplayerstylemanagerwidget.cpp
3 ---------------------
4 begin : June 2016
5 copyright : (C) 2016 by Nathan Woodrow
6 email : woodrow dot nathan 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#include <QAction>
16#include <QVBoxLayout>
17#include <QToolBar>
18#include <QInputDialog>
19#include <QMessageBox>
20#include <QFileDialog>
21
22#include "qgsmaplayerstylemanagerwidget.h"
23#include "qgssettings.h"
24#include "qgslogger.h"
25#include "qgsmaplayer.h"
26#include "qgsmapcanvas.h"
27#include "qgsmaplayerconfigwidget.h"
28#include "qgsmaplayerstylemanager.h"
29#include "qgsvectordataprovider.h"
30#include "qgsrasterdataprovider.h"
31#include "qgsvectorlayer.h"
32#include "qgsvectortilelayer.h"
33#include "qgsrasterlayer.h"
34#include "qgsapplication.h"
35#include "qgsproviderregistry.h"
36#include "qgsvectorlayerproperties.h"
37#include "qgsvectortilelayerproperties.h"
38#include "qgsrasterlayerproperties.h"
39#include "qgsmeshlayerproperties.h"
40
41QgsMapLayerStyleManagerWidget::QgsMapLayerStyleManagerWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent )
42 : QgsMapLayerConfigWidget( layer, canvas, parent )
43{
44 mModel = new QStandardItemModel( this );
45 mStyleList = new QListView( this );
46 mStyleList->setModel( mModel );
47 mStyleList->setViewMode( QListView::ListMode );
48 mStyleList->setResizeMode( QListView::Adjust );
49
50 QToolBar *toolbar = new QToolBar( this );
51 QAction *addAction = toolbar->addAction( tr( "Add" ) );
52 addAction->setIcon( QgsApplication::getThemeIcon( QStringLiteral( "symbologyAdd.svg" ) ) );
53 connect( addAction, &QAction::triggered, this, &QgsMapLayerStyleManagerWidget::addStyle );
54 QAction *removeAction = toolbar->addAction( tr( "Remove Current" ) );
55 removeAction->setIcon( QgsApplication::getThemeIcon( QStringLiteral( "symbologyRemove.svg" ) ) );
56 connect( removeAction, &QAction::triggered, this, &QgsMapLayerStyleManagerWidget::removeStyle );
57 QAction *loadFromFileAction = toolbar->addAction( tr( "Load Style" ) );
58 loadFromFileAction->setIcon( QgsApplication::getThemeIcon( QStringLiteral( "/mActionFileOpen.svg" ) ) );
59 connect( loadFromFileAction, &QAction::triggered, this, &QgsMapLayerStyleManagerWidget::loadStyle );
60 QAction *saveAction = toolbar->addAction( tr( "Save Style" ) );
61 saveAction->setIcon( QgsApplication::getThemeIcon( QStringLiteral( "mActionFileSave.svg" ) ) );
62 connect( saveAction, &QAction::triggered, this, &QgsMapLayerStyleManagerWidget::saveStyle );
63 QAction *saveAsDefaultAction = toolbar->addAction( tr( "Save as Default" ) );
64 connect( saveAsDefaultAction, &QAction::triggered, this, &QgsMapLayerStyleManagerWidget::saveAsDefault );
65 QAction *loadDefaultAction = toolbar->addAction( tr( "Restore Default" ) );
66 connect( loadDefaultAction, &QAction::triggered, this, &QgsMapLayerStyleManagerWidget::loadDefault );
67
68 //broken connect - not sure what the purpose of this was?
69// connect( canvas, &QgsMapCanvas::mapCanvasRefreshed, this, SLOT( updateCurrent() ) );
70
71 connect( mStyleList, &QAbstractItemView::clicked, this, &QgsMapLayerStyleManagerWidget::styleClicked );
72
73 setLayout( new QVBoxLayout() );
74 layout()->setContentsMargins( 0, 0, 0, 0 );
75 layout()->addWidget( toolbar );
76 layout()->addWidget( mStyleList );
77
78 connect( mLayer->styleManager(), &QgsMapLayerStyleManager::currentStyleChanged, this, &QgsMapLayerStyleManagerWidget::currentStyleChanged );
79 connect( mLayer->styleManager(), &QgsMapLayerStyleManager::styleAdded, this, &QgsMapLayerStyleManagerWidget::styleAdded );
80 connect( mLayer->styleManager(), &QgsMapLayerStyleManager::styleRemoved, this, &QgsMapLayerStyleManagerWidget::styleRemoved );
81 connect( mLayer->styleManager(), &QgsMapLayerStyleManager::styleRenamed, this, &QgsMapLayerStyleManagerWidget::styleRenamed );
82
83 mModel->clear();
84
85 const QStringList styles = mLayer->styleManager()->styles();
86 for ( const QString &styleName : styles )
87 {
88 QStandardItem *item = new QStandardItem( styleName );
89 item->setData( styleName );
90 mModel->appendRow( item );
91 }
92
93 const QString active = mLayer->styleManager()->currentStyle();
94 currentStyleChanged( active );
95
96 connect( mModel, &QStandardItemModel::itemChanged, this, &QgsMapLayerStyleManagerWidget::renameStyle );
97}
98
99void QgsMapLayerStyleManagerWidget::styleClicked( const QModelIndex &index )
100{
101 if ( !mLayer || !index.isValid() )
102 return;
103
104 const QString name = index.data().toString();
105 mLayer->styleManager()->setCurrentStyle( name );
106}
107
108void QgsMapLayerStyleManagerWidget::currentStyleChanged( const QString &name )
109{
110 const QList<QStandardItem *> items = mModel->findItems( name );
111 if ( items.isEmpty() )
112 return;
113
114 QStandardItem *item = items.at( 0 );
115
116 mStyleList->setCurrentIndex( item->index() );
117}
118
119void QgsMapLayerStyleManagerWidget::styleAdded( const QString &name )
120{
121 QgsDebugMsgLevel( QStringLiteral( "Style added" ), 2 );
122 QStandardItem *item = new QStandardItem( name );
123 item->setData( name );
124 mModel->appendRow( item );
125}
126
127void QgsMapLayerStyleManagerWidget::styleRemoved( const QString &name )
128{
129 const QList<QStandardItem *> items = mModel->findItems( name );
130 if ( items.isEmpty() )
131 return;
132
133 QStandardItem *item = items.at( 0 );
134 mModel->removeRow( item->row() );
135}
136
137void QgsMapLayerStyleManagerWidget::styleRenamed( const QString &oldname, const QString &newname )
138{
139 const QList<QStandardItem *> items = mModel->findItems( oldname );
140 if ( items.isEmpty() )
141 return;
142
143 QStandardItem *item = items.at( 0 );
144 item->setText( newname );
145 item->setData( newname );
146}
147
148void QgsMapLayerStyleManagerWidget::addStyle()
149{
150 bool ok;
151 const QString text = QInputDialog::getText( nullptr, tr( "New Style" ),
152 tr( "Style name:" ), QLineEdit::Normal,
153 QStringLiteral( "new style" ), &ok );
154 if ( !ok || text.isEmpty() )
155 return;
156
157 const bool res = mLayer->styleManager()->addStyleFromLayer( text );
158 if ( res ) // make it active!
159 {
160 mLayer->styleManager()->setCurrentStyle( text );
161 }
162 else
163 {
164 QgsDebugError( "Failed to add style: " + text );
165 }
166}
167
168void QgsMapLayerStyleManagerWidget::removeStyle()
169{
170 const QString current = mLayer->styleManager()->currentStyle();
171 const bool res = mLayer->styleManager()->removeStyle( current );
172 if ( !res )
173 QgsDebugError( QStringLiteral( "Failed to remove current style" ) );
174}
175
176void QgsMapLayerStyleManagerWidget::renameStyle( QStandardItem *item )
177{
178 const QString oldName = item->data().toString();
179 const QString newName = item->text();
180 item->setData( newName );
181 whileBlocking( this )->mLayer->styleManager()->renameStyle( oldName, newName );
182}
183
184void QgsMapLayerStyleManagerWidget::saveAsDefault()
185{
186 if ( !mLayer )
187 return;
188
189 switch ( mLayer->type() )
190 {
191
192 case Qgis::LayerType::Vector:
193 QgsVectorLayerProperties( mMapCanvas,
194 mMapLayerConfigWidgetContext.messageBar(),
195 qobject_cast<QgsVectorLayer *>( mLayer ) ).saveDefaultStyle();
196 break;
197
198 case Qgis::LayerType::Raster:
199 QgsRasterLayerProperties( mLayer, mMapCanvas ).saveDefaultStyle();
200 break;
201
202 case Qgis::LayerType::Mesh:
203 QgsMeshLayerProperties( mLayer, mMapCanvas ).saveDefaultStyle();
204 break;
205
206 case Qgis::LayerType::VectorTile:
207 QgsVectorTileLayerProperties( qobject_cast<QgsVectorTileLayer *>( mLayer ),
208 mMapCanvas,
209 mMapLayerConfigWidgetContext.messageBar() ).saveDefaultStyle();
210 break;
211
212 // Not available for these
213 case Qgis::LayerType::PointCloud:
214 case Qgis::LayerType::Annotation:
215 case Qgis::LayerType::Plugin:
216 case Qgis::LayerType::Group:
217 default:
218 break;
219 }
220}
221
222void QgsMapLayerStyleManagerWidget::loadDefault()
223{
224 if ( !mLayer )
225 return;
226
227 switch ( mLayer->type() )
228 {
229
230 case Qgis::LayerType::Vector:
231 QgsVectorLayerProperties( mMapCanvas,
232 mMapLayerConfigWidgetContext.messageBar(),
233 qobject_cast<QgsVectorLayer *>( mLayer ) ).loadDefaultStyle();
234 break;
235
236 case Qgis::LayerType::Raster:
237 QgsRasterLayerProperties( mLayer, mMapCanvas ).loadDefaultStyle();
238 break;
239
240 case Qgis::LayerType::Mesh:
241 QgsMeshLayerProperties( mLayer, mMapCanvas ).loadDefaultStyle();
242 break;
243
244 case Qgis::LayerType::VectorTile:
245 QgsVectorTileLayerProperties( qobject_cast<QgsVectorTileLayer *>( mLayer ),
246 mMapCanvas,
247 mMapLayerConfigWidgetContext.messageBar() ).loadDefaultStyle();
248 break;
249
250 // Not available for these
251 case Qgis::LayerType::PointCloud:
252 case Qgis::LayerType::Annotation:
253 case Qgis::LayerType::Plugin:
254 case Qgis::LayerType::Group:
255 default:
256 break;
257 }
258}
259
260void QgsMapLayerStyleManagerWidget::saveStyle()
261{
262 if ( !mLayer )
263 return;
264
265 switch ( mLayer->type() )
266 {
267
268 case Qgis::LayerType::Vector:
269 QgsVectorLayerProperties( mMapCanvas,
270 mMapLayerConfigWidgetContext.messageBar(),
271 qobject_cast<QgsVectorLayer *>( mLayer ) ).saveStyleAs();
272 break;
273
274 case Qgis::LayerType::Raster:
275 QgsRasterLayerProperties( mLayer, mMapCanvas ).saveStyleAs();
276 break;
277
278 case Qgis::LayerType::Mesh:
279 QgsMeshLayerProperties( mLayer, mMapCanvas ).saveStyleAs();
280 break;
281
282 case Qgis::LayerType::VectorTile:
283 QgsVectorTileLayerProperties( qobject_cast<QgsVectorTileLayer *>( mLayer ),
284 mMapCanvas,
285 mMapLayerConfigWidgetContext.messageBar() ).saveStyleAs();
286 break;
287
288 // Not available for these
289 case Qgis::LayerType::PointCloud:
290 case Qgis::LayerType::Annotation:
291 case Qgis::LayerType::Plugin:
292 case Qgis::LayerType::Group:
293 default:
294 break;
295 }
296}
297
298void QgsMapLayerStyleManagerWidget::loadStyle()
299{
300 if ( !mLayer )
301 return;
302
303 switch ( mLayer->type() )
304 {
305
306 case Qgis::LayerType::Vector:
307 QgsVectorLayerProperties( mMapCanvas,
308 mMapLayerConfigWidgetContext.messageBar(),
309 qobject_cast<QgsVectorLayer *>( mLayer ) ).loadStyle();
310 break;
311
312 case Qgis::LayerType::Raster:
313 QgsRasterLayerProperties( mLayer, mMapCanvas ).loadStyle();
314 break;
315
316 case Qgis::LayerType::Mesh:
317 QgsMeshLayerProperties( mLayer, mMapCanvas ).loadStyle();
318 break;
319
320 case Qgis::LayerType::VectorTile:
321 QgsVectorTileLayerProperties( qobject_cast<QgsVectorTileLayer *>( mLayer ),
322 mMapCanvas,
323 mMapLayerConfigWidgetContext.messageBar() ).loadStyle();
324 break;
325
326 // Not available for these
327 case Qgis::LayerType::PointCloud:
328 case Qgis::LayerType::Annotation:
329 case Qgis::LayerType::Plugin:
330 case Qgis::LayerType::Group:
331 default:
332 break;
333 }
334}
QgsApplication::getThemeIcon
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
Definition: qgsapplication.cpp:748
QgsMapCanvas
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:90
QgsMapLayerConfigWidgetContext::messageBar
QgsMessageBar * messageBar() const
Returns the message bar associated with the widget.
Definition: qgsmaplayerconfigwidget.h:81
QgsMapLayerConfigWidget
A panel widget that can be shown in the map style dock.
Definition: qgsmaplayerconfigwidget.h:116
QgsMapLayerConfigWidget::mMapLayerConfigWidgetContext
QgsMapLayerConfigWidgetContext mMapLayerConfigWidgetContext
Definition: qgsmaplayerconfigwidget.h:184
QgsMapLayerStyleManagerWidget::QgsMapLayerStyleManagerWidget
QgsMapLayerStyleManagerWidget(QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
Style manager widget to manage the layers styles.
Definition: qgsmaplayerstylemanagerwidget.cpp:41
QgsMapLayerStyleManager::currentStyle
QString currentStyle() const
Returns name of the current style.
Definition: qgsmaplayerstylemanager.cpp:164
QgsMapLayerStyleManager::removeStyle
bool removeStyle(const QString &name)
Remove a stored style.
Definition: qgsmaplayerstylemanager.cpp:128
QgsMapLayerStyleManager::styles
QStringList styles() const
Returns list of all defined style names.
Definition: qgsmaplayerstylemanager.cpp:86
QgsMapLayerStyleManager::setCurrentStyle
bool setCurrentStyle(const QString &name)
Set a different style as the current style - will apply it to the layer.
Definition: qgsmaplayerstylemanager.cpp:169
QgsMapLayerStyleManager::styleAdded
void styleAdded(const QString &name)
Emitted when a new style has been added.
QgsMapLayerStyleManager::styleRenamed
void styleRenamed(const QString &oldName, const QString &newName)
Emitted when a style has been renamed.
QgsMapLayerStyleManager::addStyleFromLayer
bool addStyleFromLayer(const QString &name)
Add style by cloning the current one.
Definition: qgsmaplayerstylemanager.cpp:121
QgsMapLayerStyleManager::currentStyleChanged
void currentStyleChanged(const QString &currentName)
Emitted when the current style has been changed.
QgsMapLayerStyleManager::styleRemoved
void styleRemoved(const QString &name)
Emitted when a style has been removed.
QgsMapLayer
Base class for all map layer types.
Definition: qgsmaplayer.h:73
QgsMapLayer::type
Qgis::LayerType type
Definition: qgsmaplayer.h:80
QgsMapLayer::isValid
bool isValid
Definition: qgsmaplayer.h:81
QgsMapLayer::styleManager
QgsMapLayerStyleManager * styleManager() const
Gets access to the layer's style manager.
Definition: qgsmaplayer.cpp:2394
QgsMeshLayerProperties
Property sheet for a mesh map layer.
Definition: qgsmeshlayerproperties.h:47
QgsMeshLayerProperties::loadStyle
void loadStyle()
Loads a saved style when appropriate button is pressed.
Definition: qgsmeshlayerproperties.cpp:296
QgsMeshLayerProperties::loadDefaultStyle
void loadDefaultStyle()
Loads the default style when appropriate button is pressed.
Definition: qgsmeshlayerproperties.cpp:253
QgsMeshLayerProperties::saveDefaultStyle
void saveDefaultStyle()
Saves the default style when appropriate button is pressed.
Definition: qgsmeshlayerproperties.cpp:273
QgsMeshLayerProperties::saveStyleAs
void saveStyleAs()
Saves a style when appriate button is pressed.
Definition: qgsmeshlayerproperties.cpp:329
QgsRasterLayerProperties
Property sheet for a raster map layer.
Definition: qgsrasterlayerproperties.h:62
QgsRasterLayerProperties::saveDefaultStyle
void saveDefaultStyle()
Saves the default style when appropriate button is pressed.
Definition: qgsrasterlayerproperties.cpp:1631
QgsRasterLayerProperties::loadDefaultStyle
void loadDefaultStyle()
Loads the default style when appropriate button is pressed.
Definition: qgsrasterlayerproperties.cpp:1612
QgsRasterLayerProperties::saveStyleAs
void saveStyleAs()
Saves a style when appriate button is pressed.
Definition: qgsrasterlayerproperties.cpp:1689
QgsRasterLayerProperties::loadStyle
void loadStyle()
Loads a saved style when appropriate button is pressed.
Definition: qgsrasterlayerproperties.cpp:1656
QgsVectorLayerProperties::loadDefaultStyle
void loadDefaultStyle()
Loads the default style when appropriate button is pressed.
Definition: qgsvectorlayerproperties.cpp:984
QgsVectorLayerProperties::saveStyleAs
void saveStyleAs()
Saves a style when appriate button is pressed.
Definition: qgsvectorlayerproperties.cpp:1211
QgsVectorLayerProperties::loadStyle
void loadStyle()
Loads a saved style when appropriate button is pressed.
Definition: qgsvectorlayerproperties.cpp:1469
QgsVectorLayerProperties::saveDefaultStyle
void saveDefaultStyle()
Saves the default style when appropriate button is pressed.
Definition: qgsvectorlayerproperties.cpp:1045
QgsVectorTileLayerProperties
Vectortile layer properties dialog.
Definition: qgsvectortilelayerproperties.h:40
QgsVectorTileLayerProperties::saveDefaultStyle
void saveDefaultStyle()
Saves the default style when appropriate button is pressed.
Definition: qgsvectortilelayerproperties.cpp:255
QgsVectorTileLayerProperties::saveStyleAs
void saveStyleAs()
Saves a style when appriate button is pressed.
Definition: qgsvectortilelayerproperties.cpp:359
QgsVectorTileLayerProperties::loadDefaultStyle
void loadDefaultStyle()
Loads the default style when appropriate button is pressed.
Definition: qgsvectortilelayerproperties.cpp:236
QgsVectorTileLayerProperties::loadStyle
void loadStyle()
Loads a saved style when appropriate button is pressed.
Definition: qgsvectortilelayerproperties.cpp:278
whileBlocking
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition: qgis.h:3914
QgsDebugMsgLevel
#define QgsDebugMsgLevel(str, level)
Definition: qgslogger.h:39
QgsDebugError
#define QgsDebugError(str)
Definition: qgslogger.h:38
Generated on Sun Jun 25 2023 11:54:04 for QGIS API Documentation by doxygen 1.9.4