Promote more Qgis enums to enum classes, add Q_ENUM

python/core/auto_additions/qgis.py

@@ -49,6 +49,19 @@
 Qgis.DataType.__doc__ = 'Raster data types.\nThis is modified and extended copy of GDALDataType.\n\n' + '* ``UnknownDataType``: ' + Qgis.DataType.UnknownDataType.__doc__ + '\n' + '* ``Byte``: ' + Qgis.DataType.Byte.__doc__ + '\n' + '* ``UInt16``: ' + Qgis.DataType.UInt16.__doc__ + '\n' + '* ``Int16``: ' + Qgis.DataType.Int16.__doc__ + '\n' + '* ``UInt32``: ' + Qgis.DataType.UInt32.__doc__ + '\n' + '* ``Int32``: ' + Qgis.DataType.Int32.__doc__ + '\n' + '* ``Float32``: ' + Qgis.DataType.Float32.__doc__ + '\n' + '* ``Float64``: ' + Qgis.DataType.Float64.__doc__ + '\n' + '* ``CInt16``: ' + Qgis.DataType.CInt16.__doc__ + '\n' + '* ``CInt32``: ' + Qgis.DataType.CInt32.__doc__ + '\n' + '* ``CFloat32``: ' + Qgis.DataType.CFloat32.__doc__ + '\n' + '* ``CFloat64``: ' + Qgis.DataType.CFloat64.__doc__ + '\n' + '* ``ARGB32``: ' + Qgis.DataType.ARGB32.__doc__ + '\n' + '* ``ARGB32_Premultiplied``: ' + Qgis.DataType.ARGB32_Premultiplied.__doc__
 # --
 Qgis.DataType.baseClass = Qgis
+# monkey patching scoped based enum
+Qgis.Never = Qgis.PythonMacroMode.Never
+Qgis.Never.__doc__ = "Macros are never run"
+Qgis.Ask = Qgis.PythonMacroMode.Ask
+Qgis.Ask.__doc__ = "User is prompt before running"
+Qgis.SessionOnly = Qgis.PythonMacroMode.SessionOnly
+Qgis.SessionOnly.__doc__ = "Only during this session"
+Qgis.Always = Qgis.PythonMacroMode.Always
+Qgis.Always.__doc__ = "Macros are always run"
+Qgis.NotForThisSession = Qgis.PythonMacroMode.NotForThisSession
+Qgis.NotForThisSession.__doc__ = "Macros will not be run for this session"
+Qgis.PythonMacroMode.__doc__ = 'Authorisation to run Python Macros\n\n.. versionadded:: 3.10\n\n' + '* ``Never``: ' + Qgis.PythonMacroMode.Never.__doc__ + '\n' + '* ``Ask``: ' + Qgis.PythonMacroMode.Ask.__doc__ + '\n' + '* ``SessionOnly``: ' + Qgis.PythonMacroMode.SessionOnly.__doc__ + '\n' + '* ``Always``: ' + Qgis.PythonMacroMode.Always.__doc__ + '\n' + '* ``NotForThisSession``: ' + Qgis.PythonMacroMode.NotForThisSession.__doc__
+# --
 Qgis.PythonMacroMode.baseClass = Qgis
 QgsVectorDataProvider.FeatureCountState = Qgis.FeatureCountState
 # monkey patching scoped based enum
@@ -58,6 +71,7 @@
 QgsVectorDataProvider.UnknownCount.__doc__ = "Provider returned an unknown feature count"
 Qgis.FeatureCountState.__doc__ = 'Enumeration of feature count states\n\n.. versionadded:: 3.20\n\n' + '* ``Uncounted``: ' + Qgis.FeatureCountState.Uncounted.__doc__ + '\n' + '* ``UnknownCount``: ' + Qgis.FeatureCountState.UnknownCount.__doc__
 # --
+Qgis.FeatureCountState.baseClass = Qgis
 QgsSymbol.SymbolType = Qgis.SymbolType
 # monkey patching scoped based enum
 QgsSymbol.Marker = Qgis.SymbolType.Marker
@@ -70,6 +84,7 @@
 QgsSymbol.Hybrid.__doc__ = "Hybrid symbol"
 Qgis.SymbolType.__doc__ = 'Symbol types\n\n.. versionadded:: 3.20\n\n' + '* ``Marker``: ' + Qgis.SymbolType.Marker.__doc__ + '\n' + '* ``Line``: ' + Qgis.SymbolType.Line.__doc__ + '\n' + '* ``Fill``: ' + Qgis.SymbolType.Fill.__doc__ + '\n' + '* ``Hybrid``: ' + Qgis.SymbolType.Hybrid.__doc__
 # --
