Class: QgsSettingsTree

class qgis.core.QgsSettingsTree

Bases: sip.wrapper

QgsSettingsTree holds the tree structure for the settings in QGIS core

Added in version 3.30:

Methods

createPluginTreeNode

Creates a settings tree node for the given pluginName

node

Returns the tree node at the given key

unregisterPluginTreeNode

Unregisters the tree node for the given plugin

createPluginTreeNode(pluginName: str | None) QgsSettingsTreeNode | None

Creates a settings tree node for the given pluginName

Parameters:

pluginName (Optional[str])

Return type:

Optional[QgsSettingsTreeNode]

node(key: str | None) QgsSettingsTreeNode | None

Returns the tree node at the given key

Note

For Plugins, use createPluginTreeNode() to create nodes for plugin settings.

Parameters:

key (Optional[str])

Return type:

Optional[QgsSettingsTreeNode]

unregisterPluginTreeNode(pluginName: str | None)

Unregisters the tree node for the given plugin

Parameters:

pluginName (Optional[str])