QGIS API Documentation  3.23.0-Master (eb871beae0)
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 #include "qgspainteffectregistry.h"
27 
28 #include "qgsapplication.h"
29 #include "qgslogger.h"
30 
31 #include "qgssymbollayerwidget.h"
36 #include "qgssymbol.h" //for the unit
37 #include "qgspanelwidget.h"
38 #include "qgsmapcanvas.h"
39 #include "qgspainteffect.h"
40 #include "qgsproject.h"
41 #include "qgsvectorlayer.h"
44 #include "qgstemporalcontroller.h"
45 #include "qgssymbollayerutils.h"
47 #include "qgsmarkersymbol.h"
48 #include "qgslinesymbol.h"
49 #include "qgsfillsymbol.h"
50 #include "qgsmarkersymbollayer.h"
51 
52 static bool _initWidgetFunction( const QString &name, QgsSymbolLayerWidgetFunc f )
53 {
55 
56  QgsSymbolLayerAbstractMetadata *abstractMetadata = reg->symbolLayerMetadata( name );
57  if ( !abstractMetadata )
58  {
59  QgsDebugMsg( "Failed to find symbol layer's entry in registry: " + name );
60  return false;
61  }
62  QgsSymbolLayerMetadata *metadata = dynamic_cast<QgsSymbolLayerMetadata *>( abstractMetadata );
63  if ( !metadata )
64  {
65  QgsDebugMsg( "Failed to cast symbol layer's metadata: " + name );
66  return false;
67  }
68  metadata->setWidgetFunction( f );
69  return true;
70 }
71 
72 static void _initWidgetFunctions()
73 {
74  static bool sInitialized = false;
75  if ( sInitialized )
76  return;
77 
78  _initWidgetFunction( QStringLiteral( "SimpleLine" ), QgsSimpleLineSymbolLayerWidget::create );
79  _initWidgetFunction( QStringLiteral( "MarkerLine" ), QgsMarkerLineSymbolLayerWidget::create );
80  _initWidgetFunction( QStringLiteral( "HashLine" ), QgsHashedLineSymbolLayerWidget::create );
81  _initWidgetFunction( QStringLiteral( "ArrowLine" ), QgsArrowSymbolLayerWidget::create );
82  _initWidgetFunction( QStringLiteral( "InterpolatedLine" ), QgsInterpolatedLineSymbolLayerWidget::create );
83  _initWidgetFunction( QStringLiteral( "RasterLine" ), QgsRasterLineSymbolLayerWidget::create );
84  _initWidgetFunction( QStringLiteral( "Lineburst" ), QgsLineburstSymbolLayerWidget::create );
85 
86  _initWidgetFunction( QStringLiteral( "SimpleMarker" ), QgsSimpleMarkerSymbolLayerWidget::create );
87  _initWidgetFunction( QStringLiteral( "FilledMarker" ), QgsFilledMarkerSymbolLayerWidget::create );
88  _initWidgetFunction( QStringLiteral( "SvgMarker" ), QgsSvgMarkerSymbolLayerWidget::create );
89  _initWidgetFunction( QStringLiteral( "RasterMarker" ), QgsRasterMarkerSymbolLayerWidget::create );
90  _initWidgetFunction( QStringLiteral( "FontMarker" ), QgsFontMarkerSymbolLayerWidget::create );
91  _initWidgetFunction( QStringLiteral( "EllipseMarker" ), QgsEllipseSymbolLayerWidget::create );
92  _initWidgetFunction( QStringLiteral( "VectorField" ), QgsVectorFieldSymbolLayerWidget::create );
93  _initWidgetFunction( QStringLiteral( "MaskMarker" ), QgsMaskMarkerSymbolLayerWidget::create );
94 
95  _initWidgetFunction( QStringLiteral( "SimpleFill" ), QgsSimpleFillSymbolLayerWidget::create );
96  _initWidgetFunction( QStringLiteral( "GradientFill" ), QgsGradientFillSymbolLayerWidget::create );
97  _initWidgetFunction( QStringLiteral( "ShapeburstFill" ), QgsShapeburstFillSymbolLayerWidget::create );
98  _initWidgetFunction( QStringLiteral( "RasterFill" ), QgsRasterFillSymbolLayerWidget::create );
99  _initWidgetFunction( QStringLiteral( "SVGFill" ), QgsSVGFillSymbolLayerWidget::create );
100  _initWidgetFunction( QStringLiteral( "CentroidFill" ), QgsCentroidFillSymbolLayerWidget::create );
101  _initWidgetFunction( QStringLiteral( "LinePatternFill" ), QgsLinePatternFillSymbolLayerWidget::create );
102  _initWidgetFunction( QStringLiteral( "PointPatternFill" ), QgsPointPatternFillSymbolLayerWidget::create );
103  _initWidgetFunction( QStringLiteral( "RandomMarkerFill" ), QgsRandomMarkerFillSymbolLayerWidget::create );
104 
105  _initWidgetFunction( QStringLiteral( "GeometryGenerator" ), QgsGeometryGeneratorSymbolLayerWidget::create );
106 
107  sInitialized = true;
108 }
109 
110 
112  : QgsPanelWidget( parent )
113  , mLayer( layer )
114  , mSymbol( symbol )
115  , mVectorLayer( vl )
116 {
117 
118  setupUi( this );
119  connect( mEnabledCheckBox, &QCheckBox::toggled, this, &QgsLayerPropertiesWidget::mEnabledCheckBox_toggled );
120  // initialize the sub-widgets
121  // XXX Should this thing be here this way? Initialize all the widgets just for the sake of one layer?
122  // TODO Make this on demand creation
123  _initWidgetFunctions();
124 
125  // TODO Algorithm
126  //
127  // 3. populate the combo box with the supported layer type
128  // 4. set the present layer type
129  // 5. create the widget for the present layer type and set in stacked widget
130  // 6. connect comboBox type changed to two things
131  // 1. emit signal that type has beed changed
132  // 2. remove the widget and place the new widget corresponding to the changed layer type
133  //
135  // update layer type combo box
136  const int idx = cboLayerType->findData( mLayer->layerType() );
137  cboLayerType->setCurrentIndex( idx );
138 
139  connect( mEnabledCheckBox, &QAbstractButton::toggled, mEnabledDDBtn, &QWidget::setEnabled );
140  mEnabledCheckBox->setChecked( mLayer->enabled() );
141 
142  // set the corresponding widget
143  updateSymbolLayerWidget( layer );
144  connect( cboLayerType, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsLayerPropertiesWidget::layerTypeChanged );
145 
147 
148  this->connectChildPanel( mEffectWidget );
149 
150  if ( !mLayer->paintEffect() )
151  {
153  mLayer->paintEffect()->setEnabled( false );
154  }
155  mEffectWidget->setPaintEffect( mLayer->paintEffect() );
156 
158 }
159 
161 {
162  mContext = context;
163  if ( mSymbol )
164  mContext.setSymbolType( mSymbol->type() );
165 
166  QgsSymbolLayerWidget *w = dynamic_cast< QgsSymbolLayerWidget * >( stackedWidget->currentWidget() );
167  if ( w )
168  w->setContext( mContext );
169 }
170 
172 {
173  return mContext;
174 }
175 
177 {
179  mEffectWidget->setDockMode( this->dockMode() );
180 }
181 
183 {
184  const QStringList symbolLayerIds = QgsApplication::symbolLayerRegistry()->symbolLayersForType( mSymbol->type() );
185 
186  const auto constSymbolLayerIds = symbolLayerIds;
187  for ( const QString &symbolLayerId : constSymbolLayerIds )
188  cboLayerType->addItem( QgsApplication::symbolLayerRegistry()->symbolLayerMetadata( symbolLayerId )->visibleName(), symbolLayerId );
189 
190  if ( mSymbol->type() == Qgis::SymbolType::Fill )
191  {
193  const auto constLineLayerIds = lineLayerIds;
194  for ( const QString &lineLayerId : constLineLayerIds )
195  {
197  if ( layerInfo->type() != Qgis::SymbolType::Hybrid )
198  {
199  const QString visibleName = layerInfo->visibleName();
200  const QString name = tr( "Outline: %1" ).arg( visibleName );
201  cboLayerType->addItem( name, lineLayerId );
202  }
203  }
204  }
205 }
206 
208 {
209  if ( stackedWidget->currentWidget() != pageDummy )
210  {
211  // stop updating from the original widget
212  if ( QgsSymbolLayerWidget *w = qobject_cast< QgsSymbolLayerWidget * >( stackedWidget->currentWidget() ) )
214  stackedWidget->removeWidget( stackedWidget->currentWidget() );
215  }
216 
218 
219  const QString layerType = layer->layerType();
220  QgsSymbolLayerAbstractMetadata *am = pReg->symbolLayerMetadata( layerType );
221  if ( am )
222  {
224  if ( w )
225  {
226  w->setContext( mContext );
227  w->setSymbolLayer( layer );
228  stackedWidget->addWidget( w );
229  stackedWidget->setCurrentWidget( w );
230  // start receiving updates from widget
232  connect( w, &QgsSymbolLayerWidget::symbolChanged, this, &QgsLayerPropertiesWidget::reloadLayer );
233  return;
234  }
235  }
236  // When anything is not right
237  stackedWidget->setCurrentWidget( pageDummy );
238 }
239 
241 {
242  if ( auto *lExpressionContext = mContext.expressionContext() )
243  return *lExpressionContext;
244 
245  QgsExpressionContext expContext;
249 
250  if ( auto *lMapCanvas = mContext.mapCanvas() )
251  {
252  expContext << QgsExpressionContextUtils::mapSettingsScope( lMapCanvas->mapSettings() )
253  << new QgsExpressionContextScope( lMapCanvas->expressionContextScope() );
254  if ( const QgsExpressionContextScopeGenerator *generator = dynamic_cast< const QgsExpressionContextScopeGenerator * >( lMapCanvas->temporalController() ) )
255  {
256  expContext << generator->createExpressionContextScope();
257  }
258  }
259  else
260  {
262  }
263 
265 
267  if ( mLayer )
268  {
269  //cheat a bit - set the symbol color variable to match the symbol layer's color (when we should really be using the *symbols*
270  //color, but that's not accessible here). 99% of the time these will be the same anyway
272  }
273  expContext << symbolScope;
279  expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_layer_count" ), 1, true ) );
280  expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_layer_index" ), 1, true ) );
281  expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_marker_row" ), 1, true ) );
282  expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_marker_column" ), 1, true ) );
283 
284  // additional scopes
285  const auto constAdditionalExpressionContextScopes = mContext.additionalExpressionContextScopes();
286  for ( const QgsExpressionContextScope &scope : constAdditionalExpressionContextScopes )
287  {
288  expContext.appendScope( new QgsExpressionContextScope( scope ) );
289  }
290 
291  //TODO - show actual value
292  expContext.setOriginalValueVariable( QVariant() );
293 
299  << QStringLiteral( "symbol_layer_count" ) << QStringLiteral( "symbol_layer_index" ) );
300 
301  return expContext;
302 }
303 
305 {
307  connect( button, &QgsPropertyOverrideButton::changed, this, &QgsLayerPropertiesWidget::updateProperty );
308  button->registerExpressionContextGenerator( this );
309 }
310 
311 void QgsLayerPropertiesWidget::updateProperty()
312 {
313  QgsPropertyOverrideButton *button = qobject_cast<QgsPropertyOverrideButton *>( sender() );
314  const QgsSymbolLayer::Property key = static_cast< QgsSymbolLayer::Property >( button->propertyKey() );
315  mLayer->setDataDefinedProperty( key, button->toProperty() );
316  emit changed();
317 }
318 
320 {
321  QgsSymbolLayer *layer = mLayer;
322  if ( !layer )
323  return;
324  const QString newLayerType = cboLayerType->currentData().toString();
325  if ( layer->layerType() == newLayerType )
326  return;
327 
328  // get creation function for new layer from registry
330  QgsSymbolLayerAbstractMetadata *am = pReg->symbolLayerMetadata( newLayerType );
331  if ( !am ) // check whether the metadata is assigned
332  return;
333 
334  // change layer to a new (with different type)
335  // base new layer on existing layer's properties
336  QVariantMap properties = layer->properties();
337 
338  // if the old symbol layer was a "geometry generator" layer then
339  // we instead get the properties from the generator
340  if ( QgsGeometryGeneratorSymbolLayer *generator = dynamic_cast< QgsGeometryGeneratorSymbolLayer * >( layer ) )
341  {
342  if ( generator->subSymbol() && generator->subSymbol()->symbolLayerCount() > 0 )
343  properties = generator->subSymbol()->symbolLayer( 0 )->properties();
344  }
345 
346  QgsSymbolLayer *newLayer = am->createSymbolLayer( properties );
347  if ( !newLayer )
348  return;
349 
350  // if a symbol layer is changed to a "geometry generator" layer, then we move the old symbol layer into the
351  // geometry generator's subsymbol.
352  if ( QgsGeometryGeneratorSymbolLayer *generator = dynamic_cast< QgsGeometryGeneratorSymbolLayer * >( newLayer ) )
353  {
354  if ( mSymbol )
355  {
356  switch ( mSymbol->type() )
357  {
359  {
360  std::unique_ptr< QgsMarkerSymbol > markerSymbol = std::make_unique< QgsMarkerSymbol >( QgsSymbolLayerList( {layer->clone() } ) );
361  generator->setSymbolType( Qgis::SymbolType::Marker );
362  generator->setSubSymbol( markerSymbol.release() );
363  break;
364  }
366  {
367  std::unique_ptr< QgsLineSymbol > lineSymbol = std::make_unique< QgsLineSymbol >( QgsSymbolLayerList( {layer->clone() } ) );
368  generator->setSymbolType( Qgis::SymbolType::Line );
369  generator->setSubSymbol( lineSymbol.release() );
370  break;
371  }
373  {
374  std::unique_ptr< QgsFillSymbol > fillSymbol = std::make_unique< QgsFillSymbol >( QgsSymbolLayerList( {layer->clone() } ) );
375  generator->setSymbolType( Qgis::SymbolType::Fill );
376  generator->setSubSymbol( fillSymbol.release() );
377  break;
378  }
380  break;
381  }
382  }
383  }
384  else
385  {
386  // try to copy the subsymbol, if its the same type as the new symbol layer's subsymbol
387  if ( newLayer->subSymbol() && layer->subSymbol() && newLayer->subSymbol()->type() == layer->subSymbol()->type() )
388  {
389  newLayer->setSubSymbol( layer->subSymbol()->clone() );
390  }
391  }
392 
393  // special logic for when NEW symbol layers are created from GUI only...
394  // TODO: find a nicer generic way to handle this!
395  if ( QgsFontMarkerSymbolLayer *fontMarker = dynamic_cast< QgsFontMarkerSymbolLayer * >( newLayer ) )
396  {
397  const QString defaultFont = fontMarker->fontFamily();
398  const QFontDatabase fontDb;
399  if ( !fontDb.hasFamily( defaultFont ) )
400  {
401  // default font marker font choice doesn't exist on system, so just use first available symbol font
402  const QStringList candidates = fontDb.families( QFontDatabase::WritingSystem::Symbol );
403  bool foundGoodCandidate = false;
404  for ( const QString &candidate : candidates )
405  {
406  if ( fontDb.writingSystems( candidate ).size() == 1 )
407  {
408  // family ONLY offers symbol writing systems, so it's a good candidate!
409  fontMarker->setFontFamily( candidate );
410  foundGoodCandidate = true;
411  break;
412  }
413  }
414  if ( !foundGoodCandidate && !candidates.empty() )
415  {
416  // fallback to first available family which advertises symbol writing system
417  QString candidate = candidates.at( 0 );
418  fontMarker->setFontFamily( candidate );
419  }
420  }
421 
422  // search (briefly!!) for a unicode character which actually exists in the font
423  const QFontMetrics fontMetrics( fontMarker->fontFamily() );
424  ushort character = fontMarker->character().at( 0 ).unicode();
425  for ( ; character < 1000; ++character )
426  {
427  if ( fontMetrics.inFont( QChar( character ) ) )
428  {
429  fontMarker->setCharacter( QChar( character ) );
430  break;
431  }
432  }
433  }
434 
435  updateSymbolLayerWidget( newLayer );
436  emit changeLayer( newLayer );
437 }
438 
440 {
441  emit changed();
442 
443  // also update paint effect preview
444  bool paintEffectToggled = false;
445  if ( mLayer->paintEffect() && mLayer->paintEffect()->enabled() )
446  {
447  mLayer->paintEffect()->setEnabled( false );
448  paintEffectToggled = true;
449  }
451  if ( paintEffectToggled )
452  {
453  mLayer->paintEffect()->setEnabled( true );
454  }
455  emit widgetChanged();
456 }
457 
458 void QgsLayerPropertiesWidget::reloadLayer()
459 {
460  emit changeLayer( mLayer );
461 }
462 
463 void QgsLayerPropertiesWidget::mEnabledCheckBox_toggled( bool enabled )
464 {
465  mLayer->setEnabled( enabled );
467 }
@ Marker
Marker symbol.
@ Line
Line symbol.
@ Fill
Fill symbol.
@ Hybrid
Hybrid symbol.
static QgsSymbolLayerRegistry * symbolLayerRegistry()
Returns the application's symbol layer registry, used for managing symbol layers.
static QgsSymbolLayerWidget * create(QgsVectorLayer *layer)
Static creation method.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsCentroidFillSymbolLayerWidget.
void changed()
Emitted when the paint effect properties change.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSymbolLayerWidget.
Abstract interface for generating an expression context scope.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
static QgsExpressionContextScope * updateSymbolScope(const QgsSymbol *symbol, QgsExpressionContextScope *symbolScope=nullptr)
Updates a symbol scope related to a QgsSymbol to an expression context.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * atlasScope(const QgsLayoutAtlas *atlas)
Creates a new scope which contains variables and functions relating to a QgsLayoutAtlas.
static QgsExpressionContextScope * mapSettingsScope(const QgsMapSettings &mapSettings)
Creates a new scope which contains variables and functions relating to a QgsMapSettings object.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
static const QString EXPR_GEOMETRY_PART_COUNT
Inbuilt variable name for geometry part count variable.
static const QString EXPR_GEOMETRY_POINT_COUNT
Inbuilt variable name for point count variable.
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.
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
static const QString EXPR_GEOMETRY_RING_NUM
Inbuilt variable name for geometry ring number variable.
static const QString EXPR_GEOMETRY_PART_NUM
Inbuilt variable name for geometry part number variable.
static const QString EXPR_SYMBOL_COLOR
Inbuilt variable name for symbol color variable.
QgsExpressionContextScope * lastScope()
Returns the last scope added to the context.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void setHighlightedVariables(const QStringList &variableNames)
Sets the list of variable names within the context intended to be highlighted to the user.
static const QString EXPR_ORIGINAL_VALUE
Inbuilt variable name for value original value variable.
static const QString EXPR_CLUSTER_COLOR
Inbuilt variable name for cluster color variable.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsFilledMarkerSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsFontMarkerSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Will be registered as factory.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsGradientFillSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsHashedLineSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *layer)
Static creation method.
QgsLayerPropertiesWidget(QgsSymbolLayer *layer, const QgsSymbol *symbol, QgsVectorLayer *vl, QWidget *parent=nullptr)
Constructor for QgsLayerPropertiesWidget.
void setDockMode(bool dockMode) override
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
QgsSymbolWidgetContext context() const
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expressi...
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
void setContext(const QgsSymbolWidgetContext &context)
Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression ...
void changeLayer(QgsSymbolLayer *)
void updateSymbolLayerWidget(QgsSymbolLayer *layer)
void registerDataDefinedButton(QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key)
Registers a data defined override button.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsLinePatternFillSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsLineburstSymbolLayerWidget.
The QgsMapSettings class contains configuration for rendering of the map.
Struct for storing maximum and minimum scales for measurements in map units.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsMarkerLineSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *layer)
Static creation method.
static QgsPaintEffect * defaultStack()
Returns a new effect stack consisting of a sensible selection of default effects.
void setEnabled(bool enabled)
Sets whether the effect is enabled.
bool enabled() const
Returns whether the effect is enabled.
Base class for any widget that can be shown as a inline panel.
void connectChildPanel(QgsPanelWidget *panel)
Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to ...
void widgetChanged()
Emitted when the widget state changes.
virtual void setDockMode(bool dockMode)
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
bool dockMode()
Returns the dock mode state.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsPointPatternFillSymbolLayerWidget.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:468
A button for controlling property overrides which may apply to a widget.
QgsProperty toProperty() const
Returns a QgsProperty object encapsulating the current state of the widget.
void changed()
Emitted when property definition changes.
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).
void registerExpressionContextGenerator(QgsExpressionContextGenerator *generator)
Register an expression context generator class that will be used to retrieve an expression context fo...
int propertyKey() const
Returns the property key linked to the button.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsRandomMarkerFillSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsRasterFillSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsRasterLineSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsRasterMarkerSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSVGFillSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsShapeburstFillSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSimpleFillSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSimpleLineSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSimpleMarkerSymbolLayerWidget.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsSvgMarkerSymbolLayerWidget.
Stores metadata about one symbol layer class.
virtual QgsSymbolLayer * createSymbolLayer(const QVariantMap &map)=0
Create a symbol layer of this type given the map of properties.
virtual QgsSymbolLayerWidget * createSymbolLayerWidget(QgsVectorLayer *)
Create widget for symbol layer of this type. Can return nullptr if there's no GUI.
Convenience metadata class that uses static functions to create symbol layer and its widget.
void setWidgetFunction(QgsSymbolLayerWidgetFunc f)
Registry of available symbol layer classes.
QStringList symbolLayersForType(Qgis::SymbolType type)
Returns a list of available symbol layers for a specified symbol type.
QgsSymbolLayerAbstractMetadata * symbolLayerMetadata(const QString &name) const
Returns metadata for specified symbol layer. Returns nullptr if not found.
static QPicture symbolLayerPreviewPicture(const QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit units, QSize size, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::SymbolType parentSymbolType=Qgis::SymbolType::Hybrid)
Draws a symbol layer preview to a QPicture.
virtual void setSymbolLayer(QgsSymbolLayer *layer)=0
void changed()
Should be emitted whenever configuration changes happened on this symbol layer configuration.
void symbolChanged()
Should be emitted whenever the sub symbol changed on this symbol layer configuration.
virtual void setContext(const QgsSymbolWidgetContext &context)
Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression ...
Property
Data definable properties.
@ PropertyLayerEnabled
Whether symbol layer is enabled.
virtual bool setSubSymbol(QgsSymbol *symbol)
Sets layer's subsymbol. takes ownership of the passed symbol.
virtual QColor color() const
The fill color.
void setPaintEffect(QgsPaintEffect *effect)
Sets the current paint effect for the layer.
QgsPaintEffect * paintEffect() const
Returns the current paint effect for the layer.
void setEnabled(bool enabled)
Sets whether symbol layer is enabled and should be drawn.
virtual QgsSymbolLayer * clone() const =0
Shall be reimplemented by subclasses to create a deep copy of the instance.
virtual QVariantMap properties() const =0
Should be reimplemented by subclasses to return a string map that contains the configuration informat...
bool enabled() const
Returns true if symbol layer is enabled and will be drawn.
virtual QString layerType() const =0
Returns a string that represents this layer type.
virtual void setDataDefinedProperty(Property key, const QgsProperty &property)
Sets a data defined property for the layer.
virtual QgsSymbol * subSymbol()
Returns the symbol's sub symbol, if present.
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the symbol layer property definitions.
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the symbol layer's property collection, used for data defined overrides.
Contains settings which reflect the context in which a symbol (or renderer) widget is shown,...
QList< QgsExpressionContextScope > additionalExpressionContextScopes() const
Returns the list of additional expression context scopes to show as available within the layer.
void setSymbolType(Qgis::SymbolType type)
Sets the associated symbol type, if the widget is being shown as a subcomponent of a parent symbol co...
QgsExpressionContext * expressionContext() const
Returns the expression context used for the widget, if set.
QgsMapCanvas * mapCanvas() const
Returns the map canvas associated with the widget.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:38
Qgis::SymbolType type() const
Returns the symbol's type.
Definition: qgssymbol.h:97
virtual QgsSymbol * clone() const =0
Returns a deep copy of this symbol.
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:169
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsVectorFieldSymbolLayerWidget.
Represents a vector layer which manages a vector based data sets.
#define QgsDebugMsg(str)
Definition: qgslogger.h:38
QList< QgsSymbolLayer * > QgsSymbolLayerList
Definition: qgssymbol.h:27
QgsSymbolLayerWidget *(* QgsSymbolLayerWidgetFunc)(QgsVectorLayer *)
Single variable definition for use within a QgsExpressionContextScope.