QGIS API Documentation  2.99.0-Master (a411669)
qgslayerpropertieswidget.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayerpropertieswidget.cpp
3  ----------------------------
4  begin : June 2012
5  copyright : (C) 2012 by Arunmozhi
6  email : aruntheguy at gmail.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 
18 #include <QFile>
19 #include <QStandardItem>
20 #include <QKeyEvent>
21 #include <QMessageBox>
22 #include <QPicture>
23 
24 #include "qgssymbollayer.h"
25 #include "qgssymbollayerregistry.h"
26 
27 #include "qgsapplication.h"
28 #include "qgslogger.h"
29 
30 #include "qgssymbollayerwidget.h"
34 #include "qgssymbol.h" //for the unit
35 #include "qgspanelwidget.h"
36 #include "qgsmapcanvas.h"
37 #include "qgsproject.h"
38 #include "qgsvectorlayer.h"
39 
40 static bool _initWidgetFunction( const QString &name, QgsSymbolLayerWidgetFunc f )
41 {
43 
44  QgsSymbolLayerAbstractMetadata *abstractMetadata = reg->symbolLayerMetadata( name );
45  if ( !abstractMetadata )
46  {
47  QgsDebugMsg( "Failed to find symbol layer's entry in registry: " + name );
48  return false;
49  }
50  QgsSymbolLayerMetadata *metadata = dynamic_cast<QgsSymbolLayerMetadata *>( abstractMetadata );
51  if ( !metadata )
52  {
53  QgsDebugMsg( "Failed to cast symbol layer's metadata: " + name );
54  return false;
55  }
56  metadata->setWidgetFunction( f );
57  return true;
58 }
59 
60 static void _initWidgetFunctions()
61 {
62  static bool sInitialized = false;
63  if ( sInitialized )
64  return;
65 
66  _initWidgetFunction( QStringLiteral( "SimpleLine" ), QgsSimpleLineSymbolLayerWidget::create );
67  _initWidgetFunction( QStringLiteral( "MarkerLine" ), QgsMarkerLineSymbolLayerWidget::create );
68  _initWidgetFunction( QStringLiteral( "ArrowLine" ), QgsArrowSymbolLayerWidget::create );
69 
70  _initWidgetFunction( QStringLiteral( "SimpleMarker" ), QgsSimpleMarkerSymbolLayerWidget::create );
71  _initWidgetFunction( QStringLiteral( "FilledMarker" ), QgsFilledMarkerSymbolLayerWidget::create );
72  _initWidgetFunction( QStringLiteral( "SvgMarker" ), QgsSvgMarkerSymbolLayerWidget::create );
73  _initWidgetFunction( QStringLiteral( "FontMarker" ), QgsFontMarkerSymbolLayerWidget::create );
74  _initWidgetFunction( QStringLiteral( "EllipseMarker" ), QgsEllipseSymbolLayerWidget::create );
75  _initWidgetFunction( QStringLiteral( "VectorField" ), QgsVectorFieldSymbolLayerWidget::create );
76 
77  _initWidgetFunction( QStringLiteral( "SimpleFill" ), QgsSimpleFillSymbolLayerWidget::create );
78  _initWidgetFunction( QStringLiteral( "GradientFill" ), QgsGradientFillSymbolLayerWidget::create );
79  _initWidgetFunction( QStringLiteral( "ShapeburstFill" ), QgsShapeburstFillSymbolLayerWidget::create );
80  _initWidgetFunction( QStringLiteral( "RasterFill" ), QgsRasterFillSymbolLayerWidget::create );
81  _initWidgetFunction( QStringLiteral( "SVGFill" ), QgsSVGFillSymbolLayerWidget::create );
82  _initWidgetFunction( QStringLiteral( "CentroidFill" ), QgsCentroidFillSymbolLayerWidget::create );
83  _initWidgetFunction( QStringLiteral( "LinePatternFill" ), QgsLinePatternFillSymbolLayerWidget::create );
84  _initWidgetFunction( QStringLiteral( "PointPatternFill" ), QgsPointPatternFillSymbolLayerWidget::create );
85 
86  _initWidgetFunction( QStringLiteral( "GeometryGenerator" ), QgsGeometryGeneratorSymbolLayerWidget::create );
87 
88  sInitialized = true;
89 }
90 
91 
93  : QgsPanelWidget( parent )
94  , mLayer( layer )
95  , mSymbol( symbol )
96  , mVectorLayer( vl )
97 {
98 
99  setupUi( this );
100  connect( mEnabledCheckBox, &QCheckBox::toggled, this, &QgsLayerPropertiesWidget::mEnabledCheckBox_toggled );
101  // initialize the sub-widgets
102  // XXX Should this thing be here this way? Initialize all the widgets just for the sake of one layer?
103  // TODO Make this on demand creation
104  _initWidgetFunctions();
105 
106  // TODO Algorithm
107  //
108  // 3. populate the combo box with the supported layer type
109  // 4. set the present layer type
110  // 5. create the widget for the present layer type and set inn stacked widget
111  // 6. connect comboBox type changed to two things
112  // 1. emit signal that type has beed changed
113  // 2. remove the widget and place the new widget corresponding to the changed layer type
114  //
116  // update layer type combo box
117  int idx = cboLayerType->findData( mLayer->layerType() );
118  cboLayerType->setCurrentIndex( idx );
119 
120  connect( mEnabledCheckBox, &QAbstractButton::toggled, mEnabledDDBtn, &QWidget::setEnabled );
121  mEnabledCheckBox->setChecked( mLayer->enabled() );
122 
123  // set the corresponding widget
124  updateSymbolLayerWidget( layer );
125  connect( cboLayerType, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsLayerPropertiesWidget::layerTypeChanged );
126 
128 
129  this->connectChildPanel( mEffectWidget );
130 
131  mEffectWidget->setPaintEffect( mLayer->paintEffect() );
132 
134 }
135 
137 {
138  mContext = context;
139 
140  QgsSymbolLayerWidget *w = dynamic_cast< QgsSymbolLayerWidget * >( stackedWidget->currentWidget() );
141  if ( w )
142  w->setContext( mContext );
143 }
144 
146 {
147  return mContext;
148 }
149 
151 {
152  QgsPanelWidget::setDockMode( dockMode );
153  mEffectWidget->setDockMode( this->dockMode() );
154 }
155 
157 {
158  QStringList symbolLayerIds = QgsApplication::symbolLayerRegistry()->symbolLayersForType( mSymbol->type() );
159 
160  Q_FOREACH ( const QString &symbolLayerId, symbolLayerIds )
161  cboLayerType->addItem( QgsApplication::symbolLayerRegistry()->symbolLayerMetadata( symbolLayerId )->visibleName(), symbolLayerId );
162 
163  if ( mSymbol->type() == QgsSymbol::Fill )
164  {
166  Q_FOREACH ( const QString &lineLayerId, lineLayerIds )
167  {
169  if ( layerInfo->type() != QgsSymbol::Hybrid )
170  {
171  QString visibleName = layerInfo->visibleName();
172  QString name = QString( tr( "Outline: %1" ) ).arg( visibleName );
173  cboLayerType->addItem( name, lineLayerId );
174  }
175  }
176  }
177 }
178 
180 {
181  if ( stackedWidget->currentWidget() != pageDummy )
182  {
183  // stop updating from the original widget
184  if ( QgsSymbolLayerWidget *w = qobject_cast< QgsSymbolLayerWidget * >( stackedWidget->currentWidget() ) )
186  stackedWidget->removeWidget( stackedWidget->currentWidget() );
187  }
188 
190 
191  QString layerType = layer->layerType();
192  QgsSymbolLayerAbstractMetadata *am = pReg->symbolLayerMetadata( layerType );
193  if ( am )
194  {
196  if ( w )
197  {
198  w->setContext( mContext );
199  w->setSymbolLayer( layer );
200  stackedWidget->addWidget( w );
201  stackedWidget->setCurrentWidget( w );
202  // start receiving updates from widget
204  connect( w, &QgsSymbolLayerWidget::symbolChanged, this, &QgsLayerPropertiesWidget::reloadLayer );
205  return;
206  }
207  }
208  // When anything is not right
209  stackedWidget->setCurrentWidget( pageDummy );
210 }
211 
213 {
214  if ( mContext.expressionContext() )
215  return *mContext.expressionContext();
216 
217  QgsExpressionContext expContext;
221 
222  if ( mContext.mapCanvas() )
223  {
226  }
227  else
228  {
230  }
231 
233 
235  if ( mLayer )
236  {
237  //cheat a bit - set the symbol color variable to match the symbol layer's color (when we should really be using the *symbols*
238  //color, but that's not accessible here). 99% of the time these will be the same anyway
240  }
241  expContext << symbolScope;
246 
247  // additional scopes
248  Q_FOREACH ( const QgsExpressionContextScope &scope, mContext.additionalExpressionContextScopes() )
249  {
250  expContext.appendScope( new QgsExpressionContextScope( scope ) );
251  }
252 
253  //TODO - show actual value
254  expContext.setOriginalValueVariable( QVariant() );
255 
260 
261  return expContext;
262 }
263 
265 {
267  connect( button, &QgsPropertyOverrideButton::changed, this, &QgsLayerPropertiesWidget::updateProperty );
268  button->registerExpressionContextGenerator( this );
269 }
270 
271 void QgsLayerPropertiesWidget::updateProperty()
272 {
273  QgsPropertyOverrideButton *button = qobject_cast<QgsPropertyOverrideButton *>( sender() );
274  QgsSymbolLayer::Property key = static_cast< QgsSymbolLayer::Property >( button->propertyKey() );
275  mLayer->setDataDefinedProperty( key, button->toProperty() );
276  emit changed();
277 }
278 
280 {
281  QgsSymbolLayer *layer = mLayer;
282  if ( !layer )
283  return;
284  QString newLayerType = cboLayerType->currentData().toString();
285  if ( layer->layerType() == newLayerType )
286  return;
287 
288  // get creation function for new layer from registry
290  QgsSymbolLayerAbstractMetadata *am = pReg->symbolLayerMetadata( newLayerType );
291  if ( !am ) // check whether the metadata is assigned
292  return;
293 
294  // change layer to a new (with different type)
295  // base new layer on existing layer's properties
296  QgsSymbolLayer *newLayer = am->createSymbolLayer( layer->properties() );
297  if ( !newLayer )
298  return;
299 
300  updateSymbolLayerWidget( newLayer );
301  emit changeLayer( newLayer );
302 }
303 
305 {
306  emit changed();
307 
308  // also update paint effect preview
309  mEffectWidget->setPreviewPicture( QgsSymbolLayerUtils::symbolLayerPreviewPicture( mLayer, QgsUnitTypes::RenderMillimeters, QSize( 80, 80 ) ) );
310  emit widgetChanged();
311 }
312 
313 void QgsLayerPropertiesWidget::reloadLayer()
314 {
315  emit changeLayer( mLayer );
316 }
317 
318 void QgsLayerPropertiesWidget::mEnabledCheckBox_toggled( bool enabled )
319 {
320  mLayer->setEnabled( enabled );
322 }
static const QString EXPR_ORIGINAL_VALUE
Inbuilt variable name for value original value variable.
static QgsSymbolLayerRegistry * symbolLayerRegistry()
Returns the application&#39;s symbol layer registry, used for managing symbol layers. ...
static QgsExpressionContextScope * updateSymbolScope(const QgsSymbol *symbol, QgsExpressionContextScope *symbolScope=nullptr)
Updates a symbol scope related to a QgsSymbol to an expression context.
static const QString EXPR_CLUSTER_COLOR
Inbuilt variable name for cluster color variable.
Single variable definition for use within a QgsExpressionContextScope.
void connectChildPanel(QgsPanelWidget *panel)
Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to ...
void symbolChanged()
Should be emitted whenever the sub symbol changed on this symbol layer configuration.
Stores metadata about one symbol layer class.
bool dockMode()
Return the dock mode state.
static const QString EXPR_GEOMETRY_POINT_COUNT
Inbuilt variable name for point count variable.
QgsPaintEffect * paintEffect() const
Returns the current paint effect for the layer.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsFilledMarkerSymbolLayerWidget.
static QgsExpressionContextScope * atlasScope(const QgsAtlasComposition *atlas)
Creates a new scope which contains variables and functions relating to a QgsAtlasComposition.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsGradientFillSymbolLayerWidget.
void setWidgetFunction(QgsSymbolLayerWidgetFunc f)
#define QgsDebugMsg(str)
Definition: qgslogger.h:37
QgsSymbolWidgetContext context() const
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expressi...
QStringList symbolLayersForType(QgsSymbol::SymbolType type)
return a list of available symbol layers for a specified symbol type
virtual void setDockMode(bool dockMode) override
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs...
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsShapeburstFillSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSVGFillSymbolLayerWidget.
Base class for any widget that can be shown as a inline panel.
void setContext(const QgsSymbolWidgetContext &context)
Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression ...
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsFontMarkerSymbolLayerWidget.
Line symbol.
Definition: qgssymbol.h:86
virtual QgsStringMap properties() const =0
Should be reimplemented by subclasses to return a string map that contains the configuration informat...
void updateSymbolLayerWidget(QgsSymbolLayer *layer)
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsLinePatternFillSymbolLayerWidget.
virtual void setDockMode(bool dockMode)
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs...
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSimpleLineSymbolLayerWidget.
The QgsMapSettings class contains configuration for rendering of the map.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsMarkerLineSymbolLayerWidget.
QgsExpressionContextScope * lastScope()
Returns the last scope added to the context.
Convenience metadata class that uses static functions to create symbol layer and its widget...
void changed()
Should be emitted whenever configuration changes happened on this symbol layer configuration.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsPointPatternFillSymbolLayerWidget.
A button for controlling property overrides which may apply to a widget.
virtual void setSymbolLayer(QgsSymbolLayer *layer)=0
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context...
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsCentroidFillSymbolLayerWidget.
QgsSymbolLayerAbstractMetadata * symbolLayerMetadata(const QString &name) const
return metadata for specified symbol layer. Returns NULL if not found
Registry of available symbol layer classes.
Contains settings which reflect the context in which a symbol (or renderer) widget is shown...
QgsProperty toProperty() const
Returns a QgsProperty object encapsulating the current state of the widget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSvgMarkerSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Will be registered as factory.
void registerExpressionContextGenerator(QgsExpressionContextGenerator *generator)
Register an expression context generator class that will be used to retrieve an expression context fo...
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the symbol layer&#39;s property collection, used for data defined overrides...
virtual QColor color() const
The fill color.
static const QString EXPR_SYMBOL_COLOR
Inbuilt variable name for symbol color variable.
QgsLayerPropertiesWidget(QgsSymbolLayer *layer, const QgsSymbol *symbol, QgsVectorLayer *vl, QWidget *parent=nullptr)
Constructor for QgsLayerPropertiesWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsRasterFillSymbolLayerWidget.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void setEnabled(bool enabled)
Sets whether symbol layer is enabled and should be drawn.
void widgetChanged()
Emitted when the widget state changes.
static QgsSymbolLayerWidget * create(QgsVectorLayer *layer)
Static creation method.
void registerDataDefinedButton(QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key)
Registers a data defined override button.
virtual QgsSymbolLayer * createSymbolLayer(const QgsStringMap &map)=0
Create a symbol layer of this type given the map of properties.
const QgsMapSettings & mapSettings() const
Get access to properties used for map rendering.
QgsSymbolLayerWidget *(* QgsSymbolLayerWidgetFunc)(QgsVectorLayer *)
void changed()
Emitted when property definition changes.
QgsMapCanvas * mapCanvas() const
Returns the map canvas associated with the widget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSimpleMarkerSymbolLayerWidget.
QgsExpressionContext * expressionContext() const
Returns the expression context used for the widget, if set.
Fill symbol.
Definition: qgssymbol.h:87
static QgsExpressionContextScope * mapSettingsScope(const QgsMapSettings &mapSettings)
Creates a new scope which contains variables and functions relating to a QgsMapSettings object...
QgsExpressionContextScope & expressionContextScope()
Returns a reference to the expression context scope for the map canvas.
Definition: qgsmapcanvas.h:569
static QPicture symbolLayerPreviewPicture(QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit units, QSize size, const QgsMapUnitScale &scale=QgsMapUnitScale())
Draws a symbol layer preview to a QPicture.
bool enabled() const
Returns true if symbol layer is enabled and will be drawn.
SymbolType type() const
Definition: qgssymbol.h:113
void changed()
Emitted when the paint effect properties change.
QgsSymbol::SymbolType type() const
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsVectorFieldSymbolLayerWidget.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:379
void setContext(const QgsSymbolWidgetContext &context)
Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression ...
int propertyKey() const
Returns the property key linked to the button.
void changeLayer(QgsSymbolLayer *)
static const QString EXPR_CLUSTER_SIZE
Inbuilt variable name for cluster size variable.
static const QString EXPR_GEOMETRY_POINT_NUM
Inbuilt variable name for point number variable.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSimpleFillSymbolLayerWidget.
void setHighlightedVariables(const QStringList &variableNames)
Sets the list of variable names within the context intended to be highlighted to the user...
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the symbol layer property definitions.
static const QString EXPR_GEOMETRY_PART_NUM
Inbuilt variable name for geometry part number variable.
Represents a vector layer which manages a vector based data sets.
static const QString EXPR_GEOMETRY_PART_COUNT
Inbuilt variable name for geometry part count variable.
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
void init(int propertyKey, const QgsProperty &property, const QgsPropertiesDefinition &definitions, const QgsVectorLayer *layer=nullptr, bool auxiliaryStorageEnabled=false)
Initialize a newly constructed property button (useful if button was included in a UI layout)...
Whether symbol layer is enabled.
Hybrid symbol.
Definition: qgssymbol.h:88
Property
Data definable properties.
virtual QgsSymbolLayerWidget * createSymbolLayerWidget(QgsVectorLayer *)
Create widget for symbol layer of this type. Can return NULL if there&#39;s no GUI.
virtual void setDataDefinedProperty(Property key, const QgsProperty &property)
Sets a data defined property for the layer.
QList< QgsExpressionContextScope > additionalExpressionContextScopes() const
Returns the list of additional expression context scopes to show as available within the layer...
virtual QString layerType() const =0
Returns a string that represents this layer type.