Class: QgsSettingsTree

QgsSettingsTree holds the tree structure for the settings in QGIS core

See also

QgsSettingsEntryBase

Added in version 3.30.

Methods

node	Returns the tree node at the given key

Static Methods

createPluginTreeNode	Creates a settings tree node for the given pluginName
treeRoot	Returns the tree root node for the settings tree
unregisterPluginTreeNode	Unregisters the tree node for the given plugin

class qgis.core.QgsSettingsTree

Bases: object

static 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]

static treeRoot() → QgsSettingsTreeNode | None

Returns the tree root node for the settings tree

Return type:

Optional[QgsSettingsTreeNode]

static unregisterPluginTreeNode(pluginName: str | None)

Unregisters the tree node for the given plugin

Parameters:

pluginName (Optional[str])