QGIS API Documentation: QgsSymbolSelectorDialog Class Reference

QGIS API Documentation 3.18.1-Zürich (202f1bf7e5)

#include <qgssymbolselectordialog.h>

Inheritance diagram for QgsSymbolSelectorDialog:

Inheritance graph

[legend]

Public Slots
void	addLayer ()

void	changeLayer (QgsSymbolLayer *layer)
	alters tree and sets proper widget when Layer Type is changed More...

void	duplicateLayer ()
	Duplicates the current symbol layer and places the duplicated layer above the current symbol layer. More...

void	layerChanged ()

void	lockLayer ()

void	moveLayerDown ()

void	moveLayerUp ()

void	removeLayer ()

void	symbolChanged ()
	Slot to update tree when a new symbol from style. More...

void	updateLayerPreview ()

void	updatePreview ()

Signals
void	symbolModified ()

Public Member Functions
	QgsSymbolSelectorDialog (QgsSymbol symbol, QgsStyle style, QgsVectorLayer vl, QWidget parent=nullptr, bool embedded=false)
	Constructor for QgsSymbolSelectorDialog. More...

QMenu *	advancedMenu ()
	Returns menu for "advanced" button - create it if doesn't exist and show the advanced button. More...

QDialogButtonBox *	buttonBox () const
	Returns a reference to the dialog's button box. More...

QgsSymbolWidgetContext	context () const
	Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. More...

void	loadSymbol (QgsSymbol symbol, SymbolLayerItem parent=nullptr)
	Loads the given symbol into the widget. More...

void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. More...

QgsSymbol *	symbol ()
	Returns the symbol that is currently active in the widget. More...

Protected Member Functions
void	keyPressEvent (QKeyEvent *e) override

Detailed Description

Definition at line 276 of file qgssymbolselectordialog.h.

Constructor & Destructor Documentation

◆ QgsSymbolSelectorDialog()

QgsSymbolSelectorDialog::QgsSymbolSelectorDialog	(	QgsSymbol *	symbol,
		QgsStyle *	style,
		QgsVectorLayer *	vl,
		QWidget *	parent = `nullptr`,
		bool	embedded = `false`
	)

Constructor for QgsSymbolSelectorDialog.

Parameters

symbol	The symbol
style	The style
vl	Associated vector layer
parent	Parent widget
embedded	`true` to embed in renderer properties dialog, `false` otherwise

Definition at line 756 of file qgssymbolselectordialog.cpp.

Member Function Documentation

◆ addLayer

void QgsSymbolSelectorDialog::addLayer ( )

slot

Definition at line 873 of file qgssymbolselectordialog.cpp.

◆ advancedMenu()

QMenu * QgsSymbolSelectorDialog::advancedMenu ( )

Returns menu for "advanced" button - create it if doesn't exist and show the advanced button.

Definition at line 790 of file qgssymbolselectordialog.cpp.

◆ buttonBox()

QDialogButtonBox * QgsSymbolSelectorDialog::buttonBox ( ) const

Returns a reference to the dialog's button box.

Since: QGIS 3.10

Definition at line 918 of file qgssymbolselectordialog.cpp.

◆ changeLayer

void QgsSymbolSelectorDialog::changeLayer ( QgsSymbolLayer * layer )

slot

alters tree and sets proper widget when Layer Type is changed

Note: : The layer is received from the LayerPropertiesWidget

Definition at line 913 of file qgssymbolselectordialog.cpp.

◆ context()

QgsSymbolWidgetContext QgsSymbolSelectorDialog::context ( ) const

Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

See also: setContext()

Since: QGIS 3.0

Definition at line 800 of file qgssymbolselectordialog.cpp.

◆ duplicateLayer

void QgsSymbolSelectorDialog::duplicateLayer ( )

slot

Duplicates the current symbol layer and places the duplicated layer above the current symbol layer.

Since: QGIS 2.14

Definition at line 888 of file qgssymbolselectordialog.cpp.

◆ keyPressEvent()

void QgsSymbolSelectorDialog::keyPressEvent ( QKeyEvent * e )

overrideprotected

Definition at line 810 of file qgssymbolselectordialog.cpp.

◆ layerChanged

void QgsSymbolSelectorDialog::layerChanged ( )

slot

Definition at line 893 of file qgssymbolselectordialog.cpp.

◆ loadSymbol()

void QgsSymbolSelectorDialog::loadSymbol	(	QgsSymbol *	symbol,
		SymbolLayerItem *	parent = `nullptr`
	)

Loads the given symbol into the widget.

Parameters

symbol	The symbol to load.
parent	The parent symbol layer item. If the parent parameter is null, the whole symbol and model will be reset.

Definition at line 828 of file qgssymbolselectordialog.cpp.

◆ lockLayer

void QgsSymbolSelectorDialog::lockLayer ( )

slot

Definition at line 883 of file qgssymbolselectordialog.cpp.

◆ moveLayerDown

void QgsSymbolSelectorDialog::moveLayerDown ( )

slot

Definition at line 863 of file qgssymbolselectordialog.cpp.

◆ moveLayerUp

void QgsSymbolSelectorDialog::moveLayerUp ( )

slot

Definition at line 868 of file qgssymbolselectordialog.cpp.

◆ removeLayer

void QgsSymbolSelectorDialog::removeLayer ( )

slot

Definition at line 878 of file qgssymbolselectordialog.cpp.

◆ setContext()

void QgsSymbolSelectorDialog::setContext ( const QgsSymbolWidgetContext & context )

Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

Parameters

context symbol widget context

See also: context()

Since: QGIS 3.0

Definition at line 795 of file qgssymbolselectordialog.cpp.

◆ symbol()

QgsSymbol * QgsSymbolSelectorDialog::symbol ( )

Returns the symbol that is currently active in the widget.

Can be nullptr.

Returns: The active symbol.

Definition at line 805 of file qgssymbolselectordialog.cpp.

◆ symbolChanged

void QgsSymbolSelectorDialog::symbolChanged ( )

slot

Slot to update tree when a new symbol from style.

Definition at line 908 of file qgssymbolselectordialog.cpp.

◆ symbolModified

void QgsSymbolSelectorDialog::symbolModified ( )

signal

◆ updateLayerPreview

void QgsSymbolSelectorDialog::updateLayerPreview ( )

slot

Definition at line 898 of file qgssymbolselectordialog.cpp.

◆ updatePreview

void QgsSymbolSelectorDialog::updatePreview ( )

slot

Definition at line 903 of file qgssymbolselectordialog.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.18.1+99unstable/src/gui/symbology/qgssymbolselectordialog.h
/build/qgis-3.18.1+99unstable/src/gui/symbology/qgssymbolselectordialog.cpp