Class: QgsStyleManagerDialog

class qgis.gui.QgsStyleManagerDialog(style: QgsStyle, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())

Bases: PyQt5.QtWidgets.QDialog

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.

A dialog allowing users to customize and populate a QgsStyle.

Parameters
  • style (QgsStyle) –

  • parent (QWidget = None) –

  • flags

actionEvent()
activate(self)

Raises, unminimizes and activates this window

New in version 3.4.

addColorRamp(self, action: QAction) → bool

addColorRamp(self) -> bool add a new color ramp to style

Parameters

action (QAction) –

Return type

bool

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

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

Parameters
  • parent (QWidget) –

  • style (QgsStyle) –

  • RampType (str = '') –

Return type

str

addFavoriteSelectedSymbols(self)

Add selected symbols to favorites

addItem(self)
addSmartgroup(self) → int

add a smartgroup

Return type

int

addSymbol(self) → bool

add a new symbol to style

Return type

bool

addTag(self) → int

add a tag

Return type

int

changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
currentItemName(self) → str
Return type

str

currentItemType(self) → int
Return type

int

customEvent()
destroy()
detagSelectedSymbols(self)

Remove all tags from selected symbols

disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
editColorRamp(self) → bool
Return type

bool

editItem(self)
editSmartgroupAction(self)

edit the selected smart group

editSymbol(self) → bool
Return type

bool

enableGroupInputs(self, bool)

Enables or disables the groupTree specific inputs

enableItemsForGroupingMode(self, bool)

Enables or disables the groupTree items for grouping mode

enableSymbolInputs(self, bool)

Enables or disbables the symbol specific inputs

enterEvent()
event()
eventFilter()
exportItems(self)
exportItemsPNG(self)
exportItemsSVG(self)
exportSelectedItemsImages(self, dir: str, format: str, size: QSize)
Parameters
  • dir (str) –

  • format (str) –

  • size (QSize) –

filterSymbols(self, str)

filter the symbols based on input search term

focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
groupChanged(self, QModelIndex)
groupRenamed(self, QStandardItem)
grouptreeContextMenu(self, QPoint)

Context menu for the groupTree

hideEvent()
importItems(self)
initPainter()
inputMethodEvent()
isSignalConnected()
itemChanged(self, item: QStandardItem)
Parameters

item (QStandardItem) –

keyPressEvent()
keyReleaseEvent()
leaveEvent()
listitemsContextMenu(self, QPoint)

Context menu for the listItems ( symbols list )

metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
onClose(self)

Close the dialog

onFinished(self)

called when the dialog is going to be closed

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

populate list view with color ramps

Parameters
  • colorRamps (Iterable[str]) –

  • checkable (bool = False) –

populateGroups(self)

populate the groups

populateList(self)

adds symbols of some type to list

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

populate list view with symbols of the current type with the given names

Parameters
  • symbolNames (Iterable[str]) –

  • checkable (bool = False) –

populateTypes(self)

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

receivers()
regrouped(self, QStandardItem)

symbol changed from one group

removeColorRamp(self) → bool
Return type

bool

removeFavoriteSelectedSymbols(self)

Remove selected symbols from favorites

removeGroup(self)

remove a tag or smartgroup

removeItem(self)
removeSymbol(self) → bool
Return type

bool

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

Perform tasks when the selected symbols change

Parameters
  • selected (QItemSelection) –

  • deselected (QItemSelection) –

sender()
senderSignalIndex()
setBold(self, QStandardItem)

sets the text of the item with bold font

setSymbolsChecked(self, Iterable[str])

to set symbols checked when in editing mode

sharedPainter()
showEvent()
showHelp(self)

Open the associated help

symbolSelected(self, QModelIndex)

Perform symbol specific tasks when selected

tabletEvent()
tagSelectedSymbols(self, newTag: bool = False)

Tag selected symbols using menu item selection

Parameters

newTag (bool = False) –

tagSymbolsAction(self)

carry out symbol tagging using check boxes

timerEvent()
updateMicroFocus()
wheelEvent()