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