QgsSettingsTree Class Reference

QgsSettingsTree holds the tree structure for the settings in QGIS core. More...

#include <qgssettingstree.h>

Static Public Member Functions
static QgsSettingsTreeNode *	createPluginTreeNode (const QString &pluginName)
	Creates a settings tree node for the given pluginName. More...
static const QgsSettingsTreeNode *	node (const QString &key)
	Returns the tree node at the given key. More...
static QgsSettingsTreeNode *	treeRoot ()
	Returns the tree root node for the settings tree. More...
static void	unregisterPluginTreeNode (const QString &pluginName)
	Unregisters the tree node for the given plugin. More...

Static Public Attributes
static QgsSettingsTreeNode *	sTreeApp = treeRoot()->createChildNode( QStringLiteral( "app" ) )
static QgsSettingsTreeNode *	sTreeConnections = treeRoot()->createChildNode( QStringLiteral( "connections" ) )
static QgsSettingsTreeNode *	sTreeCore = treeRoot()->createChildNode( QStringLiteral( "core" ) )
static QgsSettingsTreeNode *	sTreeDigitizing = treeRoot()->createChildNode( QStringLiteral( "digitizing" ) )
static QgsSettingsTreeNode *	sTreeElevationProfile = treeRoot()->createChildNode( QStringLiteral( "elevation-profile" ) )
static QgsSettingsTreeNode *	sTreeFonts = treeRoot()->createChildNode( QStringLiteral( "fonts" ) )
static QgsSettingsTreeNode *	sTreeGeometryValidation = treeRoot()->createChildNode( QStringLiteral( "geometry_validation" ) )
static QgsSettingsTreeNode *	sTreeGps = treeRoot()->createChildNode( QStringLiteral( "gps" ) )
static QgsSettingsTreeNode *	sTreeGui = treeRoot()->createChildNode( QStringLiteral( "gui" ) )
static QgsSettingsTreeNode *	sTreeLayerTree = treeRoot()->createChildNode( QStringLiteral( "layer-tree" ) )
static QgsSettingsTreeNode *	sTreeLayout = treeRoot()->createChildNode( QStringLiteral( "layout" ) )
static QgsSettingsTreeNode *	sTreeLocale = treeRoot()->createChildNode( QStringLiteral( "locale" ) )
static QgsSettingsTreeNode *	sTreeMap = treeRoot()->createChildNode( QStringLiteral( "map" ) )
static QgsSettingsTreeNode *	sTreeNetwork = treeRoot()->createChildNode( QStringLiteral( "network" ) )
static QgsSettingsTreeNode *	sTreePlugins = treeRoot()->createChildNode( QStringLiteral( "plugins" ) )
static QgsSettingsTreeNode *	sTreeProcessing = treeRoot()->createChildNode( QStringLiteral( "processing" ) )
static QgsSettingsTreeNode *	sTreeQgis = treeRoot()->createChildNode( QStringLiteral( "qgis" ) )
static QgsSettingsTreeNode *	sTreeRaster = treeRoot()->createChildNode( QStringLiteral( "raster" ) )
static QgsSettingsTreeNode *	sTreeRendering = treeRoot()->createChildNode( QStringLiteral( "rendering" ) )
static QgsSettingsTreeNode *	sTreeSvg = treeRoot()->createChildNode( QStringLiteral( "svg" ) )
static QgsSettingsTreeNode *	sTreeWms = treeRoot()->createChildNode( QStringLiteral( "wms" ) )

Detailed Description

QgsSettingsTree holds the tree structure for the settings in QGIS core.

See also

QgsSettingsEntryBase

Since

QGIS 3.30

Definition at line 30 of file qgssettingstree.h.

Member Function Documentation

createPluginTreeNode()

QgsSettingsTreeNode * QgsSettingsTree::createPluginTreeNode ( const QString &  pluginName )

static

Creates a settings tree node for the given pluginName.

Definition at line 25 of file qgssettingstree.cpp.

node()

static const QgsSettingsTreeNode * QgsSettingsTree::node ( const QString &  key )

inlinestatic

Returns the tree node at the given key.

Note

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

Definition at line 71 of file qgssettingstree.h.

treeRoot()

QgsSettingsTreeNode * QgsSettingsTree::treeRoot ( )

static

Returns the tree root node for the settings tree.

Definition at line 18 of file qgssettingstree.cpp.

unregisterPluginTreeNode()

void QgsSettingsTree::unregisterPluginTreeNode ( const QString &  pluginName )

static

Unregisters the tree node for the given plugin.

Definition at line 34 of file qgssettingstree.cpp.

Member Data Documentation

sTreeApp

QgsSettingsTreeNode* QgsSettingsTree::sTreeApp = treeRoot()->createChildNode( QStringLiteral( "app" ) )

inlinestatic

Definition at line 43 of file qgssettingstree.h.

sTreeConnections

QgsSettingsTreeNode* QgsSettingsTree::sTreeConnections = treeRoot()->createChildNode( QStringLiteral( "connections" ) )

