Class: QgsStyleManagerDialog

A dialog allowing users to customize and populate a QgsStyle.

QgsStyleManagerDialog

Class Hierarchy

Base classes

QDialog
QWidget
QObject
QPaintDevice

class qgis.gui.QgsStyleManagerDialog

Bases: QDialog

__init__(style: QgsStyle | None, parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = Qt.WindowFlags(), readOnly: bool = False)

Constructor for QgsStyleManagerDialog, with the specified parent widget and window flags.

The style argument specifies the linked QgsStyle database. Symbols and objects contained within this style will be shown in the dialog, and changes made within the dialog will be applied to style. The style object must last for the lifetime of the dialog.

Parameters:

• style (Optional[QgsStyle])

• parent (Optional[QWidget] = None)

• flags (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())

• readOnly (bool = False)

__init__(parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = Qt.WindowFlags())

Constructor for QgsStyleManagerDialog, with the specified parent widget and window flags.

All styles linked to the current project will be available.

Added in version 3.26.

Parameters:

• parent (Optional[QWidget] = None)

• flags (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())

activate(self)

Raises, unminimizes and activates this window

Added in version 3.4.

addColorRamp(self, type: str | None = '') → bool

Triggers adding a new color ramp.

If type is set to a string representing a valid QgsColorRamp.type() value then a new ramp of that type will be created. If type is empty, then the user will be prompted to select the color ramp type.

Parameters:

type (Optional[str] = '')

Return type:

bool

static addColorRampStatic(parent: QWidget | None, style: QgsStyle | None, RampType: str | None = '') → str

Opens the add color ramp dialog, returning the new color ramp’s name if the ramp has been added.

The RampType argument should be set to a string representing a valid QgsColorRamp.type() value.

Parameters:

• parent (Optional[QWidget])

• style (Optional[QgsStyle])

• RampType (Optional[str] = '')

Return type:

str

addFavoriteSelectedSymbols(self)

Add selected symbols to favorites

addItem(self)

Triggers the dialog for adding a new item, based on the currently selected item type tab.

addSmartgroup(self) → int

Triggers the dialog to add a new smart group.

Return type:

int

addSymbol(self, symbolType: int = -1) → bool

add a new symbol to style

Parameters:

symbolType (int = -1)

Return type:

bool

addTag(self) → int

Triggers the dialog to add a new tag.

Return type:

int

currentItemName(self) → str

Return type:

str

currentItemType(self) → int

Return type:

int

detagSelectedSymbols(self)

Remove all tags from selected symbols

editColorRamp(self) → bool

Return type:

bool

editItem(self)

Triggers the dialog for editing the current item.

editSmartgroupAction(self)

Triggers the dialog for editing the selected smart group.

editSymbol(self) → bool

Return type:

bool

enableGroupInputs(self, a0: bool)

Enables or disables the groupTree specific inputs

Parameters:

a0 (bool)

enableItemsForGroupingMode(self, a0: bool)

Enables or disables the groupTree items for grouping mode

Parameters:

a0 (bool)

enableSymbolInputs(self, a0: bool)

Enables or disbables the symbol specific inputs

Parameters:

a0 (bool)

exportItems(self)

Triggers the dialog to export items.

See also

importItems()

exportItemsPNG(self)

Triggers the dialog to export selected items as PNG files.

See also

exportItemsSVG()

See also

exportSelectedItemsImages()

exportItemsSVG(self)

Triggers the dialog to export selected items as SVG files.

See also

exportItemsPNG()

See also

exportSelectedItemsImages()

exportSelectedItemsImages(self, dir: str | None, format: str | None, size: QSize)

Triggers the dialog to export selected items as images of the specified format and size.

See also

exportItemsSVG()

See also

exportItemsPNG()

Parameters:

• dir (Optional[str])

• format (Optional[str])

• size (QSize)

filterSymbols(self, filter: str | None)

Sets the filter string to filter symbols by.

Parameters:

