QGIS API Documentation 3.99.0-Master (f78f5286a64)
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" ), tr( "Style name:" ), QLineEdit::Normal, QStringLiteral( "new style" ), &ok );
148 if ( !ok || text.isEmpty() )
149 return;
150
151 const bool res = mLayer->styleManager()->addStyleFromLayer( text );
152 if ( res ) // make it active!
153 {
154 mLayer->styleManager()->setCurrentStyle( text );
155 }
156 else
157 {
158 QgsDebugError( "Failed to add style: " + text );
159 }
160}
161
162void QgsMapLayerStyleManagerWidget::removeStyle()
163{
164 const QString current = mLayer->styleManager()->currentStyle();
165 const bool res = mLayer->styleManager()->removeStyle( current );
166 if ( !res )
167 QgsDebugError( QStringLiteral( "Failed to remove current style" ) );
168}
169
170void QgsMapLayerStyleManagerWidget::renameStyle( QStandardItem *item )
171{
172 const QString oldName = item->data().toString();
173 const QString newName = item->text();
174 item->setData( newName );
175 whileBlocking( this )->mLayer->styleManager()->renameStyle( oldName, newName );
176}
177
178void QgsMapLayerStyleManagerWidget::saveAsDefault()
179{
180 if ( !mLayer )
181 return;
182
183 switch ( mLayer->type() )
184 {
185 case Qgis::LayerType::Vector:
186 QgsVectorLayerProperties( mMapCanvas, mMapLayerConfigWidgetContext.messageBar(), qobject_cast<QgsVectorLayer *>( mLayer ) ).saveDefaultStyle();
187 break;
188
189 case Qgis::LayerType::Raster:
190 QgsRasterLayerProperties( mLayer, mMapCanvas ).saveStyleAsDefault();
191 break;
192
193 case Qgis::LayerType::Mesh:
194 QgsMeshLayerProperties( mLayer, mMapCanvas ).saveStyleAsDefault();
195 break;
196
197 case Qgis::LayerType::VectorTile:
198 QgsVectorTileLayerProperties( qobject_cast<QgsVectorTileLayer *>( mLayer ), mMapCanvas, mMapLayerConfigWidgetContext.messageBar() ).saveStyleAsDefault();
199 break;
200
201 // Not available for these
202 case Qgis::LayerType::PointCloud:
203 case Qgis::LayerType::Annotation:
204 case Qgis::LayerType::TiledScene:
205 case Qgis::LayerType::Plugin:
206 case Qgis::LayerType::Group:
207 break;
208 }
209}
210
211void QgsMapLayerStyleManagerWidget::loadDefault()
212{
213 if ( !mLayer )
214 return;
215
216 switch ( mLayer->type() )
217 {
218 case Qgis::LayerType::Vector:
219 QgsVectorLayerProperties( mMapCanvas, mMapLayerConfigWidgetContext.messageBar(), qobject_cast<QgsVectorLayer *>( mLayer ) ).loadDefaultStyle();
220 break;
221
222 case Qgis::LayerType::Raster:
223 QgsRasterLayerProperties( mLayer, mMapCanvas ).loadDefaultStyle();
224 break;
225
226 case Qgis::LayerType::Mesh:
227 QgsMeshLayerProperties( mLayer, mMapCanvas ).loadDefaultStyle();
228 break;
229
230 case Qgis::LayerType::VectorTile:
231 QgsVectorTileLayerProperties( qobject_cast<QgsVectorTileLayer *>( mLayer ), mMapCanvas, mMapLayerConfigWidgetContext.messageBar() ).loadDefaultStyle();
232 break;
233
234 // Not available for these
235 case Qgis::LayerType::PointCloud:
236 case Qgis::LayerType::Annotation:
237 case Qgis::LayerType::TiledScene:
238 case Qgis::LayerType::Plugin:
239 case Qgis::LayerType::Group:
240 break;
241 }
242}
243
244void QgsMapLayerStyleManagerWidget::saveStyle()
245{
246 if ( !mLayer )
247 return;
248
249 switch ( mLayer->type() )
250 {
251 case Qgis::LayerType::Vector:
252 QgsVectorLayerProperties( mMapCanvas, mMapLayerConfigWidgetContext.messageBar(), qobject_cast<QgsVectorLayer *>( mLayer ) ).saveStyleAs();
253 break;
254
255 case Qgis::LayerType::Raster:
256 QgsRasterLayerProperties( mLayer, mMapCanvas ).saveStyleAs();
257 break;
258
259 case Qgis::LayerType::Mesh:
260 QgsMeshLayerProperties( mLayer, mMapCanvas ).saveStyleToFile();
261 break;
262
263 case Qgis::LayerType::VectorTile:
264 QgsVectorTileLayerProperties( qobject_cast<QgsVectorTileLayer *>( mLayer ), mMapCanvas, mMapLayerConfigWidgetContext.messageBar() ).saveStyleToFile();
265 break;
266
267 // Not available for these
268 case Qgis::LayerType::PointCloud:
269 case Qgis::LayerType::Annotation:
270 case Qgis::LayerType::TiledScene:
271 case Qgis::LayerType::Plugin:
272 case Qgis::LayerType::Group:
273 break;
274 }
275}
276
277void QgsMapLayerStyleManagerWidget::loadStyle()
278{
279 if ( !mLayer )
280 return;
281
282 switch ( mLayer->type() )
283 {
284 case Qgis::LayerType::Vector:
285 QgsVectorLayerProperties( mMapCanvas, mMapLayerConfigWidgetContext.messageBar(), qobject_cast<QgsVectorLayer *>( mLayer ) ).loadStyle();
286 break;
287
288 case Qgis::LayerType::Raster:
289 QgsRasterLayerProperties( mLayer, mMapCanvas ).loadStyleFromFile();
290 break;
291
292 case Qgis::LayerType::Mesh:
293 QgsMeshLayerProperties( mLayer, mMapCanvas ).loadStyleFromFile();
294 break;
295
296 case Qgis::LayerType::VectorTile:
297 QgsVectorTileLayerProperties( qobject_cast<QgsVectorTileLayer *>( mLayer ), mMapCanvas, mMapLayerConfigWidgetContext.messageBar() ).loadStyle();
298 break;
299
300 // Not available for these
301 case Qgis::LayerType::PointCloud:
302 case Qgis::LayerType::Annotation:
303 case Qgis::LayerType::TiledScene:
304 case Qgis::LayerType::Plugin:
305 case Qgis::LayerType::Group:
306 break;
307 }
308}
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:805
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:289
QgsLayerPropertiesDialog::saveStyleAs
void saveStyleAs()
Saves a style when appriate button is pressed.
Definition qgslayerpropertiesdialog.cpp:400
QgsLayerPropertiesDialog::loadStyle
void loadStyle()
Triggers a dialog to load a saved style.
Definition qgslayerpropertiesdialog.cpp:490
QgsLayerPropertiesDialog::saveStyleToFile
void saveStyleToFile()
Allows the user to save the layer's style to a file.
Definition qgslayerpropertiesdialog.cpp:196
QgsLayerPropertiesDialog::saveDefaultStyle
void saveDefaultStyle()
Saves the default style when appropriate button is pressed.
Definition qgslayerpropertiesdialog.cpp:349
QgsLayerPropertiesDialog::loadStyleFromFile
void loadStyleFromFile()
Allows the user to load layer style from a file.
Definition qgslayerpropertiesdialog.cpp:159
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:80
QgsMapLayerConfigWidget
A panel widget that can be shown in the map style dock.
Definition qgsmaplayerconfigwidget.h:112
QgsMapLayerConfigWidget::mMapLayerConfigWidgetContext
QgsMapLayerConfigWidgetContext mMapLayerConfigWidgetContext
Definition qgsmaplayerconfigwidget.h:186
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:78
QgsMapLayer::type
Qgis::LayerType type
Definition qgsmaplayer.h:88
QgsMapLayer::styleManager
QgsMapLayerStyleManager * styleManager() const
Gets access to the layer's style manager.
Definition qgsmaplayer.cpp:2839
QgsMeshLayerProperties
A dialog for configuring mesh layer properties.
Definition qgsmeshlayerproperties.h:44
QgsRasterLayerProperties
A dialog for raster layer properties.
Definition qgsrasterlayerproperties.h:54
QgsVectorLayerProperties
Layer properties dialog for vector layers.
Definition qgsvectorlayerproperties.h:59
QgsVectorTileLayerProperties
Layer properties dialog for vector tile layers.
Definition qgsvectortilelayerproperties.h:39
QgsVectorTileLayerProperties::loadStyle
void loadStyle()
Loads a saved style when appropriate button is pressed.
Definition qgsvectortilelayerproperties.cpp:231
whileBlocking
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition qgis.h:6296
QgsDebugMsgLevel
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:41
QgsDebugError
#define QgsDebugError(str)
Definition qgslogger.h:40
Generated on Fri Jul 18 2025 14:01:06 for QGIS API Documentation by doxygen 1.9.8