QGIS API Documentation 4.1.0-Master (64dc32379c2)
Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes | List of all members
QgsSettingsTree Class Reference
core library

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.
static const QgsSettingsTreeNode * node (const QString &key)
 Returns the tree node at the given key.
static QgsSettingsTreeNode * treeRoot ()
 Returns the tree root node for the settings tree.
static void unregisterPluginTreeNode (const QString &pluginName)
 Unregisters the tree node for the given plugin.

Static Public Attributes

static QgsSettingsTreeNode * sTree3DMap = treeRoot()->createChildNode( u"3dmap"_s )
static QgsSettingsTreeNode * sTreeAnnotations = treeRoot()->createChildNode( u"annotations"_s )
static QgsSettingsTreeNode * sTreeApp = treeRoot()->createChildNode( u"app"_s )
static QgsSettingsTreeNode * sTreeAttributeForm = treeRoot()->createChildNode( u"attribute-form"_s )
static QgsSettingsTreeNode * sTreeAttributeTable = treeRoot()->createChildNode( u"attribute-table"_s )
static QgsSettingsTreeNode * sTreeAuthentication = treeRoot()->createChildNode( u"authentication"_s )
static QgsSettingsTreeNode * sTreeBrowser = treeRoot()->createChildNode( u"browser"_s )
static QgsSettingsTreeNode * sTreeCad = sTreeDigitizing->createChildNode( u"cad"_s )
static QgsSettingsTreeNode * sTreeColors = treeRoot()->createChildNode( u"colors"_s )
static QgsSettingsTreeNode * sTreeColorWidgets = treeRoot()->createChildNode( u"color-widgets"_s )
static QgsSettingsTreeNode * sTreeConnections = treeRoot()->createChildNode( u"connections"_s )
static QgsSettingsTreeNode * sTreeCore = treeRoot()->createChildNode( u"core"_s )
static QgsSettingsTreeNode * sTreeCrs = treeRoot()->createChildNode( u"crs"_s )
static QgsSettingsTreeNode * sTreeDatabase = treeRoot()->createChildNode( u"database"_s )
static QgsSettingsTreeNode * sTreeDigitizing = treeRoot()->createChildNode( u"digitizing"_s )
static QgsSettingsTreeNode * sTreeElevationProfile = treeRoot()->createChildNode( u"elevation-profile"_s )
static QgsSettingsTreeNode * sTreeFonts = treeRoot()->createChildNode( u"fonts"_s )
static QgsSettingsTreeNode * sTreeGdal = treeRoot()->createChildNode( u"gdal"_s )
static QgsSettingsTreeNode * sTreeGeometryValidation = treeRoot()->createChildNode( u"geometry_validation"_s )
static QgsSettingsTreeNode * sTreeGps = treeRoot()->createChildNode( u"gps"_s )
static QgsSettingsTreeNode * sTreeGradientEditor = treeRoot()->createChildNode( u"gradient-editor"_s )
static QgsSettingsTreeNode * sTreeGui = treeRoot()->createChildNode( u"gui"_s )
static QgsSettingsTreeNode * sTreeHistogram = treeRoot()->createChildNode( u"histogram"_s )
static QgsSettingsTreeNode * sTreeIdentify = treeRoot()->createChildNode( u"identify"_s )
static QgsSettingsTreeNode * sTreeLayerTree = treeRoot()->createChildNode( u"layer-tree"_s )
static QgsSettingsTreeNode * sTreeLayout = treeRoot()->createChildNode( u"layout"_s )
static QgsSettingsTreeNode * sTreeLayoutGrid = sTreeLayout->createChildNode( u"grid"_s )
static QgsSettingsTreeNode * sTreeLocale = treeRoot()->createChildNode( u"locale"_s )
static QgsSettingsTreeNode * sTreeMap = treeRoot()->createChildNode( u"map"_s )
static QgsSettingsTreeNode * sTreeMeasure = treeRoot()->createChildNode( u"measure"_s )
static QgsSettingsTreeNode * sTreeNetwork = treeRoot()->createChildNode( u"network"_s )
static QgsSettingsTreeNode * sTreeNetworkCache = treeRoot()->createChildNode( u"cache"_s )
static QgsSettingsTreeNode * sTreePlugins = treeRoot()->createChildNode( u"plugins"_s )
static QgsSettingsTreeNode * sTreeProcessing = treeRoot()->createChildNode( u"processing"_s )
static QgsSettingsTreeNode * sTreeProfile = treeRoot()->createChildNode( u"profile"_s )
static QgsSettingsTreeNode * sTreeProject = treeRoot()->createChildNode( u"project"_s )
static QgsSettingsTreeNode * sTreeProxy = treeRoot()->createChildNode( u"proxy"_s )
static QgsSettingsTreeNode * sTreeQgis = treeRoot()->createChildNode( u"qgis"_s )
static QgsSettingsTreeNode * sTreeRaster = treeRoot()->createChildNode( u"raster"_s )
static QgsSettingsTreeNode * sTreeRasterHistogram = sTreeRaster->createChildNode( u"histogram"_s )
static QgsSettingsTreeNode * sTreeRendering = treeRoot()->createChildNode( u"rendering"_s )
static QgsSettingsTreeNode * sTreeSqlite3 = sTreeDatabase->createChildNode( u"sqlite3"_s )
static QgsSettingsTreeNode * sTreeSvg = treeRoot()->createChildNode( u"svg"_s )
static QgsSettingsTreeNode * sTreeWindowState = sTreeGui->createChildNode( u"window-state"_s )
static QgsSettingsTreeNode * sTreeWms = treeRoot()->createChildNode( u"wms"_s )

