17#include "moc_qgssettingstreenode.cpp"
34 const auto nodes = mChildrenNodes;
35 for (
const auto *node : nodes )
37 const auto settings = mChildrenSettings;
38 for (
const auto *setting : settings )
47 te->mCompleteKey = QStringLiteral(
"/" );
57 throw QgsSettingsException( QObject::tr(
"Settings tree node '%1' already holds a child setting with key '%2'." ).arg( this->
key(), key ) );
61 te->init(
this,
key );
74 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 ) );
77 throw QgsSettingsException( QObject::tr(
"Settings tree node '%1' already holds a child setting with key '%2'." ).arg( this->
key(), key ) );
81 te->init(
this,
key );
90 QList<QgsSettingsTreeNode *>::const_iterator it = mChildrenNodes.constBegin();
91 for ( ; it != mChildrenNodes.constEnd(); ++it )
93 if ( ( *it )->key() ==
key )
101 const QString testCompleteKey = QStringLiteral(
"%1%2" ).arg( mCompleteKey,
key );
102 QList<const QgsSettingsEntryBase *>::const_iterator it = mChildrenSettings.constBegin();
103 for ( ; it != mChildrenSettings.constEnd(); ++it )
105 if ( ( *it )->definitionKey() == testCompleteKey )
114 throw QgsSettingsException( QObject::tr(
"Settings tree node '%1' already holds a child tree node with key '%2'." ).arg( this->
key(), key ) );
116 throw QgsSettingsException( QObject::tr(
"Settings tree node '%1' already holds a child setting with key '%2'." ).arg( this->
key(), key ) );
118 mChildrenSettings.append( setting );
124 mChildrenNodes.append( node );
129 if ( deleteSettingValues )
130 setting->
remove( parentsNamedItems );
132 mChildrenSettings.removeAll( setting );
137 mChildrenNodes.removeAll( node );
144 mCompleteKey = QDir::cleanPath( QStringLiteral(
"%1/%2" ).arg(
parent->
completeKey(),
key ) ) +
'/';
147QgsSettingsTreeNamedListNode::QgsSettingsTreeNamedListNode() =
default;
155 mSelectedItemSetting = std::make_unique<QgsSettingsEntryString>( QStringLiteral(
"%1/selected" ).arg( mCompleteKey ),
nullptr );
158 mNamedNodesCount = mParent->namedNodesCount() + 1;
159 mItemsCompleteKey = QStringLiteral(
"%1items/" ).arg( mCompleteKey );
160 mCompleteKey.append( QStringLiteral(
"items/%%1/" ).arg( mNamedNodesCount ) );
177 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() ) ) );
180 const QString completeKeyParam = completeKeyWithNamedItems( mItemsCompleteKey, parentsNamedItems );
182 settings->beginGroup( completeKeyParam );
183 const QStringList res = settings->childGroups( origin );
184 settings->endGroup();
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 ) );
195 mSelectedItemSetting->setValue( item, parentsNamedItems );
201 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() ) ) );
203 throw QgsSettingsException( QObject::tr(
"The named list node '%1' has no option to set the current selected entry." ).arg( mCompleteKey ) );
205 return mSelectedItemSetting->value( parentsNamedItems );
211 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 QStringList args = parentsNamedItems;
215 QString
key = completeKeyWithNamedItems( mCompleteKey, args );
222 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() ) );
224 const QStringList children =
items( parentsNamedItems );
226 for (
const QString &child : children )
228 QStringList args = parentsNamedItems;
230 QString
key = completeKeyWithNamedItems( mCompleteKey, args );
231 settings->remove(
key );
235QString QgsSettingsTreeNamedListNode::completeKeyWithNamedItems(
const QString &key,
const QStringList &namedItems )
const
237 switch ( namedItems.count() )
242 return key.arg( namedItems[0] );
244 return key.arg( namedItems[0], namedItems[1] );
246 return key.arg( namedItems[0], namedItems[1], namedItems[2] );
248 return key.arg( namedItems[0], namedItems[1], namedItems[2], namedItems[3] );
250 return key.arg( namedItems[0], namedItems[1], namedItems[2], namedItems[3], namedItems[4] );
252 throw QgsSettingsException( QObject::tr(
"Current implementation of QgsSettingsTreeNamedListNode::items doesn't handle more than 5 parent named items" ) );
@ NamedList
Named List Node.
QFlags< SettingsTreeNodeOption > SettingsTreeNodeOptions
@ NamedListSelectedItemSetting
Creates a setting to store which is the current item.
SettingsOrigin
The setting origin describes where a setting is stored.
Represents a 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.
Custom exception class for settings related exceptions.
A named list tree node for the settings tree to help organizing and introspecting the tree.
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.
virtual ~QgsSettingsTreeNamedListNode()
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.
A tree node for the settings tree to help organizing and introspecting the tree.
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.
virtual ~QgsSettingsTreeNode()
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.