QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Signals | Public Member Functions | Protected Member Functions | List of all members
QgsStyleItemsListWidget Class Reference

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

#include <qgsstyleitemslistwidget.h>

Inheritance diagram for QgsStyleItemsListWidget:
Inheritance graph
[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. More...
 
void selectionChanged (const QString &name, QgsStyle::StyleEntity type)
 Emitted when the selected item is changed in the widget. More...
 

Public Member Functions

 QgsStyleItemsListWidget (QWidget *parent SIP_TRANSFERTHIS)
 Constructor for QgsStyleItemsListWidget, with the specified parent widget. More...
 
QMenu * advancedMenu ()
 Returns a pointer to the widget's current advanced menu. More...
 
QgsStyle::StyleEntity currentEntityType () const
 Returns the type of the item currently selected in the widget. More...
 
QString currentItemName () const
 Returns the name of the item currently selected in the widget. More...
 
QString currentTagFilter () const
 Returns the current tag filter set for the widget, if any is set. More...
 
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. More...
 
void setEntityType (QgsStyle::StyleEntity type)
 Sets the type of style entity to show in the widget. More...
 
void setEntityTypes (const QList< QgsStyle::StyleEntity > &filters) SIP_SKIP
 Sets the types of style entity to show in the widget. More...
 
void setLayerType (QgsWkbTypes::GeometryType type)
 Sets the layer type to show in the widget. More...
 
void setStyle (QgsStyle *style)
 Sets the style database associated with the widget. More...
 
void setSymbolType (QgsSymbol::SymbolType type)
 Sets the type of symbols to show in the widget. More...
 
void showAdvancedButton (bool enabled)
 Sets whether the advanced button should be shown in the widget. More...
 

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 51 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 67 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 252 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 282 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 271 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 247 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
nameNewly selected item name
typeNewly selected item type

◆ 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 257 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 165 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 220 of file qgsstyleitemslistwidget.cpp.

◆ setLayerType()

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

Sets the layer type to show in the widget.

Set type to QgsWkbTypes::UnknownGeometry if no layer type filter is desired.

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

Definition at line 242 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 140 of file qgsstyleitemslistwidget.cpp.

◆ setSymbolType()

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

Sets the type of symbols to show in the widget.

See also
setEntityType()

Definition at line 236 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 266 of file qgsstyleitemslistwidget.cpp.

◆ showEvent()

void QgsStyleItemsListWidget::showEvent ( QShowEvent *  event)
overrideprotected

Definition at line 293 of file qgsstyleitemslistwidget.cpp.


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