Detailed Description

Holds the tree structure for the settings in QGIS core.

See also
QgsSettingsEntryBase
Since
QGIS 3.30

Definition at line 34 of file qgssettingstree.h.

Member Function Documentation

◆ createPluginTreeNode()

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

Creates a settings tree node for the given pluginName.

Note
Since QGIS 4.2 for Python plugins, the node is created automatically by QGIS when the plugin is started and is exposed as the QGIS_PLUGIN_SETTINGS_NODE attribute on the plugin package. Plugin authors should retrieve it with from <my_plugin> import SETTINGS_NODE rather than calling this method directly.

Definition at line 25 of file qgssettingstree.cpp.

◆ node()

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 97 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.

Note
Since QGIS 4.2 for Python plugins, the node is unregistered automatically by QGIS when the plugin is unloaded; plugins do not need to call this method themselves.

Definition at line 34 of file qgssettingstree.cpp.

Member Data Documentation

◆ sTree3DMap

QgsSettingsTreeNode* QgsSettingsTree::sTree3DMap = treeRoot()->createChildNode( u"3dmap"_s )
inlinestatic

Definition at line 85 of file qgssettingstree.h.

◆ sTreeAnnotations

QgsSettingsTreeNode* QgsSettingsTree::sTreeAnnotations = treeRoot()->createChildNode( u"annotations"_s )
inlinestatic

Definition at line 79 of file qgssettingstree.h.

◆ sTreeApp

QgsSettingsTreeNode* QgsSettingsTree::sTreeApp = treeRoot()->createChildNode( u"app"_s )
inlinestatic

Definition at line 45 of file qgssettingstree.h.

◆ sTreeAttributeForm

QgsSettingsTreeNode* QgsSettingsTree::sTreeAttributeForm = treeRoot()->createChildNode( u"attribute-form"_s )
inlinestatic

Definition at line 46 of file qgssettingstree.h.

◆ sTreeAttributeTable

QgsSettingsTreeNode* QgsSettingsTree::sTreeAttributeTable = treeRoot()->createChildNode( u"attribute-table"_s )
inlinestatic

Definition at line 81 of file qgssettingstree.h.

◆ sTreeAuthentication

QgsSettingsTreeNode* QgsSettingsTree::sTreeAuthentication = treeRoot()->createChildNode( u"authentication"_s )
inlinestatic

Definition at line 83 of file qgssettingstree.h.

◆ sTreeBrowser

QgsSettingsTreeNode* QgsSettingsTree::sTreeBrowser = treeRoot()->createChildNode( u"browser"_s )
inlinestatic

Definition at line 47 of file qgssettingstree.h.

◆ sTreeCad

QgsSettingsTreeNode* QgsSettingsTree::sTreeCad = sTreeDigitizing->createChildNode( u"cad"_s )
inlinestatic

Definition at line 87 of file qgssettingstree.h.

◆ sTreeColors

QgsSettingsTreeNode* QgsSettingsTree::sTreeColors = treeRoot()->createChildNode( u"colors"_s )
inlinestatic

