QGIS API Documentation 3.39.0-Master (73c886ac97c)
Loading...
Searching...
No Matches
qgssettingstreenode.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgssettingstreenode.cpp
3 --------------------------------------
4 Date : December 2022
5 Copyright : (C) 2022 by Denis Rouzaud
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#include "qgssettingstreenode.h"
18#include "qgsexception.h"
19#include "qgssettings.h"
20#include "qgssettingsproxy.h"
21
22#include <QDir>
23
25{
27 mParent->unregisterChildNode( this );
28
29 qDeleteAll( mChildrenNodes );
30 qDeleteAll( mChildrenSettings );
31}
32
34{
37 te->mKey = QString();
38 te->mCompleteKey = QStringLiteral( "/" );
39 return te;
40}
41
43{
45 if ( te )
46 return te;
47 if ( childSetting( key ) )
48 throw QgsSettingsException( QObject::tr( "Settings tree node '%1' already holds a child setting with key '%2'." ).arg( this->key(), key ) );
49
50 te = new QgsSettingsTreeNode();
52 te->init( this, key );
54 return te;
55}
56
58{
60 if ( nte )
61 {
63 return dynamic_cast<QgsSettingsTreeNamedListNode *>( nte );
64 else
65 throw QgsSettingsException( QObject::tr( "Settings tree node '%1' already holds a child node with key '%2', but it is not a named list.." ).arg( this->key(), key ) );
66 }
67 if ( childSetting( key ) )
68 throw QgsSettingsException( QObject::tr( "Settings tree node '%1' already holds a child setting with key '%2'." ).arg( this->key(), key ) );
69
72 te->init( this, key );
73 te->initNamedList( options );
75 return te;
76}
77
78
80{
81 QList<QgsSettingsTreeNode *>::const_iterator it = mChildrenNodes.constBegin();
82 for ( ; it != mChildrenNodes.constEnd(); ++it )
83 {
84 if ( ( *it )->key() == key )
85 return *it;
86 }
87 return nullptr;
88}
89
91{
92 const QString testCompleteKey = QStringLiteral( "%1%2" ).arg( mCompleteKey, key );
93 QList<const QgsSettingsEntryBase *>::const_iterator it = mChildrenSettings.constBegin();
94 for ( ; it != mChildrenSettings.constEnd(); ++it )
95 {
96 if ( ( *it )->definitionKey() == testCompleteKey )
97 return *it;
98 }
99 return nullptr;
100}
101
102void QgsSettingsTreeNode::registerChildSetting( const QgsSettingsEntryBase *setting, const QString &key )
103{
104 if ( childNode( key ) )
105 throw QgsSettingsException( QObject::tr( "Settings tree node '%1' already holds a child tree node with key '%2'." ).arg( this->key(), key ) );
106 if ( childSetting( key ) )
107 throw QgsSettingsException( QObject::tr( "Settings tree node '%1' already holds a child setting with key '%2'." ).arg( this->key(), key ) );
108
109 mChildrenSettings.append( setting );
110}
111
112
114{
115 mChildrenNodes.append( node );
116}
117
118void QgsSettingsTreeNode::unregisterChildSetting( const QgsSettingsEntryBase *setting, bool deleteSettingValues, const QStringList &parentsNamedItems )
119{
120 if ( deleteSettingValues )
121 setting->remove( parentsNamedItems );
122
123 mChildrenSettings.removeAll( setting );
124}
125
127{
128 mChildrenNodes.removeAll( node );
129}
130
131void QgsSettingsTreeNode::init( QgsSettingsTreeNode *parent, const QString &key )
132{
133 mParent = parent;
134 mKey = key;
135 mCompleteKey = QDir::cleanPath( QStringLiteral( "%1/%2" ).arg( parent->completeKey(), key ) ) + '/';
136}
137
138
140{
141 mOptions = options;
143 {
144 // this must be done before completing the key
145 mSelectedItemSetting = new QgsSettingsEntryString( QStringLiteral( "%1/selected" ).arg( mCompleteKey ), nullptr );
146 }
147
148 mNamedNodesCount = mParent->namedNodesCount() + 1;
149 mItemsCompleteKey = QStringLiteral( "%1items/" ).arg( mCompleteKey );
150 mCompleteKey.append( QStringLiteral( "items/%%1/" ).arg( mNamedNodesCount ) );
151}
152
154{
155 delete mSelectedItemSetting;
156}
157
158
159QStringList QgsSettingsTreeNamedListNode::items( const QStringList &parentsNamedItems ) const
160{
161 return items( Qgis::SettingsOrigin::Any, parentsNamedItems );
162}
163
164QStringList QgsSettingsTreeNamedListNode::items( Qgis::SettingsOrigin origin, const QStringList &parentsNamedItems ) const
165{
166 if ( namedNodesCount() - 1 != parentsNamedItems.count() )
167 throw QgsSettingsException( QObject::tr( "The number of given parent named items (%1) for the node '%2' doesn't match with the number of named items in the key (%3)." ).arg( QString::number( parentsNamedItems.count() ), mCompleteKey, QString::number( namedNodesCount() ) ) );
168
169
170 const QString completeKeyParam = completeKeyWithNamedItems( mItemsCompleteKey, parentsNamedItems );
171 auto settings = QgsSettings::get();
172 settings->beginGroup( completeKeyParam );
173 const QStringList res = settings->childGroups( origin );
174 settings->endGroup();
175 return res;
176}
177
178void QgsSettingsTreeNamedListNode::setSelectedItem( const QString &item, const QStringList &parentsNamedItems )
179{
180 if ( namedNodesCount() - 1 != parentsNamedItems.count() )
181 throw QgsSettingsException( QObject::tr( "The number of given parent named items (%1) for the node '%2' doesn't match with the number of named items in the key (%3)." ).arg( QString::number( parentsNamedItems.count() ), mCompleteKey, QString::number( namedNodesCount() ) ) );
183 throw QgsSettingsException( QObject::tr( "The named list node '%1' has no option to set the current selected entry." ).arg( mCompleteKey ) );
184
185 mSelectedItemSetting->setValue( item, parentsNamedItems );
186}
187
188QString QgsSettingsTreeNamedListNode::selectedItem( const QStringList &parentsNamedItems )
189{
190 if ( namedNodesCount() - 1 != parentsNamedItems.count() )
191 throw QgsSettingsException( QObject::tr( "The number of given parent named items (%1) for the node '%2' doesn't match with the number of named items in the key (%3)." ).arg( QString::number( parentsNamedItems.count() ), mCompleteKey, QString::number( namedNodesCount() ) ) );
193 throw QgsSettingsException( QObject::tr( "The named list node '%1' has no option to set the current selected entry." ).arg( mCompleteKey ) );
194
195 return mSelectedItemSetting->value( parentsNamedItems );
196}
197
198void QgsSettingsTreeNamedListNode::deleteItem( const QString &item, const QStringList &parentsNamedItems )
199{
200 if ( namedNodesCount() - 1 != parentsNamedItems.count() )
201 throw QgsSettingsException( QObject::tr( "The number of given parent named items (%1) doesn't match with the number of named items in the key (%2)." ).arg( parentsNamedItems.count(), namedNodesCount() ) );
202
203 QStringList args = parentsNamedItems;
204 args << item;
205 QString key = completeKeyWithNamedItems( mCompleteKey, args );
207}
208
209void QgsSettingsTreeNamedListNode::deleteAllItems( const QStringList &parentsNamedItems )
210{
211 if ( namedNodesCount() - 1 != parentsNamedItems.count() )
212 throw QgsSettingsException( QObject::tr( "The number of given parent named items (%1) doesn't match with the number of named items in the key (%2)." ).arg( parentsNamedItems.count(), namedNodesCount() ) );
213
214 const QStringList children = items( parentsNamedItems );
215 auto settings = QgsSettings::get();
216 for ( const QString &child : children )
217 {
218 QStringList args = parentsNamedItems;
219 args << child;
220 QString key = completeKeyWithNamedItems( mCompleteKey, args );
221 settings->remove( key );
222 }
223}
224
225QString QgsSettingsTreeNamedListNode::completeKeyWithNamedItems( const QString &key, const QStringList &namedItems ) const
226{
227 switch ( namedItems.count() )
228 {
229 case 0:
230 return key;
231 case 1:
232 return key.arg( namedItems[0] );
233 case 2:
234 return key.arg( namedItems[0], namedItems[1] );
235 case 3:
236 return key.arg( namedItems[0], namedItems[1], namedItems[2] );
237 case 4:
238 return key.arg( namedItems[0], namedItems[1], namedItems[2], namedItems[3] );
239 case 5:
240 return key.arg( namedItems[0], namedItems[1], namedItems[2], namedItems[3], namedItems[4] );
241 default:
242 throw QgsSettingsException( QObject::tr( "Current implementation of QgsSettingsTreeNamedListNode::items doesn't handle more than 5 parent named items" ) );
243 break;
244 }
245}
QFlags< SettingsTreeNodeOption > SettingsTreeNodeOptions
Definition qgis.h:481
@ NamedListSelectedItemSetting
Creates a setting to store which is the current item.
SettingsOrigin
The setting origin describes where a setting is stored.
Definition qgis.h:3875
@ Any
From any origin.
T value(const QString &dynamicKeyPart=QString()) const
Returns settings value.
bool setValue(const T &value, const QString &dynamicKeyPart=QString()) const
Set settings value.
Represent settings entry and provides methods for reading and writing settings values.
void remove(const QString &dynamicKeyPart=QString()) const
Removes the settings from the underlying QSettings.
A string settings entry.
Custom exception class for settings related exceptions.
QgsSettingsTreeNamedListNode is a named list tree node for the settings tree to help organizing and i...
void deleteAllItems(const QStringList &parentsNamedItems=QStringList())
Deletes all items from the named list node.
void deleteItem(const QString &item, const QStringList &parentsNamedItems=QStringList())
Deletes a named item from the named list node.
void initNamedList(const Qgis::SettingsTreeNodeOptions &options)
Init the nodes with the specific options.
QString selectedItem(const QStringList &parentsNamedItems=QStringList())
Returns the selected named item from the named list node.
void setSelectedItem(const QString &item, const QStringList &parentsNamedItems=QStringList())
Sets the selected named item from the named list node.
QStringList items(const QStringList &parentsNamedItems=QStringList()) const
Returns the list of items.
QgsSettingsTreeNode is a tree node for the settings tree to help organizing and introspecting the tre...
void registerChildNode(QgsSettingsTreeNode *node)
Registers a child nodes.
Qgis::SettingsTreeNodeType type() const
Returns the type of node.
QgsSettingsTreeNode * createChildNode(const QString &key)
Creates a normal tree node It will return the existing child node if it exists at the given key.
Qgis::SettingsTreeNodeType mType
QgsSettingsTreeNode * childNode(const QString &key) const
Returns the existing child node if it exists at the given key.
QString completeKey() const
Returns the complete key of the node (including its parents)
int namedNodesCount() const
Returns the number of named nodes in the complete key.
static QgsSettingsTreeNode * createRootNode()
Creates a tree root node.
QString key() const
Returns the key of the node (without its parents)
friend class QgsSettingsTreeNamedListNode
void unregisterChildSetting(const QgsSettingsEntryBase *setting, bool deleteSettingValues=false, const QStringList &parentsNamedItems=QStringList())
Unregisters the child setting.
QgsSettingsTreeNode * parent() const
Returns the parent of the node or nullptr if it does not exists.
void unregisterChildNode(QgsSettingsTreeNode *node)
Unregisters the child tree node.
void registerChildSetting(const QgsSettingsEntryBase *setting, const QString &key)
Registers a child setting.
const QgsSettingsEntryBase * childSetting(const QString &key) const
Returns the existing child settings if it exists at the given key.
QgsSettingsTreeNamedListNode * createNamedListNode(const QString &key, const Qgis::SettingsTreeNodeOptions &options=Qgis::SettingsTreeNodeOptions())
Creates a named list tree node.
void remove(const QString &key, QgsSettings::Section section=QgsSettings::NoSection)
Removes the setting key and any sub-settings of key in a section.
static QgsSettingsProxy get()
Returns a proxy for a QgsSettings object.