QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
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"
27
28#include "qgsapplication.h"
29#include "qgslogger.h"
30
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"
45#include "qgssymbollayerutils.h"
47#include "qgsmarkersymbol.h"
48#include "qgslinesymbol.h"
49#include "qgsfillsymbol.h"
51
52static bool _initWidgetFunction( const QString &name, QgsSymbolLayerWidgetFunc f )
53{
55
56 QgsSymbolLayerAbstractMetadata *abstractMetadata = reg->symbolLayerMetadata( name );
57 if ( !abstractMetadata )
58 {
59 QgsDebugError( "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 QgsDebugError( "Failed to cast symbol layer's metadata: " + name );
66 return false;
67 }
68 metadata->setWidgetFunction( f );
69 return true;
70}
71
72static 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 _initWidgetFunction( QStringLiteral( "FilledLine" ), QgsFilledLineSymbolLayerWidget::create );
86
87 _initWidgetFunction( QStringLiteral( "SimpleMarker" ), QgsSimpleMarkerSymbolLayerWidget::create );
88 _initWidgetFunction( QStringLiteral( "FilledMarker" ), QgsFilledMarkerSymbolLayerWidget::create );
89 _initWidgetFunction( QStringLiteral( "SvgMarker" ), QgsSvgMarkerSymbolLayerWidget::create );
90 _initWidgetFunction( QStringLiteral( "RasterMarker" ), QgsRasterMarkerSymbolLayerWidget::create );
91 _initWidgetFunction( QStringLiteral( "AnimatedMarker" ), QgsAnimatedMarkerSymbolLayerWidget::create );
92 _initWidgetFunction( QStringLiteral( "FontMarker" ), QgsFontMarkerSymbolLayerWidget::create );
93 _initWidgetFunction( QStringLiteral( "EllipseMarker" ), QgsEllipseSymbolLayerWidget::create );
94 _initWidgetFunction( QStringLiteral( "VectorField" ), QgsVectorFieldSymbolLayerWidget::create );
95 _initWidgetFunction( QStringLiteral( "MaskMarker" ), QgsMaskMarkerSymbolLayerWidget::create );
96
97 _initWidgetFunction( QStringLiteral( "SimpleFill" ), QgsSimpleFillSymbolLayerWidget::create );
98 _initWidgetFunction( QStringLiteral( "GradientFill" ), QgsGradientFillSymbolLayerWidget::create );
99 _initWidgetFunction( QStringLiteral( "ShapeburstFill" ), QgsShapeburstFillSymbolLayerWidget::create );
100 _initWidgetFunction( QStringLiteral( "RasterFill" ), QgsRasterFillSymbolLayerWidget::create );
101 _initWidgetFunction( QStringLiteral( "SVGFill" ), QgsSVGFillSymbolLayerWidget::create );
102 _initWidgetFunction( QStringLiteral( "CentroidFill" ), QgsCentroidFillSymbolLayerWidget::create );
103 _initWidgetFunction( QStringLiteral( "LinePatternFill" ), QgsLinePatternFillSymbolLayerWidget::create );
104 _initWidgetFunction( QStringLiteral( "PointPatternFill" ), QgsPointPatternFillSymbolLayerWidget::create );
105 _initWidgetFunction( QStringLiteral( "RandomMarkerFill" ), QgsRandomMarkerFillSymbolLayerWidget::create );
106
107 _initWidgetFunction( QStringLiteral( "GeometryGenerator" ), QgsGeometryGeneratorSymbolLayerWidget::create );
108
109 sInitialized = true;
110}
111
112
114 : QgsPanelWidget( parent )
115 , mLayer( layer )
116 , mSymbol( symbol )
117 , mVectorLayer( vl )
118{
119
120 setupUi( this );
121 connect( mEnabledCheckBox, &QCheckBox::toggled, this, &QgsLayerPropertiesWidget::mEnabledCheckBox_toggled );
122 // initialize the sub-widgets
123 // XXX Should this thing be here this way? Initialize all the widgets just for the sake of one layer?
124 // TODO Make this on demand creation
125 _initWidgetFunctions();
126
127 // TODO Algorithm
128 //
129 // 3. populate the combo box with the supported layer type
130 // 4. set the present layer type
131 // 5. create the widget for the present layer type and set in stacked widget
132 // 6. connect comboBox type changed to two things
133 // 1. emit signal that type has beed changed
134 // 2. remove the widget and place the new widget corresponding to the changed layer type
135 //
137 // update layer type combo box
138 const int idx = cboLayerType->findData( mLayer->layerType() );
139 cboLayerType->setCurrentIndex( idx );
140
141 connect( mEnabledCheckBox, &QAbstractButton::toggled, mEnabledDDBtn, &QWidget::setEnabled );
142 mEnabledCheckBox->setChecked( mLayer->enabled() );
143
144 // set the corresponding widget
146 connect( cboLayerType, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsLayerPropertiesWidget::layerTypeChanged );
147
149
150 this->connectChildPanel( mEffectWidget );
151
152 if ( !mLayer->paintEffect() )
153 {
155 mLayer->paintEffect()->setEnabled( false );
156 }
157 mEffectWidget->setPaintEffect( mLayer->paintEffect() );
158
160}
161
163{
164 mContext = context;
165 if ( mSymbol )
166 mContext.setSymbolType( mSymbol->type() );
167
168 QgsSymbolLayerWidget *w = dynamic_cast< QgsSymbolLayerWidget * >( stackedWidget->currentWidget() );
169 if ( w )
170 w->setContext( mContext );
171}
172
174{
175 return mContext;
176}
177
179{
181 mEffectWidget->setDockMode( this->dockMode() );
182}
183
185{
186 const QStringList symbolLayerIds = QgsApplication::symbolLayerRegistry()->symbolLayersForType( mSymbol->type() );
187
188 const auto constSymbolLayerIds = symbolLayerIds;
189 for ( const QString &symbolLayerId : constSymbolLayerIds )
190 cboLayerType->addItem( QgsApplication::symbolLayerRegistry()->symbolLayerMetadata( symbolLayerId )->visibleName(), symbolLayerId );
191
193 {
195 const auto constLineLayerIds = lineLayerIds;
196 for ( const QString &lineLayerId : constLineLayerIds )
197 {
199 if ( layerInfo->type() != Qgis::SymbolType::Hybrid )
200 {
201 const QString visibleName = layerInfo->visibleName();
202 const QString name = tr( "Outline: %1" ).arg( visibleName );
203 cboLayerType->addItem( name, lineLayerId );
204 }
205 }
206 }
207}
208
210{
211 if ( stackedWidget->currentWidget() != pageDummy )
212 {
213 // stop updating from the original widget
214 if ( QgsSymbolLayerWidget *w = qobject_cast< QgsSymbolLayerWidget * >( stackedWidget->currentWidget() ) )
216 stackedWidget->removeWidget( stackedWidget->currentWidget() );
217 }
218
220
221 const QString layerType = layer->layerType();
223 if ( am )
224 {
226 if ( w )
227 {
228 w->setContext( mContext );
229 w->setSymbolLayer( layer );
230 stackedWidget->addWidget( w );
231 stackedWidget->setCurrentWidget( w );
232 // start receiving updates from widget
234 connect( w, &QgsSymbolLayerWidget::symbolChanged, this, &QgsLayerPropertiesWidget::reloadLayer );
235 return;
236 }
237 }
238 // When anything is not right
239 stackedWidget->setCurrentWidget( pageDummy );
240}
241
243{
244 if ( auto *lExpressionContext = mContext.expressionContext() )
245 return *lExpressionContext;
246
247 QgsExpressionContext expContext;
251
252 if ( auto *lMapCanvas = mContext.mapCanvas() )
253 {
254 expContext << QgsExpressionContextUtils::mapSettingsScope( lMapCanvas->mapSettings() )
255 << new QgsExpressionContextScope( lMapCanvas->expressionContextScope() );
256 if ( const QgsExpressionContextScopeGenerator *generator = dynamic_cast< const QgsExpressionContextScopeGenerator * >( lMapCanvas->temporalController() ) )
257 {
258 expContext << generator->createExpressionContextScope();
259 }
260 }
261 else
262 {
264 }
265
267
269 if ( mLayer )
270 {
271 //cheat a bit - set the symbol color variable to match the symbol layer's color (when we should really be using the *symbols*
272 //color, but that's not accessible here). 99% of the time these will be the same anyway
274 }
275 expContext << symbolScope;
281 expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_layer_count" ), 1, true ) );
282 expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_layer_index" ), 1, true ) );
283 expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_marker_row" ), 1, true ) );
284 expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_marker_column" ), 1, true ) );
285 expContext.lastScope()->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "symbol_frame" ), 1, true ) );
286
287 // additional scopes
288 const auto constAdditionalExpressionContextScopes = mContext.additionalExpressionContextScopes();
289 for ( const QgsExpressionContextScope &scope : constAdditionalExpressionContextScopes )
290 {
291 expContext.appendScope( new QgsExpressionContextScope( scope ) );
292 }
293
294 //TODO - show actual value
295 expContext.setOriginalValueVariable( QVariant() );
296
302 << QStringLiteral( "symbol_layer_count" ) << QStringLiteral( "symbol_layer_index" )
303 << QStringLiteral( "symbol_frame" ) );
304
305 return expContext;
306}
307
309{
310 button->init( static_cast< int >( key ), mLayer->dataDefinedProperties(), QgsSymbolLayer::propertyDefinitions(), mVectorLayer );
311 connect( button, &QgsPropertyOverrideButton::changed, this, &QgsLayerPropertiesWidget::updateProperty );
313}
314
315void QgsLayerPropertiesWidget::updateProperty()
316{
317 QgsPropertyOverrideButton *button = qobject_cast<QgsPropertyOverrideButton *>( sender() );
318 const QgsSymbolLayer::Property key = static_cast< QgsSymbolLayer::Property >( button->propertyKey() );
319 mLayer->setDataDefinedProperty( key, button->toProperty() );
320 emit changed();
321}
322
324{
325 QgsSymbolLayer *layer = mLayer;
326 if ( !layer )
327 return;
328 const QString newLayerType = cboLayerType->currentData().toString();
329 if ( layer->layerType() == newLayerType )
330 return;
331
332 // get creation function for new layer from registry
334 QgsSymbolLayerAbstractMetadata *am = pReg->symbolLayerMetadata( newLayerType );
335 if ( !am ) // check whether the metadata is assigned
336 return;
337
338 // change layer to a new (with different type)
339 // base new layer on existing layer's properties
340 QVariantMap properties = layer->properties();
341
342 // if the old symbol layer was a "geometry generator" layer then
343 // we instead get the properties from the generator
344 if ( QgsGeometryGeneratorSymbolLayer *generator = dynamic_cast< QgsGeometryGeneratorSymbolLayer * >( layer ) )
345 {
346 if ( generator->subSymbol() && generator->subSymbol()->symbolLayerCount() > 0 )
347 properties = generator->subSymbol()->symbolLayer( 0 )->properties();
348 }
349
350 QgsSymbolLayer *newLayer = am->createSymbolLayer( properties );
351 if ( !newLayer )
352 return;
353
354 // if a symbol layer is changed to a "geometry generator" layer, then we move the old symbol layer into the
355 // geometry generator's subsymbol.
356 if ( QgsGeometryGeneratorSymbolLayer *generator = dynamic_cast< QgsGeometryGeneratorSymbolLayer * >( newLayer ) )
357 {
358 if ( mSymbol )
359 {
360 switch ( mSymbol->type() )
361 {
363 {
364 std::unique_ptr< QgsMarkerSymbol > markerSymbol = std::make_unique< QgsMarkerSymbol >( QgsSymbolLayerList( {layer->clone() } ) );
365 generator->setSymbolType( Qgis::SymbolType::Marker );
366 generator->setSubSymbol( markerSymbol.release() );
367 break;
368 }
370 {
371 std::unique_ptr< QgsLineSymbol > lineSymbol = std::make_unique< QgsLineSymbol >( QgsSymbolLayerList( {layer->clone() } ) );
372 generator->setSymbolType( Qgis::SymbolType::Line );
373 generator->setSubSymbol( lineSymbol.release() );
374 break;
375 }
377 {
378 std::unique_ptr< QgsFillSymbol > fillSymbol = std::make_unique< QgsFillSymbol >( QgsSymbolLayerList( {layer->clone() } ) );
379 generator->setSymbolType( Qgis::SymbolType::Fill );
380 generator->setSubSymbol( fillSymbol.release() );
381 break;
382 }
384 break;
385 }
386 }
387 }
388 else
389 {
390 // try to copy the subsymbol, if its the same type as the new symbol layer's subsymbol
391 if ( newLayer->subSymbol() && layer->subSymbol() && newLayer->subSymbol()->type() == layer->subSymbol()->type() )
392 {
393 newLayer->setSubSymbol( layer->subSymbol()->clone() );
394 }
395 }
396
397 // special logic for when NEW symbol layers are created from GUI only...
398 // TODO: find a nicer generic way to handle this!
399 if ( QgsFontMarkerSymbolLayer *fontMarker = dynamic_cast< QgsFontMarkerSymbolLayer * >( newLayer ) )
400 {
401 const QString defaultFont = fontMarker->fontFamily();
402 const QFontDatabase fontDb;
403 if ( !fontDb.hasFamily( defaultFont ) )
404 {
405 // default font marker font choice doesn't exist on system, so just use first available symbol font
406 const QStringList candidates = fontDb.families( QFontDatabase::WritingSystem::Symbol );
407 bool foundGoodCandidate = false;
408 for ( const QString &candidate : candidates )
409 {
410 if ( fontDb.writingSystems( candidate ).size() == 1 )
411 {
412 // family ONLY offers symbol writing systems, so it's a good candidate!
413 fontMarker->setFontFamily( candidate );
414 foundGoodCandidate = true;
415 break;
416 }
417 }
418 if ( !foundGoodCandidate && !candidates.empty() )
419 {
420 // fallback to first available family which advertises symbol writing system
421 QString candidate = candidates.at( 0 );
422 fontMarker->setFontFamily( candidate );
423 }
424 }
425
426 // search (briefly!!) for a unicode character which actually exists in the font
427 const QFontMetrics fontMetrics( fontMarker->fontFamily() );
428 ushort character = fontMarker->character().at( 0 ).unicode();
429 for ( ; character < 1000; ++character )
430 {
431 if ( fontMetrics.inFont( QChar( character ) ) )
432 {
433 fontMarker->setCharacter( QChar( character ) );
434 break;
435 }
436 }
437 }
438
439 updateSymbolLayerWidget( newLayer );
440 emit changeLayer( newLayer );
441}
442
444{
445 emit changed();
446
447 // also update paint effect preview
448 bool paintEffectToggled = false;
449 if ( mLayer->paintEffect() && mLayer->paintEffect()->enabled() )
450 {
451 mLayer->paintEffect()->setEnabled( false );
452 paintEffectToggled = true;
453 }
455 if ( paintEffectToggled )
456 {
457 mLayer->paintEffect()->setEnabled( true );
458 }
459 emit widgetChanged();
460}
461
462void QgsLayerPropertiesWidget::reloadLayer()
463{
464 emit changeLayer( mLayer );
465}
466
467void QgsLayerPropertiesWidget::mEnabledCheckBox_toggled( bool enabled )
468{
469 mLayer->setEnabled( enabled );
471}
@ Millimeters
Millimeters.
@ Marker
Marker symbol.
@ Line
Line symbol.
@ Fill
Fill symbol.
@ Hybrid
Hybrid symbol.
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsAnimatedMarkerSymbolLayerWidget.
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 QgsFilledLineSymbolLayerWidget.
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:481
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, Qgis::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 ...
virtual QgsSymbolLayer * clone() const =0
Shall be reimplemented by subclasses to create a deep copy of the instance.
virtual bool setSubSymbol(QgsSymbol *symbol)
Sets layer's subsymbol. takes ownership of the passed symbol.
Property
Data definable properties.
@ LayerEnabled
Whether symbol layer is enabled.
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 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.
virtual QColor color() const
Returns the "representative" color of the symbol layer.
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:94
virtual QgsSymbol * clone() const =0
Returns a deep copy of this symbol.
Qgis::SymbolType type() const
Returns the symbol's type.
Definition: qgssymbol.h:156
static QgsSymbolLayerWidget * create(QgsVectorLayer *vl)
Creates a new QgsVectorFieldSymbolLayerWidget.
Represents a vector layer which manages a vector based data sets.
#define QgsDebugError(str)
Definition: qgslogger.h:38
QList< QgsSymbolLayer * > QgsSymbolLayerList
Definition: qgssymbol.h:30
QgsSymbolLayerWidget *(* QgsSymbolLayerWidgetFunc)(QgsVectorLayer *)
Single variable definition for use within a QgsExpressionContextScope.