filter (Optional[str])

groupChanged(self, a0: QModelIndex)

Triggered when the current group (or tag) is changed.

Parameters:

a0 (QModelIndex)

groupRenamed(self, item: QStandardItem | None)

Triggered when a group item is renamed.

Parameters:

item (Optional[QStandardItem])

grouptreeContextMenu(self, a0: QPoint)

Context menu for the groupTree

Parameters:

a0 (QPoint)

importItems(self)

Triggers the dialog to import items.

See also

exportItems()

itemChanged(self, item: QStandardItem | None)

Deprecated since version 3.6.

Has no effect and will be removed in QGIS 4.0.

Parameters:

item (Optional[QStandardItem])

listitemsContextMenu(self, a0: QPoint)

Context menu for the listItems ( symbols list )

Parameters:

a0 (QPoint)

onClose(self)

Closes the dialog

onFinished(self)

Called when the dialog is going to be closed.

populateColorRamps(self, colorRamps: Iterable[str | None], checkable: bool = False)

Populates the list view with color ramps of the current type with the given names.

Deprecated since version 3.40: No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0.

Parameters:

• colorRamps (Iterable[Optional[str]])

• checkable (bool = False)

populateGroups(self)

populate the groups

populateList(self)

Refreshes the list of items.

populateSymbols(self, symbolNames: Iterable[str | None], checkable: bool = False)

Populates the list view with symbols of the current type with the given names.

Deprecated since version 3.40: No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0.

Parameters:

• symbolNames (Iterable[Optional[str]])

• checkable (bool = False)

populateTypes(self)

Populate combo box with known style items (symbols, color ramps).

Deprecated since version 3.6: Has no effect and will be removed in QGIS 4.0.

regrouped(self, a0: QStandardItem | None)

Deprecated since version 3.6.

Has no effect and will be removed in QGIS 4.0.

Parameters:

a0 (Optional[QStandardItem])

removeColorRamp(self) → bool

Deprecated since version 3.6.

Has no effect and will be removed in QGIS 4.0.

Return type:

bool

removeFavoriteSelectedSymbols(self)

Remove selected symbols from favorites

removeGroup(self)

Removes the selected tag or smartgroup.

removeItem(self)

Removes the current selected item.

removeSymbol(self) → bool

Deprecated since version 3.6.

Has no effect and will be removed in QGIS 4.0.

Return type:

bool

selectedSymbolsChanged(self, selected: QItemSelection, deselected: QItemSelection)

Perform tasks when the selected symbols change

Parameters:

• selected (QItemSelection)

• deselected (QItemSelection)

setBaseStyleName(self, name: str | None)

Sets the base name for the style, which is used by the dialog to reflect the original style/XML file name.

name should be stripped of any extensions and folder information, e.g. “transport_styles”, not “d:/stuff/transport_styles.xml”.

Added in version 3.6.

Parameters:

name (Optional[str])

setBold(self, a0: QStandardItem | None)

sets the text of the item with bold font

Parameters:

a0 (Optional[QStandardItem])

setFavoritesGroupVisible(self, show: bool)

Sets whether the favorites group should be shown. The default is to show the group.

Added in version 3.6.

Parameters:

show (bool)

setSmartGroupsVisible(self, show: bool)

Sets whether smart groups should be shown. The default is to show the groups.

Added in version 3.6.

Parameters:

show (bool)

setSymbolsChecked(self, a0: Iterable[str | None])

Deprecated since version 3.6.

Has no effect and will be removed in QGIS 4.0.

Parameters:

a0 (Iterable[Optional[str]])

showHelp(self)

Opens the associated help

symbolSelected(self, a0: QModelIndex)

Perform symbol specific tasks when selected

Parameters:

a0 (QModelIndex)

tagSelectedSymbols(self, newTag: bool = False)

Tag selected symbols using menu item selection

Parameters:

newTag (bool = False)

tagSymbolsAction(self)

Toggles the interactive item tagging mode.