QGIS/python/core/auto_generated/settings/qgssettingstree.sip.in
2025-03-30 20:48:07 +10:00

60 lines
1.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/settings/qgssettingstree.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsSettingsTree
{
%Docstring(signature="appended")
Holds the tree structure for the settings in QGIS core.
.. seealso:: :py:class:`QgsSettingsEntryBase`
.. versionadded:: 3.30
%End
%TypeHeaderCode
#include "qgssettingstree.h"
%End
public:
static QgsSettingsTreeNode *treeRoot();
%Docstring
Returns the tree root node for the settings tree
%End
static const QgsSettingsTreeNode *node( const QString &key );
%Docstring
Returns the tree node at the given ``key``
.. note::
For Plugins, use :py:func:`~QgsSettingsTree.createPluginTreeNode` to create nodes for plugin settings.
%End
static QgsSettingsTreeNode *createPluginTreeNode( const QString &pluginName );
%Docstring
Creates a settings tree node for the given ``pluginName``
%End
static void unregisterPluginTreeNode( const QString &pluginName );
%Docstring
Unregisters the tree node for the given plugin
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/settings/qgssettingstree.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/