rename SettingsLocation to SettingsOrigin

qgis · Jan 16, 2023 · 87fd5e2 · 87fd5e2
1 parent b93967a
commit 87fd5e2
Show file tree

Hide file tree

Showing 14 changed files with 53 additions and 53 deletions.
diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -2215,12 +2215,12 @@
 # --
 Qgis.CoordinateDisplayType.baseClass = Qgis
 # monkey patching scoped based enum
-Qgis.SettingsLocation.Any.__doc__ = "From any location"
-Qgis.SettingsLocation.Global.__doc__ = "Global settings are stored in `global_settings.ini`"
-Qgis.SettingsLocation.Local.__doc__ = "Local settings are stored in the user profile"
-Qgis.SettingsLocation.__doc__ = 'The setting location describes where a setting is stored.\n\n.. versionadded:: 3.30\n\n' + '* ``Any``: ' + Qgis.SettingsLocation.Any.__doc__ + '\n' + '* ``Global``: ' + Qgis.SettingsLocation.Global.__doc__ + '\n' + '* ``Local``: ' + Qgis.SettingsLocation.Local.__doc__
+Qgis.SettingsOrigin.Any.__doc__ = "From any origin"
+Qgis.SettingsOrigin.Global.__doc__ = "Global settings are stored in `global_settings.ini`"
+Qgis.SettingsOrigin.Local.__doc__ = "Local settings are stored in the user profile"
+Qgis.SettingsOrigin.__doc__ = 'The setting origin describes where a setting is stored.\n\n.. versionadded:: 3.30\n\n' + '* ``Any``: ' + Qgis.SettingsOrigin.Any.__doc__ + '\n' + '* ``Global``: ' + Qgis.SettingsOrigin.Global.__doc__ + '\n' + '* ``Local``: ' + Qgis.SettingsOrigin.Local.__doc__
 # --
-Qgis.SettingsLocation.baseClass = Qgis
+Qgis.SettingsOrigin.baseClass = Qgis
 # monkey patching scoped based enum
 Qgis.ScriptLanguage.Css.__doc__ = "CSS"
 Qgis.ScriptLanguage.QgisExpression.__doc__ = "QGIS expressions"

diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -1465,7 +1465,7 @@ The development version
       CustomCrs,
     };
 