Definition at line 48 of file qgssettingstree.h.

◆ sTreeColorWidgets

QgsSettingsTreeNode* QgsSettingsTree::sTreeColorWidgets = treeRoot()->createChildNode( u"color-widgets"_s )
inlinestatic

Definition at line 49 of file qgssettingstree.h.

◆ sTreeConnections

QgsSettingsTreeNode* QgsSettingsTree::sTreeConnections = treeRoot()->createChildNode( u"connections"_s )
inlinestatic

Definition at line 50 of file qgssettingstree.h.

◆ sTreeCore

QgsSettingsTreeNode* QgsSettingsTree::sTreeCore = treeRoot()->createChildNode( u"core"_s )
inlinestatic

Definition at line 51 of file qgssettingstree.h.

◆ sTreeCrs

QgsSettingsTreeNode* QgsSettingsTree::sTreeCrs = treeRoot()->createChildNode( u"crs"_s )
inlinestatic

Definition at line 52 of file qgssettingstree.h.

◆ sTreeDatabase

QgsSettingsTreeNode* QgsSettingsTree::sTreeDatabase = treeRoot()->createChildNode( u"database"_s )
inlinestatic

Definition at line 84 of file qgssettingstree.h.

◆ sTreeDigitizing

QgsSettingsTreeNode* QgsSettingsTree::sTreeDigitizing = treeRoot()->createChildNode( u"digitizing"_s )
inlinestatic

Definition at line 53 of file qgssettingstree.h.

◆ sTreeElevationProfile

QgsSettingsTreeNode* QgsSettingsTree::sTreeElevationProfile = treeRoot()->createChildNode( u"elevation-profile"_s )
inlinestatic

Definition at line 54 of file qgssettingstree.h.

◆ sTreeFonts

QgsSettingsTreeNode* QgsSettingsTree::sTreeFonts = treeRoot()->createChildNode( u"fonts"_s )
inlinestatic

Definition at line 55 of file qgssettingstree.h.

◆ sTreeGdal

QgsSettingsTreeNode* QgsSettingsTree::sTreeGdal = treeRoot()->createChildNode( u"gdal"_s )
inlinestatic

Definition at line 56 of file qgssettingstree.h.

◆ sTreeGeometryValidation

QgsSettingsTreeNode* QgsSettingsTree::sTreeGeometryValidation = treeRoot()->createChildNode( u"geometry_validation"_s )
inlinestatic

Definition at line 57 of file qgssettingstree.h.

◆ sTreeGps

QgsSettingsTreeNode* QgsSettingsTree::sTreeGps = treeRoot()->createChildNode( u"gps"_s )
inlinestatic

Definition at line 58 of file qgssettingstree.h.

◆ sTreeGradientEditor

QgsSettingsTreeNode* QgsSettingsTree::sTreeGradientEditor = treeRoot()->createChildNode( u"gradient-editor"_s )
inlinestatic

Definition at line 59 of file qgssettingstree.h.

◆ sTreeGui

QgsSettingsTreeNode* QgsSettingsTree::sTreeGui = treeRoot()->createChildNode( u"gui"_s )
inlinestatic

Definition at line 60 of file qgssettingstree.h.

◆ sTreeHistogram

QgsSettingsTreeNode* QgsSettingsTree::sTreeHistogram = treeRoot()->createChildNode( u"histogram"_s )
inlinestatic

Definition at line 61 of file qgssettingstree.h.

◆ sTreeIdentify

QgsSettingsTreeNode* QgsSettingsTree::sTreeIdentify = treeRoot()->createChildNode( u"identify"_s )
inlinestatic

Definition at line 62 of file qgssettingstree.h.

◆ sTreeLayerTree

QgsSettingsTreeNode* QgsSettingsTree::sTreeLayerTree = treeRoot()->createChildNode( u"layer-tree"_s )
inlinestatic

Definition at line 63 of file qgssettingstree.h.

◆ sTreeLayout

QgsSettingsTreeNode* QgsSettingsTree::sTreeLayout = treeRoot()->createChildNode( u"layout"_s )
inlinestatic

Definition at line 64 of file qgssettingstree.h.

◆ sTreeLayoutGrid

QgsSettingsTreeNode* QgsSettingsTree::sTreeLayoutGrid = sTreeLayout->createChildNode( u"grid"_s )
inlinestatic