+Qgis.SymbolType.baseClass = Qgis
 QgsSymbol.ScaleMethod = Qgis.ScaleMethod
 # monkey patching scoped based enum
 QgsSymbol.ScaleArea = Qgis.ScaleMethod.ScaleArea
@@ -78,22 +93,26 @@
 QgsSymbol.ScaleDiameter.__doc__ = "Calculate scale by the diameter"
 Qgis.ScaleMethod.__doc__ = 'Scale methods\n\n.. versionadded:: 3.20\n\n' + '* ``ScaleArea``: ' + Qgis.ScaleMethod.ScaleArea.__doc__ + '\n' + '* ``ScaleDiameter``: ' + Qgis.ScaleMethod.ScaleDiameter.__doc__
 # --
+Qgis.ScaleMethod.baseClass = Qgis
 QgsSymbol.RenderHint = Qgis.SymbolRenderHint
 # monkey patching scoped based enum
 QgsSymbol.DynamicRotation = Qgis.SymbolRenderHint.DynamicRotation
 QgsSymbol.DynamicRotation.__doc__ = "Rotation of symbol may be changed during rendering and symbol should not be cached"
 Qgis.SymbolRenderHint.__doc__ = 'Flags controlling behavior of symbols during rendering\n\n.. versionadded:: 3.20\n\n' + '* ``DynamicRotation``: ' + Qgis.SymbolRenderHint.DynamicRotation.__doc__
 # --
+Qgis.SymbolRenderHint.baseClass = Qgis
 # monkey patching scoped based enum
 Qgis.SymbolFlag.RendererShouldUseSymbolLevels.__doc__ = "If present, indicates that a QgsFeatureRenderer using the symbol should use symbol levels for best results"
 Qgis.SymbolFlag.__doc__ = 'Flags controlling behavior of symbols\n\n.. versionadded:: 3.20\n\n' + '* ``RendererShouldUseSymbolLevels``: ' + Qgis.SymbolFlag.RendererShouldUseSymbolLevels.__doc__
 # --
+Qgis.SymbolFlag.baseClass = Qgis
 QgsSymbol.PreviewFlag = Qgis.SymbolPreviewFlag
 # monkey patching scoped based enum
 QgsSymbol.FlagIncludeCrosshairsForMarkerSymbols = Qgis.SymbolPreviewFlag.FlagIncludeCrosshairsForMarkerSymbols
 QgsSymbol.FlagIncludeCrosshairsForMarkerSymbols.__doc__ = "Include a crosshairs reference image in the background of marker symbol previews"
 Qgis.SymbolPreviewFlag.__doc__ = 'Flags for controlling how symbol preview images are generated.\n\n.. versionadded:: 3.20\n\n' + '* ``FlagIncludeCrosshairsForMarkerSymbols``: ' + Qgis.SymbolPreviewFlag.FlagIncludeCrosshairsForMarkerSymbols.__doc__
 # --
+Qgis.SymbolPreviewFlag.baseClass = Qgis
 QgsDataItem.Type = Qgis.BrowserItemType
 # monkey patching scoped based enum
 QgsDataItem.Collection = Qgis.BrowserItemType.Collection
@@ -146,6 +165,7 @@
 QgsDataItem.Delete.__doc__ = "Item can be deleted"
 Qgis.BrowserItemCapability.__doc__ = 'Browser item capabilities.\n\n.. versionadded:: 3.20\n\n' + '* ``NoCapabilities``: ' + Qgis.BrowserItemCapability.NoCapabilities.__doc__ + '\n' + '* ``SetCrs``: ' + Qgis.BrowserItemCapability.SetCrs.__doc__ + '\n' + '* ``Fertile``: ' + Qgis.BrowserItemCapability.Fertile.__doc__ + '\n' + '* ``Fast``: ' + Qgis.BrowserItemCapability.Fast.__doc__ + '\n' + '* ``Collapse``: ' + Qgis.BrowserItemCapability.Collapse.__doc__ + '\n' + '* ``Rename``: ' + Qgis.BrowserItemCapability.Rename.__doc__ + '\n' + '* ``Delete``: ' + Qgis.BrowserItemCapability.Delete.__doc__
 # --