inlinestatic

Definition at line 44 of file qgssettingstree.h.

sTreeCore

QgsSettingsTreeNode* QgsSettingsTree::sTreeCore = treeRoot()->createChildNode( QStringLiteral( "core" ) )

inlinestatic

Definition at line 45 of file qgssettingstree.h.

sTreeDigitizing

QgsSettingsTreeNode* QgsSettingsTree::sTreeDigitizing = treeRoot()->createChildNode( QStringLiteral( "digitizing" ) )

inlinestatic

Definition at line 46 of file qgssettingstree.h.

sTreeElevationProfile

QgsSettingsTreeNode* QgsSettingsTree::sTreeElevationProfile = treeRoot()->createChildNode( QStringLiteral( "elevation-profile" ) )

inlinestatic

Definition at line 47 of file qgssettingstree.h.

sTreeFonts

QgsSettingsTreeNode* QgsSettingsTree::sTreeFonts = treeRoot()->createChildNode( QStringLiteral( "fonts" ) )

inlinestatic

Definition at line 48 of file qgssettingstree.h.

sTreeGeometryValidation

QgsSettingsTreeNode* QgsSettingsTree::sTreeGeometryValidation = treeRoot()->createChildNode( QStringLiteral( "geometry_validation" ) )

inlinestatic

Definition at line 49 of file qgssettingstree.h.

sTreeGps

QgsSettingsTreeNode* QgsSettingsTree::sTreeGps = treeRoot()->createChildNode( QStringLiteral( "gps" ) )

inlinestatic

Definition at line 50 of file qgssettingstree.h.

sTreeGui

QgsSettingsTreeNode* QgsSettingsTree::sTreeGui = treeRoot()->createChildNode( QStringLiteral( "gui" ) )

inlinestatic

Definition at line 51 of file qgssettingstree.h.

sTreeLayerTree

QgsSettingsTreeNode* QgsSettingsTree::sTreeLayerTree = treeRoot()->createChildNode( QStringLiteral( "layer-tree" ) )

inlinestatic

Definition at line 52 of file qgssettingstree.h.

sTreeLayout

QgsSettingsTreeNode* QgsSettingsTree::sTreeLayout = treeRoot()->createChildNode( QStringLiteral( "layout" ) )

inlinestatic

Definition at line 53 of file qgssettingstree.h.

sTreeLocale

QgsSettingsTreeNode* QgsSettingsTree::sTreeLocale = treeRoot()->createChildNode( QStringLiteral( "locale" ) )

inlinestatic

Definition at line 54 of file qgssettingstree.h.

sTreeMap

QgsSettingsTreeNode* QgsSettingsTree::sTreeMap = treeRoot()->createChildNode( QStringLiteral( "map" ) )

inlinestatic

Definition at line 55 of file qgssettingstree.h.

sTreeNetwork

QgsSettingsTreeNode* QgsSettingsTree::sTreeNetwork = treeRoot()->createChildNode( QStringLiteral( "network" ) )

inlinestatic

Definition at line 56 of file qgssettingstree.h.

sTreePlugins

QgsSettingsTreeNode* QgsSettingsTree::sTreePlugins = treeRoot()->createChildNode( QStringLiteral( "plugins" ) )

inlinestatic

Definition at line 58 of file qgssettingstree.h.

sTreeProcessing

QgsSettingsTreeNode* QgsSettingsTree::sTreeProcessing = treeRoot()->createChildNode( QStringLiteral( "processing" ) )

inlinestatic

Definition at line 59 of file qgssettingstree.h.

sTreeQgis

QgsSettingsTreeNode* QgsSettingsTree::sTreeQgis = treeRoot()->createChildNode( QStringLiteral( "qgis" ) )

inlinestatic

Definition at line 57 of file qgssettingstree.h.

sTreeRaster

QgsSettingsTreeNode* QgsSettingsTree::sTreeRaster = treeRoot()->createChildNode( QStringLiteral( "raster" ) )

inlinestatic

Definition at line 60 of file qgssettingstree.h.

sTreeRendering

QgsSettingsTreeNode* QgsSettingsTree::sTreeRendering = treeRoot()->createChildNode( QStringLiteral( "rendering" ) )

inlinestatic

Definition at line 61 of file qgssettingstree.h.

sTreeSvg

QgsSettingsTreeNode* QgsSettingsTree::sTreeSvg = treeRoot()->createChildNode( QStringLiteral( "svg" ) )

inlinestatic

Definition at line 62 of file qgssettingstree.h.

sTreeWms

QgsSettingsTreeNode* QgsSettingsTree::sTreeWms = treeRoot()->createChildNode( QStringLiteral( "wms" ) )

inlinestatic

Definition at line 63 of file qgssettingstree.h.

---

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

• /build/qgis-3.30.0+99sid/src/core/settings/qgssettingstree.h
• /build/qgis-3.30.0+99sid/src/core/settings/qgssettingstree.cpp