Definition at line 89 of file qgssettingstree.h.

◆ sTreeLocale

QgsSettingsTreeNode* QgsSettingsTree::sTreeLocale = treeRoot()->createChildNode( u"locale"_s )
inlinestatic

Definition at line 65 of file qgssettingstree.h.

◆ sTreeMap

QgsSettingsTreeNode* QgsSettingsTree::sTreeMap = treeRoot()->createChildNode( u"map"_s )
inlinestatic

Definition at line 66 of file qgssettingstree.h.

◆ sTreeMeasure

QgsSettingsTreeNode* QgsSettingsTree::sTreeMeasure = treeRoot()->createChildNode( u"measure"_s )
inlinestatic

Definition at line 78 of file qgssettingstree.h.

◆ sTreeNetwork

QgsSettingsTreeNode* QgsSettingsTree::sTreeNetwork = treeRoot()->createChildNode( u"network"_s )
inlinestatic

Definition at line 67 of file qgssettingstree.h.

◆ sTreeNetworkCache

QgsSettingsTreeNode* QgsSettingsTree::sTreeNetworkCache = treeRoot()->createChildNode( u"cache"_s )
inlinestatic

Definition at line 80 of file qgssettingstree.h.

◆ sTreePlugins

QgsSettingsTreeNode* QgsSettingsTree::sTreePlugins = treeRoot()->createChildNode( u"plugins"_s )
inlinestatic

Definition at line 69 of file qgssettingstree.h.

◆ sTreeProcessing

QgsSettingsTreeNode* QgsSettingsTree::sTreeProcessing = treeRoot()->createChildNode( u"processing"_s )
inlinestatic

Definition at line 70 of file qgssettingstree.h.

◆ sTreeProfile

QgsSettingsTreeNode* QgsSettingsTree::sTreeProfile = treeRoot()->createChildNode( u"profile"_s )
inlinestatic

Definition at line 71 of file qgssettingstree.h.

◆ sTreeProject

QgsSettingsTreeNode* QgsSettingsTree::sTreeProject = treeRoot()->createChildNode( u"project"_s )
inlinestatic

Definition at line 72 of file qgssettingstree.h.

◆ sTreeProxy

QgsSettingsTreeNode* QgsSettingsTree::sTreeProxy = treeRoot()->createChildNode( u"proxy"_s )
inlinestatic

Definition at line 73 of file qgssettingstree.h.

◆ sTreeQgis

QgsSettingsTreeNode* QgsSettingsTree::sTreeQgis = treeRoot()->createChildNode( u"qgis"_s )
inlinestatic

Definition at line 68 of file qgssettingstree.h.

◆ sTreeRaster

QgsSettingsTreeNode* QgsSettingsTree::sTreeRaster = treeRoot()->createChildNode( u"raster"_s )
inlinestatic

Definition at line 74 of file qgssettingstree.h.

◆ sTreeRasterHistogram

QgsSettingsTreeNode* QgsSettingsTree::sTreeRasterHistogram = sTreeRaster->createChildNode( u"histogram"_s )
inlinestatic

Definition at line 86 of file qgssettingstree.h.

◆ sTreeRendering

QgsSettingsTreeNode* QgsSettingsTree::sTreeRendering = treeRoot()->createChildNode( u"rendering"_s )
inlinestatic

Definition at line 75 of file qgssettingstree.h.

◆ sTreeSqlite3

QgsSettingsTreeNode* QgsSettingsTree::sTreeSqlite3 = sTreeDatabase->createChildNode( u"sqlite3"_s )
inlinestatic

Definition at line 88 of file qgssettingstree.h.

◆ sTreeSvg

QgsSettingsTreeNode* QgsSettingsTree::sTreeSvg = treeRoot()->createChildNode( u"svg"_s )
inlinestatic

Definition at line 76 of file qgssettingstree.h.

◆ sTreeWindowState

QgsSettingsTreeNode* QgsSettingsTree::sTreeWindowState = sTreeGui->createChildNode( u"window-state"_s )
inlinestatic

Definition at line 82 of file qgssettingstree.h.

◆ sTreeWms

QgsSettingsTreeNode* QgsSettingsTree::sTreeWms = treeRoot()->createChildNode( u"wms"_s )
inlinestatic

Definition at line 77 of file qgssettingstree.h.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0