+Qgis.BrowserItemCapability.baseClass = Qgis
 QgsLayerItem.LayerType = Qgis.BrowserLayerType
 # monkey patching scoped based enum
 QgsLayerItem.NoType = Qgis.BrowserLayerType.NoType
@@ -222,3 +242,4 @@
 Qgis.UnplacedLabelVisibility.NeverShow.__doc__ = "Never show unplaced labels, regardless of the engine setting"
 Qgis.UnplacedLabelVisibility.__doc__ = 'Unplaced label visibility.\n\n.. versionadded:: 3.20\n\n' + '* ``FollowEngineSetting``: ' + Qgis.UnplacedLabelVisibility.FollowEngineSetting.__doc__ + '\n' + '* ``NeverShow``: ' + Qgis.UnplacedLabelVisibility.NeverShow.__doc__
 # --
+Qgis.UnplacedLabelVisibility.baseClass = Qgis

python/core/auto_generated/qgis.sip.in

@@ -102,8 +102,8 @@ The development version
       ARGB32_Premultiplied
     };
 
-    enum PythonMacroMode
-    {
+    enum class PythonMacroMode
+      {
       Never,
       Ask,
       SessionOnly,

src/core/qgis.h

@@ -137,8 +137,8 @@ class CORE_EXPORT Qgis
      * Authorisation to run Python Macros
      * \since QGIS 3.10
      */
-    enum PythonMacroMode
-    {
+    enum class PythonMacroMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( Qgis, PythonMacroMode ) : int
+      {
       Never = 0, //!< Macros are never run
       Ask = 1, //!< User is prompt before running
       SessionOnly = 2, //!< Only during this session
@@ -157,6 +157,7 @@ class CORE_EXPORT Qgis
       Uncounted = -2, //!< Feature count not yet computed
       UnknownCount = -1, //!< Provider returned an unknown feature count
     };
+    Q_ENUM( FeatureCountState )
 
     /**
      * \brief Symbol types
@@ -169,6 +170,7 @@ class CORE_EXPORT Qgis
       Fill, //!< Fill symbol
       Hybrid //!< Hybrid symbol
     };
+    Q_ENUM( SymbolType )
 
     /**
      * \brief Scale methods
@@ -180,6 +182,7 @@ class CORE_EXPORT Qgis
       ScaleArea,     //!< Calculate scale by the area
       ScaleDiameter  //!< Calculate scale by the diameter
     };
+    Q_ENUM( ScaleMethod )
 
     /**
      * \brief Flags controlling behavior of symbols during rendering
@@ -190,6 +193,7 @@ class CORE_EXPORT Qgis
       {
       DynamicRotation = 2, //!< Rotation of symbol may be changed during rendering and symbol should not be cached
     };
+    Q_ENUM( SymbolRenderHint )
     Q_DECLARE_FLAGS( SymbolRenderHints, SymbolRenderHint )
 
     /**
@@ -201,6 +205,7 @@ class CORE_EXPORT Qgis
     {
       RendererShouldUseSymbolLevels = 1 << 0, //!< If present, indicates that a QgsFeatureRenderer using the symbol should use symbol levels for best results
     };
+    Q_ENUM( SymbolFlag )
     Q_DECLARE_FLAGS( SymbolFlags, SymbolFlag )
 
     /**
@@ -212,6 +217,7 @@ class CORE_EXPORT Qgis
       {
       FlagIncludeCrosshairsForMarkerSymbols = 1 << 0, //!< Include a crosshairs reference image in the background of marker symbol previews
     };
+    Q_ENUM( SymbolPreviewFlag )
     Q_DECLARE_FLAGS( SymbolPreviewFlags, SymbolPreviewFlag )
 
     /**
@@ -261,6 +267,7 @@ class CORE_EXPORT Qgis
       Rename = 1 << 4, //!< Item can be renamed
       Delete = 1 << 5, //!< Item can be deleted
     };
+    Q_ENUM( BrowserItemCapability )
     Q_DECLARE_FLAGS( BrowserItemCapabilities, BrowserItemCapability )
 
     /**
@@ -334,6 +341,7 @@ class CORE_EXPORT Qgis
       FollowEngineSetting, //!< Respect the label engine setting
       NeverShow, //!< Never show unplaced labels, regardless of the engine setting
     };
+    Q_ENUM( UnplacedLabelVisibility )
 
     /**
      * Identify search radius in mm