A reusable widget for showing a filtered list of entities from a QgsStyle database. More...

#include <qgsstyleitemslistwidget.h>

Inheritance diagram for QgsStyleItemsListWidget:

[legend]

Signals
void	saveEntity ()
	Emitted when the user has opted to save a new entity to the style database, by clicking the "Save" button in the widget.

void	selectionChanged (const QString &name, QgsStyle::StyleEntity type)
	Emitted when the selected item is changed in the widget.

void	selectionChangedWithStylePath (const QString &name, QgsStyle::StyleEntity type, const QString &stylePath)
	Emitted when the selected item is changed in the widget.

Public Member Functions
	QgsStyleItemsListWidget (QWidget *parent SIP_TRANSFERTHIS)
	Constructor for QgsStyleItemsListWidget, with the specified parent widget.

QMenu *	advancedMenu ()
	Returns a pointer to the widget's current advanced menu.

QgsStyle::StyleEntity	currentEntityType () const
	Returns the type of the item currently selected in the widget.

QString	currentItemName () const
	Returns the name of the item currently selected in the widget.

QString	currentTagFilter () const
	Returns the current tag filter set for the widget, if any is set.

void	setAdvancedMenu (QMenu *menu)
	Sets the widget's advanced menu, which is shown when the user clicks the "Advanced" button in the widget's GUI.

void	setEntityType (QgsStyle::StyleEntity type)
	Sets the type of style entity to show in the widget.

void	setEntityTypes (const QList< QgsStyle::StyleEntity > &filters) SIP_SKIP
	Sets the types of style entity to show in the widget.

void	setLayerType (Qgis::GeometryType type)
	Sets the layer type to show in the widget.

void	setStyle (QgsStyle *style)
	Sets the style database associated with the widget.

void	setSymbolType (Qgis::SymbolType type)
	Sets the type of symbols to show in the widget.

void	showAdvancedButton (bool enabled)
	Sets whether the advanced button should be shown in the widget.

Protected Member Functions
void	showEvent (QShowEvent *event) override

Detailed Description

A reusable widget for showing a filtered list of entities from a QgsStyle database.

Since: QGIS 3.10

Definition at line 79 of file qgsstyleitemslistwidget.h.

Constructor & Destructor Documentation

◆ QgsStyleItemsListWidget()

QgsStyleItemsListWidget::QgsStyleItemsListWidget ( QWidget *parent SIP_TRANSFERTHIS )

Constructor for QgsStyleItemsListWidget, with the specified parent widget.

Definition at line 176 of file qgsstyleitemslistwidget.cpp.

Member Function Documentation

◆ advancedMenu()

QMenu * QgsStyleItemsListWidget::advancedMenu ( )

Returns a pointer to the widget's current advanced menu.

See also: setAdvancedMenu()

Note: Not available in Python bindings.

Definition at line 362 of file qgsstyleitemslistwidget.cpp.

◆ currentEntityType()

QgsStyle::StyleEntity QgsStyleItemsListWidget::currentEntityType ( ) const

Returns the type of the item currently selected in the widget.

See also: currentItemName()

Definition at line 392 of file qgsstyleitemslistwidget.cpp.

◆ currentItemName()

QString QgsStyleItemsListWidget::currentItemName ( ) const

Returns the name of the item currently selected in the widget.

See also: currentEntityType()

Definition at line 381 of file qgsstyleitemslistwidget.cpp.

◆ currentTagFilter()

QString QgsStyleItemsListWidget::currentTagFilter ( ) const

Returns the current tag filter set for the widget, if any is set.

Definition at line 357 of file qgsstyleitemslistwidget.cpp.

◆ saveEntity

void QgsStyleItemsListWidget::saveEntity ( )

signal

Emitted when the user has opted to save a new entity to the style database, by clicking the "Save" button in the widget.

It is the caller's responsibility to handle this in an appropriate manner given the context of the widget.

◆ selectionChanged

void QgsStyleItemsListWidget::selectionChanged	(	const QString &	name,
		QgsStyle::StyleEntity	type
	)

signal

Emitted when the selected item is changed in the widget.

Parameters

name	Newly selected item name
type	Newly selected item type

◆ selectionChangedWithStylePath

void QgsStyleItemsListWidget::selectionChangedWithStylePath	(	const QString &	name,
		QgsStyle::StyleEntity	type,
		const QString &	stylePath
	)

signal

Emitted when the selected item is changed in the widget.

Parameters

name	Newly selected item name
type	Newly selected item type
stylePath	file path to associated style database

Since: QGIS 3.26

◆ setAdvancedMenu()

void QgsStyleItemsListWidget::setAdvancedMenu ( QMenu * menu )

Sets the widget's advanced menu, which is shown when the user clicks the "Advanced" button in the widget's GUI.

Ownership of menu is NOT transferred to the widget.

See also: advancedMenu()

Note: Not available in Python bindings.

Definition at line 367 of file qgsstyleitemslistwidget.cpp.

◆ setEntityType()

void QgsStyleItemsListWidget::setEntityType ( QgsStyle::StyleEntity type )

Sets the type of style entity to show in the widget.

See also: setSymbolType()

Definition at line 275 of file qgsstyleitemslistwidget.cpp.

◆ setEntityTypes()

void QgsStyleItemsListWidget::setEntityTypes ( const QList< QgsStyle::StyleEntity > & filters )

Sets the types of style entity to show in the widget.

Note: Not available in Python bindings.

Definition at line 330 of file qgsstyleitemslistwidget.cpp.

◆ setLayerType()

void QgsStyleItemsListWidget::setLayerType ( Qgis::GeometryType type )

Sets the layer type to show in the widget.

Set type to Qgis::GeometryType::Unknown if no layer type filter is desired.

This setting only applies to label settings and 3d style entities.

Definition at line 352 of file qgsstyleitemslistwidget.cpp.

◆ setStyle()

void QgsStyleItemsListWidget::setStyle ( QgsStyle * style )

Sets the style database associated with the widget.

Ownership of style is not transferred, and the caller is responsible for ensuring that it exists for the lifetime of the widget.

Definition at line 245 of file qgsstyleitemslistwidget.cpp.

◆ setSymbolType()

void QgsStyleItemsListWidget::setSymbolType ( Qgis::SymbolType type )

Sets the type of symbols to show in the widget.

See also: setEntityType()

Definition at line 346 of file qgsstyleitemslistwidget.cpp.

◆ showAdvancedButton()

void QgsStyleItemsListWidget::showAdvancedButton ( bool enabled )

Sets whether the advanced button should be shown in the widget.

By default the button is hidden.

See also: setAdvancedMenu()

Note: Not available in Python bindings.

Definition at line 376 of file qgsstyleitemslistwidget.cpp.

◆ showEvent()

void QgsStyleItemsListWidget::showEvent ( QShowEvent * event )

overrideprotected

Definition at line 403 of file qgsstyleitemslistwidget.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/qgsstyleitemslistwidget.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/qgsstyleitemslistwidget.cpp

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsStyleItemsListWidget()

Member Function Documentation

◆ advancedMenu()

◆ currentEntityType()

◆ currentItemName()

◆ currentTagFilter()

◆ saveEntity

◆ selectionChanged

◆ selectionChangedWithStylePath

◆ setAdvancedMenu()

◆ setEntityType()

◆ setEntityTypes()

◆ setLayerType()

◆ setStyle()

◆ setSymbolType()

◆ showAdvancedButton()

◆ showEvent()