-    enum class SettingsLocation
+    enum class SettingsOrigin
     {
       Any,
       Global,

diff --git a/python/core/auto_generated/settings/qgssettings.sip.in b/python/core/auto_generated/settings/qgssettings.sip.in
@@ -191,7 +191,7 @@ Returns a list of all keys, including subkeys, that can be read using the QSetti
 %Docstring
 Returns a list of all top-level keys that can be read using the QSettings object.
 %End
-    QStringList childGroups( Qgis::SettingsLocation location = Qgis::SettingsLocation::Any ) const;
+    QStringList childGroups( Qgis::SettingsOrigin origin = Qgis::SettingsOrigin::Any ) const;
 %Docstring
 Returns a list of all key top-level groups that contain keys that can be read using the QSettings object.
 %End
@@ -232,13 +232,13 @@ Sets the current array index to i. Calls to functions such as :py:func:`~QgsSett
 :py:func:`~QgsSettings.remove`, and :py:func:`~QgsSettings.contains` will operate on the array entry at that index.
 %End
 
-    Qgis::SettingsLocation location( const QString &key ) const;
+    Qgis::SettingsOrigin origin( const QString &key ) const;
 %Docstring
-Returns the location of the setting if it exists at the given ``key``
+Returns the origin of the setting if it exists at the given ``key``
 
 .. note::
 
-   it will return Qgis.SettingsLocation.Any if the key doesn't exist
+   it will return Qgis.SettingsOrigin.Any if the key doesn't exist
 
 .. versionadded:: 3.30
 %End

diff --git a/python/core/auto_generated/settings/qgssettingsentry.sip.in b/python/core/auto_generated/settings/qgssettingsentry.sip.in
@@ -205,13 +205,13 @@ Returns ``True`` if the settings is contained in the underlying QSettings.
 The ``dynamicKeyParts`` argument specifies the list of dynamic parts of the settings key.
 %End
 
-    Qgis::SettingsLocation location( const QStringList &dynamicKeyPartList ) const;
+    Qgis::SettingsOrigin origin( const QStringList &dynamicKeyPartList ) const;
 %Docstring
-Returns the location of the setting if it exists
+Returns the origin of the setting if it exists
 
 .. note::
 
-   it will return Qgis.SettingsLocation.Any if the key doesn't exist
+   it will return Qgis.SettingsOrigin.Any if the key doesn't exist
 
 .. versionadded:: 3.30
 %End

diff --git a/python/core/auto_generated/settings/qgssettingstreeelement.sip.in b/python/core/auto_generated/settings/qgssettingstreeelement.sip.in
@@ -208,11 +208,11 @@ Returns the list of items
 :param parentsNamedItems: the list of named items in the parent named list (if any)
 %End
 
-    QStringList items( Qgis::SettingsLocation location, const QStringList &parentsNamedItems = QStringList() ) const throw( QgsSettingsException );
+    QStringList items( Qgis::SettingsOrigin origin, const QStringList &parentsNamedItems = QStringList() ) const throw( QgsSettingsException );
 %Docstring
 Returns the list of items
 
-:param location: can be used to restrict the origin of the setting (local or global)
+:param origin: can be used to restrict the origin of the setting (local or global)
 :param parentsNamedItems: the list of named items in the parent named list (if any)
 %End
 

diff --git a/src/core/qgis.h b/src/core/qgis.h
@@ -2528,17 +2528,17 @@ class CORE_EXPORT Qgis
     Q_ENUM( CoordinateDisplayType )
 
     /**
-     * The setting location describes where a setting is stored.
+     * The setting origin describes where a setting is stored.
      *
      * \since QGIS 3.30
      */
-    enum class SettingsLocation : int
+    enum class SettingsOrigin : int
     {
-      Any, //!< From any location
+      Any, //!< From any origin
       Global, //!< Global settings are stored in `global_settings.ini`
       Local, //!< Local settings are stored in the user profile
     };
-    Q_ENUM( SettingsLocation )
+    Q_ENUM( SettingsOrigin )
 
     /**
      * Scripting languages.

diff --git a/src/core/settings/qgssettings.cpp b/src/core/settings/qgssettings.cpp
@@ -157,11 +157,11 @@ QStringList QgsSettings::childKeys() const
   return keys;
 }
 
-QStringList QgsSettings::childGroups( Qgis::SettingsLocation location ) const
+QStringList QgsSettings::childGroups( Qgis::SettingsOrigin origin ) const
 {
-  switch ( location )
+  switch ( origin )
   {
-    case Qgis::SettingsLocation::Any:
+    case Qgis::SettingsOrigin::Any:
     {
       QStringList keys = mUserSettings->childGroups();
       if ( mGlobalSettings )
@@ -172,17 +172,17 @@ QStringList QgsSettings::childGroups( Qgis::SettingsLocation location ) const
       return keys;
     }
 
-    case Qgis::SettingsLocation::Local:
+    case Qgis::SettingsOrigin::Local:
       return mUserSettings->childGroups();
 
-    case Qgis::SettingsLocation::Global:
+    case Qgis::SettingsOrigin::Global:
       return  mGlobalSettings ? mGlobalSettings->childGroups() : QStringList();
   }
 
 }
 QStringList QgsSettings::globalChildGroups() const
 {
-  return childGroups( Qgis::SettingsLocation::Global );
+  return childGroups( Qgis::SettingsOrigin::Global );
 }
 
 QString QgsSettings::globalSettingsPath()
@@ -308,15 +308,15 @@ void QgsSettings::setArrayIndex( int i )
   }
 }
 
-Qgis::SettingsLocation QgsSettings::location( const QString &key ) const
+Qgis::SettingsOrigin QgsSettings::origin( const QString &key ) const
 {
   if ( mGlobalSettings && mGlobalSettings->contains( key ) )
-    return Qgis::SettingsLocation::Global;
+    return Qgis::SettingsOrigin::Global;
 
   if ( mUserSettings->contains( key ) )
-    return Qgis::SettingsLocation::Local;
+    return Qgis::SettingsOrigin::Local;
 
-  return Qgis::SettingsLocation::Any;
+  return Qgis::SettingsOrigin::Any;
 }
 
 void QgsSettings::setValue( const QString &key, const QVariant &value, const QgsSettings::Section section )

diff --git a/src/core/settings/qgssettings.h b/src/core/settings/qgssettings.h
@@ -240,7 +240,7 @@ class CORE_EXPORT QgsSettings : public QObject
     //! Returns a list of all top-level keys that can be read using the QSettings object.
     QStringList childKeys() const;
     //! Returns a list of all key top-level groups that contain keys that can be read using the QSettings object.
-    QStringList childGroups( Qgis::SettingsLocation location = Qgis::SettingsLocation::Any ) const;
+    QStringList childGroups( Qgis::SettingsOrigin origin = Qgis::SettingsOrigin::Any ) const;
     //! Returns a list of all key top-level groups (same as childGroups) but only for groups defined in global settings.
     QStringList globalChildGroups() const;
     //! Returns the path to the Global Settings QSettings storage file
@@ -266,11 +266,11 @@ class CORE_EXPORT QgsSettings : public QObject
     void setArrayIndex( int i );
 
     /**
-     * Returns the location of the setting if it exists at the given \a key
-     * \note it will return Qgis::SettingsLocation::Any if the key doesn't exist
+     * Returns the origin of the setting if it exists at the given \a key
+     * \note it will return Qgis::SettingsOrigin::Any if the key doesn't exist
      * \since QGIS 3.30
      */
-    Qgis::SettingsLocation location( const QString &key ) const;
+    Qgis::SettingsOrigin origin( const QString &key ) const;
 
     /**
      * Sets the value of setting key to value. If the key already exists, the previous value is overwritten.

diff --git a/src/core/settings/qgssettingsentry.cpp b/src/core/settings/qgssettingsentry.cpp
@@ -200,9 +200,9 @@ bool QgsSettingsEntryBase::exists( const QStringList &dynamicKeyPartList ) const
   return QgsSettings().contains( key( dynamicKeyPartList ) );
 }
 
-Qgis::SettingsLocation QgsSettingsEntryBase::location( const QStringList &dynamicKeyPartList ) const
+Qgis::SettingsOrigin QgsSettingsEntryBase::origin( const QStringList &dynamicKeyPartList ) const
 {
-  return QgsSettings().location( key( dynamicKeyPartList ) );
+  return QgsSettings().origin( key( dynamicKeyPartList ) );
 }
 
 void QgsSettingsEntryBase::remove( const QString &dynamicKeyPart ) const

diff --git a/src/core/settings/qgssettingsentry.h b/src/core/settings/qgssettingsentry.h
@@ -234,11 +234,11 @@ class CORE_EXPORT QgsSettingsEntryBase
     bool exists( const QStringList &dynamicKeyPartList ) const;
 
     /**
-     * Returns the location of the setting if it exists
-     * \note it will return Qgis::SettingsLocation::Any if the key doesn't exist
+     * Returns the origin of the setting if it exists
+     * \note it will return Qgis::SettingsOrigin::Any if the key doesn't exist
      * \since QGIS 3.30
      */
-    Qgis::SettingsLocation location( const QStringList &dynamicKeyPartList ) const;
+    Qgis::SettingsOrigin origin( const QStringList &dynamicKeyPartList ) const;
 
     /**
      * Removes the settings from the underlying QSettings.

diff --git a/src/core/settings/qgssettingstreeelement.cpp b/src/core/settings/qgssettingstreeelement.cpp
@@ -149,10 +149,10 @@ QgsSettingsTreeNamedListElement::~QgsSettingsTreeNamedListElement()
 
 QStringList QgsSettingsTreeNamedListElement::items( const QStringList &parentNamedItems ) const
 {
-  return items( Qgis::SettingsLocation::Any, parentNamedItems );
+  return items( Qgis::SettingsOrigin::Any, parentNamedItems );
 }
 
-QStringList QgsSettingsTreeNamedListElement::items( Qgis::SettingsLocation location, const QStringList &parentNamedItems ) const
+QStringList QgsSettingsTreeNamedListElement::items( Qgis::SettingsOrigin origin, const QStringList &parentNamedItems ) const
 {
   if ( namedElementsCount() - 1 != parentNamedItems.count() )
     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( parentNamedItems.count(),  namedElementsCount() ) );
@@ -161,7 +161,7 @@ QStringList QgsSettingsTreeNamedListElement::items( Qgis::SettingsLocation locat
   const QString completeKeyParam = completeKeyWithNamedItems( mItemsCompleteKey, parentNamedItems );
   QgsSettings settings;
   settings.beginGroup( completeKeyParam );
-  return settings.childGroups( location );
+  return settings.childGroups( origin );
 }
 
 void QgsSettingsTreeNamedListElement::setSelectedItem( const QString &item, const QStringList &parentsNamedItems )

diff --git a/src/core/settings/qgssettingstreeelement.h b/src/core/settings/qgssettingstreeelement.h
@@ -215,10 +215,10 @@ class CORE_EXPORT QgsSettingsTreeNamedListElement : public QgsSettingsTreeElemen
 
     /**
      *  Returns the list of items
-     * \param location can be used to restrict the origin of the setting (local or global)
+     * \param origin can be used to restrict the origin of the setting (local or global)
      * \param parentsNamedItems the list of named items in the parent named list (if any)
     */
-    QStringList items( Qgis::SettingsLocation location, const QStringList &parentsNamedItems = QStringList() ) const SIP_THROW( QgsSettingsException );
+    QStringList items( Qgis::SettingsOrigin origin, const QStringList &parentsNamedItems = QStringList() ) const SIP_THROW( QgsSettingsException );
 
 
     /**

diff --git a/src/providers/wms/qgsxyzconnection.cpp b/src/providers/wms/qgsxyzconnection.cpp
@@ -50,7 +50,7 @@ QStringList QgsXyzConnectionUtils::connectionList()
   QStringList list = QgsXyzConnectionSettings::sTreeXyzConnections->items();
   for ( const QString &connection : std::as_const( list ) )
   {
-    if ( QgsXyzConnectionSettings::settingsUrl->location( {connection} ) == Qgis::SettingsLocation::Global )
+    if ( QgsXyzConnectionSettings::settingsUrl->origin( {connection} ) == Qgis::SettingsOrigin::Global )
       if ( QgsXyzConnectionSettings::settingsHidden->value( connection ) )
         list.removeOne( connection );
   }
@@ -78,7 +78,7 @@ QgsXyzConnection QgsXyzConnectionUtils::connection( const QString &name )
 
 void QgsXyzConnectionUtils::deleteConnection( const QString &name )
 {
-  if ( QgsXyzConnectionSettings::settingsUrl->location( {name} ) == Qgis::SettingsLocation::Global )
+  if ( QgsXyzConnectionSettings::settingsUrl->origin( {name} ) == Qgis::SettingsOrigin::Global )
   {
     QgsXyzConnectionSettings::settingsHidden->setValue( true, name );
   }
@@ -100,7 +100,7 @@ void QgsXyzConnectionUtils::addConnection( const QgsXyzConnection &conn )
   QgsXyzConnectionSettings::settingsTilePixelRatio->setValue( conn.tilePixelRatio, conn.name );
   QgsXyzConnectionSettings::settingsInterpretation->setValue( conn.interpretation, conn.name );
 
-  if ( QgsXyzConnectionSettings::settingsUrl->location( {conn.name} ) == Qgis::SettingsLocation::Global )
+  if ( QgsXyzConnectionSettings::settingsUrl->origin( {conn.name} ) == Qgis::SettingsOrigin::Global )
     QgsXyzConnectionSettings::settingsHidden->setValue( false, conn.name );
 }
 
diff --git a/tests/src/python/test_qgssettings.py b/tests/src/python/test_qgssettings.py
@@ -222,8 +222,8 @@ def test_global_groups(self):
 
         self.settings.beginGroup('testqgissettings')
         self.assertEqual(sorted(['bar', 'foo']), sorted(self.settings.childGroups()))
-        self.assertEqual(['foo'], self.settings.childGroups(Qgis.SettingsLocation.Global))
-        self.assertEqual(['bar'], self.settings.childGroups(Qgis.SettingsLocation.Local))
+        self.assertEqual(['foo'], self.settings.childGroups(Qgis.SettingsOrigin.Global))
+        self.assertEqual(['bar'], self.settings.childGroups(Qgis.SettingsOrigin.Local))
         self.settings.endGroup()
 
         self.globalsettings.remove('testqgissettings/foo')
@@ -233,19 +233,19 @@ def test_global_groups(self):
         self.assertEqual([], self.settings.globalChildGroups())
         self.settings.endGroup()
 
-    def test_location(self):
+    def test_origin(self):
         self.assertEqual(self.settings.allKeys(), [])
         self.assertEqual(self.globalsettings.allKeys(), [])
 
         self.addToDefaults('testqgissettings/global/setting', 'qgis')
         self.settings.setValue('testqgissettings/local/setting', 'rocks')
 
-        self.assertEqual(self.settings.location('testqgissettings/global/setting'), Qgis.SettingsLocation.Global)
-        self.assertEqual(self.settings.location('testqgissettings/local/setting'), Qgis.SettingsLocation.Local)
-        self.assertEqual(self.settings.location('undefined-key'), Qgis.SettingsLocation.Any)
+        self.assertEqual(self.settings.origin('testqgissettings/global/setting'), Qgis.SettingsOrigin.Global)
+        self.assertEqual(self.settings.origin('testqgissettings/local/setting'), Qgis.SettingsOrigin.Local)
+        self.assertEqual(self.settings.origin('undefined-key'), Qgis.SettingsOrigin.Any)
 
         self.settings.setValue('testqgissettings/global/setting', 'rocks')
-        self.assertEqual(self.settings.location('testqgissettings/global/setting'), Qgis.SettingsLocation.Local)
+        self.assertEqual(self.settings.origin('testqgissettings/global/setting'), Qgis.SettingsOrigin.Local)
 
     def test_group_section(self):
         # Test group by using Section