From 8ec6807b9c7ebd513e303650ad42987e1d2a1518 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Tue, 3 Dec 2024 09:30:11 +1000 Subject: [PATCH] Fix more function links --- python/PyQt6/core/auto_additions/qgscadutils.py | 2 +- .../core/auto_additions/qgsgpsinformation.py | 2 +- .../auto_generated/browser/qgsdataitem.sip.in | 2 +- .../auto_generated/geometry/qgscircle.sip.in | 4 ++-- .../auto_generated/geometry/qgslinestring.sip.in | 3 ++- .../auto_generated/project/qgsproject.sip.in | 4 ++-- .../auto_generated/qgsfeaturefiltermodel.sip.in | 2 +- .../core/auto_generated/qgsmaptopixel.sip.in | 2 +- .../auto_generated/qgsvectorfilewriter.sip.in | 2 +- .../settings/qgssettingsentry.sip.in | 4 ++-- .../symbology/qgsgraduatedsymbolrenderer.sip.in | 16 ++++++++-------- .../auto_generated/symbology/qgssymbol.sip.in | 2 +- .../symbology/qgssymbollayerreference.sip.in | 2 +- .../vector/qgsvectordataprovider.sip.in | 2 +- .../auto_generated/vector/qgsvectorlayer.sip.in | 4 ++-- .../qgsadvanceddigitizingdockwidget.py | 2 +- .../qgsattributeformeditorwidget.py | 2 +- .../qgsadvanceddigitizingdockwidget.sip.in | 2 +- .../qgsattributeformeditorwidget.sip.in | 2 +- .../auto_generated/qgshttpheaderwidget.sip.in | 2 +- python/core/auto_additions/qgscadutils.py | 2 +- python/core/auto_additions/qgsgpsinformation.py | 2 +- .../auto_generated/browser/qgsdataitem.sip.in | 2 +- .../auto_generated/geometry/qgscircle.sip.in | 4 ++-- .../auto_generated/geometry/qgslinestring.sip.in | 3 ++- .../auto_generated/project/qgsproject.sip.in | 4 ++-- .../auto_generated/qgsfeaturefiltermodel.sip.in | 2 +- python/core/auto_generated/qgsmaptopixel.sip.in | 2 +- .../auto_generated/qgsvectorfilewriter.sip.in | 2 +- .../settings/qgssettingsentry.sip.in | 4 ++-- .../symbology/qgsgraduatedsymbolrenderer.sip.in | 16 ++++++++-------- .../auto_generated/symbology/qgssymbol.sip.in | 2 +- .../symbology/qgssymbollayerreference.sip.in | 2 +- .../vector/qgsvectordataprovider.sip.in | 2 +- .../auto_generated/vector/qgsvectorlayer.sip.in | 4 ++-- .../qgsadvanceddigitizingdockwidget.py | 2 +- .../qgsattributeformeditorwidget.py | 2 +- .../qgsadvanceddigitizingdockwidget.sip.in | 2 +- .../qgsattributeformeditorwidget.sip.in | 2 +- .../auto_generated/qgshttpheaderwidget.sip.in | 2 +- src/core/browser/qgsdataitem.h | 2 +- src/core/geometry/qgscircle.h | 4 ++-- src/core/geometry/qgslinestring.h | 3 +-- src/core/gps/qgsgpsinformation.h | 2 +- src/core/project/qgsproject.h | 4 ++-- src/core/qgscadutils.h | 2 +- src/core/qgsfeaturefiltermodel.h | 2 +- src/core/qgsmaptopixel.h | 2 +- src/core/qgsvectorfilewriter.h | 2 +- src/core/settings/qgssettingsentry.h | 4 ++-- src/core/symbology/qgsgraduatedsymbolrenderer.h | 16 ++++++++-------- src/core/symbology/qgssymbol.h | 2 +- src/core/symbology/qgssymbollayerreference.h | 2 +- src/core/vector/qgsvectordataprovider.h | 2 +- src/core/vector/qgsvectorlayer.h | 4 ++-- src/gui/layertree/qgslayertreemapcanvasbridge.h | 2 +- src/gui/qgsadvanceddigitizingdockwidget.h | 2 +- src/gui/qgsattributeformeditorwidget.h | 2 +- src/gui/qgshttpheaderwidget.h | 2 +- src/gui/settings/qgssettingstreemodel.h | 2 +- 60 files changed, 95 insertions(+), 94 deletions(-) diff --git a/python/PyQt6/core/auto_additions/qgscadutils.py b/python/PyQt6/core/auto_additions/qgscadutils.py index 9aea9fa772c6..49ceaeee8f31 100644 --- a/python/PyQt6/core/auto_additions/qgscadutils.py +++ b/python/PyQt6/core/auto_additions/qgscadutils.py @@ -4,7 +4,7 @@ except NameError: pass try: - QgsCadUtils.AlignMapPointOutput.__attribute_docs__ = {'valid': 'Whether the combination of constraints is actually valid', 'finalMapPoint': 'map point aligned according to the constraints', 'snapMatch': 'Snapped point - only valid if actually used for something\n\n.. versionadded:: 3.14', 'edgeMatch': 'Snapped segment - only valid if actually used for something\n\n.. deprecated:: 3.40\n\n Will be removed in QGIS 4.0 - use snapMatch instead.', 'softLockCommonAngle': 'Angle (in degrees) to which we have soft-locked ourselves (if not set it is -1)'} + QgsCadUtils.AlignMapPointOutput.__attribute_docs__ = {'valid': 'Whether the combination of constraints is actually valid', 'finalMapPoint': 'map point aligned according to the constraints', 'snapMatch': 'Snapped point - only valid if actually used for something\n\n.. versionadded:: 3.14', 'edgeMatch': 'Snapped segment - only valid if actually used for something\n\n.. deprecated:: 3.40\n\n Will be removed in QGIS 4.0 - use :py:func:`~AlignMapPointOutput.snapMatch` instead.', 'softLockCommonAngle': 'Angle (in degrees) to which we have soft-locked ourselves (if not set it is -1)'} except NameError: pass try: diff --git a/python/PyQt6/core/auto_additions/qgsgpsinformation.py b/python/PyQt6/core/auto_additions/qgsgpsinformation.py index 64facbec0010..34b6df5d1cc9 100644 --- a/python/PyQt6/core/auto_additions/qgsgpsinformation.py +++ b/python/PyQt6/core/auto_additions/qgsgpsinformation.py @@ -1,6 +1,6 @@ # The following has been generated automatically from src/core/gps/qgsgpsinformation.h try: - QgsGpsInformation.__attribute_docs__ = {'latitude': 'Latitude in decimal degrees, using the WGS84 datum. A positive value indicates the Northern Hemisphere, and\na negative value indicates the Southern Hemisphere.', 'longitude': 'Longitude in decimal degrees, using the WGS84 datum. A positive value indicates the Eastern Hemisphere, and\na negative value indicates the Western Hemisphere.', 'elevation': 'Altitude (in meters) above or below the mean sea level.', 'elevation_diff': 'Geoidal separation (in meters).\n\nThe difference between the WGS-84 Earth ellipsoid and the mean sea level (geoid).\n\nNegative values indicate that mean sea level is below the ellipsoid.\n\nThis value can be added to the elevation value to obtain the geoidal elevation.\n\n.. versionadded:: 3.18', 'speed': 'Ground speed, in km/h.', 'direction': 'The bearing measured in degrees clockwise from true north to the direction of travel.', 'satellitesInView': 'Contains a list of information relating to the current satellites in view.', 'pdop': 'Dilution of precision.', 'hdop': 'Horizontal dilution of precision.', 'vdop': 'Vertical dilution of precision.', 'hvacc': '3D RMS\n\n.. versionadded:: 3.18', 'utcTime': 'The time at which this position was reported, in UTC time.\n\n.. versionadded:: 3.30', 'utcDateTime': 'The date and time at which this position was reported, in UTC time.', 'fixMode': 'Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)', 'fixType': 'Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.constellationFixStatus` or :py:func:`~QgsGpsInformation.bestFixStatus` instead.', 'quality': 'GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)\n\n.. deprecated:: 3.40\n\n Use qualityIndicator instead.', 'qualityIndicator': 'Returns the signal quality indicator\n\n.. versionadded:: 3.22.6', 'satellitesUsed': 'Count of satellites used in obtaining the fix.', 'status': 'Status (A = active or V = void)', 'satPrn': 'IDs of satellites used in the position fix.', 'satInfoComplete': '``True`` if satellite information is complete.'} + QgsGpsInformation.__attribute_docs__ = {'latitude': 'Latitude in decimal degrees, using the WGS84 datum. A positive value indicates the Northern Hemisphere, and\na negative value indicates the Southern Hemisphere.', 'longitude': 'Longitude in decimal degrees, using the WGS84 datum. A positive value indicates the Eastern Hemisphere, and\na negative value indicates the Western Hemisphere.', 'elevation': 'Altitude (in meters) above or below the mean sea level.', 'elevation_diff': 'Geoidal separation (in meters).\n\nThe difference between the WGS-84 Earth ellipsoid and the mean sea level (geoid).\n\nNegative values indicate that mean sea level is below the ellipsoid.\n\nThis value can be added to the elevation value to obtain the geoidal elevation.\n\n.. versionadded:: 3.18', 'speed': 'Ground speed, in km/h.', 'direction': 'The bearing measured in degrees clockwise from true north to the direction of travel.', 'satellitesInView': 'Contains a list of information relating to the current satellites in view.', 'pdop': 'Dilution of precision.', 'hdop': 'Horizontal dilution of precision.', 'vdop': 'Vertical dilution of precision.', 'hvacc': '3D RMS\n\n.. versionadded:: 3.18', 'utcTime': 'The time at which this position was reported, in UTC time.\n\n.. versionadded:: 3.30', 'utcDateTime': 'The date and time at which this position was reported, in UTC time.', 'fixMode': 'Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)', 'fixType': 'Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.constellationFixStatus` or :py:func:`~QgsGpsInformation.bestFixStatus` instead.', 'quality': 'GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.qualityIndicator` instead.', 'qualityIndicator': 'Returns the signal quality indicator\n\n.. versionadded:: 3.22.6', 'satellitesUsed': 'Count of satellites used in obtaining the fix.', 'status': 'Status (A = active or V = void)', 'satPrn': 'IDs of satellites used in the position fix.', 'satInfoComplete': '``True`` if satellite information is complete.'} QgsGpsInformation.__group__ = ['gps'] except NameError: pass diff --git a/python/PyQt6/core/auto_generated/browser/qgsdataitem.sip.in b/python/PyQt6/core/auto_generated/browser/qgsdataitem.sip.in index 0ed4a79242f5..85203cae450f 100644 --- a/python/PyQt6/core/auto_generated/browser/qgsdataitem.sip.in +++ b/python/PyQt6/core/auto_generated/browser/qgsdataitem.sip.in @@ -292,7 +292,7 @@ Sets the capabilities for the data item. .. deprecated:: 3.40 - Use setCapabilitiesV2 instead. + Use :py:func:`~QgsDataItem.setCapabilitiesV2` instead. %End diff --git a/python/PyQt6/core/auto_generated/geometry/qgscircle.sip.in b/python/PyQt6/core/auto_generated/geometry/qgscircle.sip.in index 808e5c13d7a4..8cbcbb8a36f8 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgscircle.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgscircle.sip.in @@ -301,7 +301,7 @@ Returns the number of tangents (either 0 or 2). virtual void setSemiMajorAxis( double semiMajorAxis ) /HoldGIL/; %Docstring -Inherited method. Use setRadius instead. +Inherited method. Use :py:func:`~QgsCircle.setRadius` instead. .. seealso:: :py:func:`radius` @@ -311,7 +311,7 @@ Inherited method. Use setRadius instead. virtual void setSemiMinorAxis( double semiMinorAxis ) /HoldGIL/; %Docstring -Inherited method. Use setRadius instead. +Inherited method. Use :py:func:`~QgsCircle.setRadius` instead. .. seealso:: :py:func:`radius` diff --git a/python/PyQt6/core/auto_generated/geometry/qgslinestring.sip.in b/python/PyQt6/core/auto_generated/geometry/qgslinestring.sip.in index 4a6fc64f8c71..bb0eae78f311 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgslinestring.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgslinestring.sip.in @@ -857,13 +857,14 @@ corresponds to the last point in the line. QgsBox3D calculateBoundingBox3d() const /Deprecated/; %Docstring Calculates the minimal 3D bounding box for the geometry. -Deprecated: use calculateBoundingBox3D instead .. seealso:: :py:func:`calculateBoundingBox` .. versionadded:: 3.26 .. deprecated:: 3.34 + + use :py:func:`~QgsLineString.calculateBoundingBox3D` instead %End virtual QgsBox3D calculateBoundingBox3D() const; diff --git a/python/PyQt6/core/auto_generated/project/qgsproject.sip.in b/python/PyQt6/core/auto_generated/project/qgsproject.sip.in index 79767e890d8e..6ad0a9ad1327 100644 --- a/python/PyQt6/core/auto_generated/project/qgsproject.sip.in +++ b/python/PyQt6/core/auto_generated/project/qgsproject.sip.in @@ -969,7 +969,7 @@ transaction. .. deprecated:: 3.26 - Use transactionMode instead. + Use :py:func:`~QgsProject.transactionMode` instead. %End void setAutoTransaction( bool autoTransaction ) /Deprecated/; @@ -984,7 +984,7 @@ transaction. .. deprecated:: 3.26 - Use setTransactionMode instead. + Use :py:func:`~QgsProject.setTransactionMode` instead. %End Qgis::TransactionMode transactionMode() const; diff --git a/python/PyQt6/core/auto_generated/qgsfeaturefiltermodel.sip.in b/python/PyQt6/core/auto_generated/qgsfeaturefiltermodel.sip.in index 401292276c75..e530ce27785a 100644 --- a/python/PyQt6/core/auto_generated/qgsfeaturefiltermodel.sip.in +++ b/python/PyQt6/core/auto_generated/qgsfeaturefiltermodel.sip.in @@ -33,7 +33,7 @@ If there are several identifier fields defined, the behavior is not guaranteed .. deprecated:: 3.10 - Use identifierFields instead. + Use :py:func:`~QgsFeatureFilterModel.identifierFields` instead. %End QStringList identifierFields() const; diff --git a/python/PyQt6/core/auto_generated/qgsmaptopixel.sip.in b/python/PyQt6/core/auto_generated/qgsmaptopixel.sip.in index 8f90d4c4a14e..1dbf008a8d2f 100644 --- a/python/PyQt6/core/auto_generated/qgsmaptopixel.sip.in +++ b/python/PyQt6/core/auto_generated/qgsmaptopixel.sip.in @@ -137,7 +137,7 @@ Transforms device coordinates to map (world) coordinates. .. deprecated:: 3.4 - Use toMapCoordinates instead. + Use :py:func:`~QgsMapToPixel.toMapCoordinates` instead. %End void setMapUnitsPerPixel( double mapUnitsPerPixel ); diff --git a/python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in b/python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in index c7f966c4ad4b..66ab326898de 100644 --- a/python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in +++ b/python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in @@ -485,7 +485,7 @@ Writes a layer out to a vector file. .. deprecated:: 3.20 - Use writeAsVectorFormatV3 instead. + Use :py:func:`~QgsVectorFileWriter.writeAsVectorFormatV3` instead. %End static QgsVectorFileWriter::WriterError writeAsVectorFormatV3( QgsVectorLayer *layer, diff --git a/python/PyQt6/core/auto_generated/settings/qgssettingsentry.sip.in b/python/PyQt6/core/auto_generated/settings/qgssettingsentry.sip.in index 8f1766d27f92..10bd5416658e 100644 --- a/python/PyQt6/core/auto_generated/settings/qgssettingsentry.sip.in +++ b/python/PyQt6/core/auto_generated/settings/qgssettingsentry.sip.in @@ -252,7 +252,7 @@ Returns settings value with an optional default value override .. deprecated:: 3.26 - Use valueAsVariantWithDefaultOverride instead. + Use :py:func:`~QgsSettingsEntryBase.valueAsVariantWithDefaultOverride` instead. %End QVariant valueAsVariant( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const /Deprecated/; @@ -261,7 +261,7 @@ Returns settings value with an optional default value override .. deprecated:: 3.26 - Use valueAsVariantWithDefaultOverride instead. + Use :py:func:`~QgsSettingsEntryBase.valueAsVariantWithDefaultOverride` instead. %End diff --git a/python/PyQt6/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in b/python/PyQt6/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in index 9123bec1a497..f2ab28a09091 100644 --- a/python/PyQt6/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in +++ b/python/PyQt6/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in @@ -156,14 +156,14 @@ This will take ownership of the method .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End void setMode( Mode mode ) /Deprecated/; %Docstring .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End bool useSymmetricMode() const /Deprecated/; @@ -174,7 +174,7 @@ Returns if we want to classify symmetric around a given value .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End void setUseSymmetricMode( bool useSymmetricMode ) /Deprecated/; @@ -185,7 +185,7 @@ Set if we want to classify symmetric around a given value .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End double symmetryPoint() const /Deprecated/; @@ -196,7 +196,7 @@ Returns the pivot value for symmetric classification .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End void setSymmetryPoint( double symmetryPoint ) /Deprecated/; @@ -207,7 +207,7 @@ Set the pivot point .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End @@ -219,7 +219,7 @@ Returns if we want to have a central class astride the pivot value .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End void setAstride( bool astride ) /Deprecated/; @@ -230,7 +230,7 @@ Set if we want a central class astride the pivot value .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End static void makeBreaksSymmetric( QList &breaks /In,Out/, double symmetryPoint, bool astride ) /Deprecated/; diff --git a/python/PyQt6/core/auto_generated/symbology/qgssymbol.sip.in b/python/PyQt6/core/auto_generated/symbology/qgssymbol.sip.in index c04f05b5114a..ce68f69f4708 100644 --- a/python/PyQt6/core/auto_generated/symbology/qgssymbol.sip.in +++ b/python/PyQt6/core/auto_generated/symbology/qgssymbol.sip.in @@ -534,7 +534,7 @@ Returns a large (roughly 100x100 pixel) preview image for the symbol. .. deprecated:: 3.40 - Use bigSymbolPreviewImageV2 instead. + Use :py:func:`~QgsSymbol.bigSymbolPreviewImageV2` instead. %End QString dump() const; diff --git a/python/PyQt6/core/auto_generated/symbology/qgssymbollayerreference.sip.in b/python/PyQt6/core/auto_generated/symbology/qgssymbollayerreference.sip.in index a38a13fe0a42..f1094ec90b42 100644 --- a/python/PyQt6/core/auto_generated/symbology/qgssymbollayerreference.sip.in +++ b/python/PyQt6/core/auto_generated/symbology/qgssymbollayerreference.sip.in @@ -136,7 +136,7 @@ The symbol layer's id .. deprecated:: 3.30 - Use symbolLayerIdV2 instead. + Use :py:func:`~QgsSymbolLayerReference.symbolLayerIdV2` instead. %End QString symbolLayerIdV2() const; diff --git a/python/PyQt6/core/auto_generated/vector/qgsvectordataprovider.sip.in b/python/PyQt6/core/auto_generated/vector/qgsvectordataprovider.sip.in index a8e519413428..bef089c282ef 100644 --- a/python/PyQt6/core/auto_generated/vector/qgsvectordataprovider.sip.in +++ b/python/PyQt6/core/auto_generated/vector/qgsvectordataprovider.sip.in @@ -562,7 +562,7 @@ Returns the transaction this data provider is included in, if any. .. deprecated:: 3.12 - Will be removed in QGIS 4.0 - use reloadData instead. + Will be removed in QGIS 4.0 - use :py:func:`~QgsVectorDataProvider.reloadData` instead. %End virtual QSet dependencies() const; diff --git a/python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in b/python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in index 01a8fc1c864c..cbcccf086af2 100644 --- a/python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in +++ b/python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in @@ -1968,7 +1968,7 @@ A set of attributes that are not advertised in WMS requests with QGIS server. .. deprecated:: 3.16 - Use setFieldConfigurationFlag instead. + Use :py:func:`~QgsVectorLayer.setFieldConfigurationFlag` instead. %End QSet excludeAttributesWfs() const /Deprecated/; @@ -1986,7 +1986,7 @@ A set of attributes that are not advertised in WFS requests with QGIS server. .. deprecated:: 3.16 - Use setFieldConfigurationFlag instead. + Use :py:func:`~QgsVectorLayer.setFieldConfigurationFlag` instead. %End virtual bool deleteAttribute( int attr ); diff --git a/python/PyQt6/gui/auto_additions/qgsadvanceddigitizingdockwidget.py b/python/PyQt6/gui/auto_additions/qgsadvanceddigitizingdockwidget.py index c68198d176e8..828ede3398d2 100644 --- a/python/PyQt6/gui/auto_additions/qgsadvanceddigitizingdockwidget.py +++ b/python/PyQt6/gui/auto_additions/qgsadvanceddigitizingdockwidget.py @@ -21,7 +21,7 @@ def _force_int(v): return int(v.value) if isinstance(v, Enum) else v QgsAdvancedDigitizingDockWidget.CadCapacity.__and__ = lambda flag1, flag2: _force_int(flag1) & _force_int(flag2) QgsAdvancedDigitizingDockWidget.CadCapacity.__or__ = lambda flag1, flag2: QgsAdvancedDigitizingDockWidget.CadCapacity(_force_int(flag1) | _force_int(flag2)) try: - QgsAdvancedDigitizingDockWidget.__attribute_docs__ = {'pushWarning': 'Push a warning\n\n:param message: An informative message\n', 'popWarning': 'Remove any previously emitted warnings (if any)\n', 'pointChangedV2': 'Sometimes a constraint may change the current point out of a mouse event. This happens normally\nwhen a constraint is toggled.\n\n:param point: The last known digitizing point. Can be used to emulate a mouse event.\n\n.. versionadded:: 3.22\n', 'pointChanged': 'Sometimes a constraint may change the current point out of a mouse event. This happens normally\nwhen a constraint is toggled.\n\n:param point: The last known digitizing point. Can be used to emulate a mouse event.\n\n.. deprecated:: 3.22\n\n No longer used, will be removed in QGIS 4.0. Use pointChangedV2 instead.\n', 'cadEnabledChanged': 'Emitted whenever CAD is enabled or disabled\n\n:param enabled: Whether CAD is enabled or not\n\n.. note::\n\n unstable API (will likely change).\n\n.. versionadded:: 3.8\n', 'valueXChanged': 'Emitted whenever the X ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueYChanged': 'Emitted whenever the Y ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueZChanged': 'Emitted whenever the Z ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'valueMChanged': 'Emitted whenever the M ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'valueAngleChanged': 'Emitted whenever the angle ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueDistanceChanged': 'Emitted whenever the distance ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueBearingChanged': 'Emitted whenever the bearing ``value`` changes.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.32\n', 'lockXChanged': 'Emitted whenever the X parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockYChanged': 'Emitted whenever the Y parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockZChanged': 'Emitted whenever the Z parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'lockMChanged': 'Emitted whenever the M parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'lockAngleChanged': 'Emitted whenever the angle parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockDistanceChanged': 'Emitted whenever the distance parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeXChanged': 'Emitted whenever the X parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the X parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeYChanged': 'Emitted whenever the Y parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the Y parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeZChanged': 'Emitted whenever the Z parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the Z parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'relativeMChanged': 'Emitted whenever the M parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the M parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'relativeAngleChanged': 'Emitted whenever the angleX parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the angle parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'softLockLineExtensionChanged': 'Emitted whenever the soft line extension parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.26\n', 'softLockXyChanged': 'Emitted whenever the soft x/y extension parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.26\n', 'enabledChangedX': 'Emitted whenever the X field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the X parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedY': 'Emitted whenever the Y field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the Y parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedZ': 'Emitted whenever the Z field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the Z parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'enabledChangedM': 'Emitted whenever the M field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the M parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'enabledChangedAngle': 'Emitted whenever the angle field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the angle parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedDistance': 'Emitted whenever the distance field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the distance parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnXRequested': 'Emitted whenever the X field should get the focus using the shortcuts (X).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnYRequested': 'Emitted whenever the Y field should get the focus using the shortcuts (Y).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnZRequested': 'Emitted whenever the Z field should get the focus using the shortcuts (Z).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'focusOnMRequested': 'Emitted whenever the M field should get the focus using the shortcuts (M).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'focusOnAngleRequested': 'Emitted whenever the angle field should get the focus using the shortcuts (A).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnDistanceRequested': 'Emitted whenever the distance field should get the focus using the shortcuts (D).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueCommonAngleSnappingChanged': 'Emitted whenever the snapping to common angle option changes, angle = 0 means that the functionality is disabled.\n\n.. versionadded:: 3.32\n'} + QgsAdvancedDigitizingDockWidget.__attribute_docs__ = {'pushWarning': 'Push a warning\n\n:param message: An informative message\n', 'popWarning': 'Remove any previously emitted warnings (if any)\n', 'pointChangedV2': 'Sometimes a constraint may change the current point out of a mouse event. This happens normally\nwhen a constraint is toggled.\n\n:param point: The last known digitizing point. Can be used to emulate a mouse event.\n\n.. versionadded:: 3.22\n', 'pointChanged': 'Sometimes a constraint may change the current point out of a mouse event. This happens normally\nwhen a constraint is toggled.\n\n:param point: The last known digitizing point. Can be used to emulate a mouse event.\n\n.. deprecated:: 3.22\n\n No longer used, will be removed in QGIS 4.0. Use :py:func:`~QgsAdvancedDigitizingDockWidget.pointChangedV2` instead.\n', 'cadEnabledChanged': 'Emitted whenever CAD is enabled or disabled\n\n:param enabled: Whether CAD is enabled or not\n\n.. note::\n\n unstable API (will likely change).\n\n.. versionadded:: 3.8\n', 'valueXChanged': 'Emitted whenever the X ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueYChanged': 'Emitted whenever the Y ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueZChanged': 'Emitted whenever the Z ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'valueMChanged': 'Emitted whenever the M ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'valueAngleChanged': 'Emitted whenever the angle ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueDistanceChanged': 'Emitted whenever the distance ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueBearingChanged': 'Emitted whenever the bearing ``value`` changes.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.32\n', 'lockXChanged': 'Emitted whenever the X parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockYChanged': 'Emitted whenever the Y parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockZChanged': 'Emitted whenever the Z parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'lockMChanged': 'Emitted whenever the M parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'lockAngleChanged': 'Emitted whenever the angle parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockDistanceChanged': 'Emitted whenever the distance parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeXChanged': 'Emitted whenever the X parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the X parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeYChanged': 'Emitted whenever the Y parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the Y parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeZChanged': 'Emitted whenever the Z parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the Z parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'relativeMChanged': 'Emitted whenever the M parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the M parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'relativeAngleChanged': 'Emitted whenever the angleX parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the angle parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'softLockLineExtensionChanged': 'Emitted whenever the soft line extension parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.26\n', 'softLockXyChanged': 'Emitted whenever the soft x/y extension parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.26\n', 'enabledChangedX': 'Emitted whenever the X field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the X parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedY': 'Emitted whenever the Y field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the Y parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedZ': 'Emitted whenever the Z field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the Z parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'enabledChangedM': 'Emitted whenever the M field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the M parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'enabledChangedAngle': 'Emitted whenever the angle field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the angle parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedDistance': 'Emitted whenever the distance field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the distance parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnXRequested': 'Emitted whenever the X field should get the focus using the shortcuts (X).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnYRequested': 'Emitted whenever the Y field should get the focus using the shortcuts (Y).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnZRequested': 'Emitted whenever the Z field should get the focus using the shortcuts (Z).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'focusOnMRequested': 'Emitted whenever the M field should get the focus using the shortcuts (M).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'focusOnAngleRequested': 'Emitted whenever the angle field should get the focus using the shortcuts (A).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnDistanceRequested': 'Emitted whenever the distance field should get the focus using the shortcuts (D).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueCommonAngleSnappingChanged': 'Emitted whenever the snapping to common angle option changes, angle = 0 means that the functionality is disabled.\n\n.. versionadded:: 3.32\n'} QgsAdvancedDigitizingDockWidget.__signal_arguments__ = {'pushWarning': ['message: str'], 'pointChangedV2': ['point: QgsPoint'], 'cadEnabledChanged': ['enabled: bool'], 'valueXChanged': ['value: str'], 'valueYChanged': ['value: str'], 'valueZChanged': ['value: str'], 'valueMChanged': ['value: str'], 'valueAngleChanged': ['value: str'], 'valueDistanceChanged': ['value: str'], 'valueBearingChanged': ['value: str'], 'lockXChanged': ['locked: bool'], 'lockYChanged': ['locked: bool'], 'lockZChanged': ['locked: bool'], 'lockMChanged': ['locked: bool'], 'lockAngleChanged': ['locked: bool'], 'lockDistanceChanged': ['locked: bool'], 'relativeXChanged': ['relative: bool'], 'relativeYChanged': ['relative: bool'], 'relativeZChanged': ['relative: bool'], 'relativeMChanged': ['relative: bool'], 'relativeAngleChanged': ['relative: bool'], 'softLockLineExtensionChanged': ['locked: bool'], 'softLockXyChanged': ['locked: bool'], 'enabledChangedX': ['enabled: bool'], 'enabledChangedY': ['enabled: bool'], 'enabledChangedZ': ['enabled: bool'], 'enabledChangedM': ['enabled: bool'], 'enabledChangedAngle': ['enabled: bool'], 'enabledChangedDistance': ['enabled: bool'], 'valueCommonAngleSnappingChanged': ['angle: float']} except NameError: pass diff --git a/python/PyQt6/gui/auto_additions/qgsattributeformeditorwidget.py b/python/PyQt6/gui/auto_additions/qgsattributeformeditorwidget.py index 5cc53cfe6ce1..c9801be0d202 100644 --- a/python/PyQt6/gui/auto_additions/qgsattributeformeditorwidget.py +++ b/python/PyQt6/gui/auto_additions/qgsattributeformeditorwidget.py @@ -1,6 +1,6 @@ # The following has been generated automatically from src/gui/qgsattributeformeditorwidget.h try: - QgsAttributeFormEditorWidget.__attribute_docs__ = {'valueChanged': "Emitted when the widget's value changes\n\n:param value: new widget value\n\n.. deprecated:: 3.10\n\n Use valuesChanged instead.\n", 'valuesChanged': "Emitted when the widget's value changes\n\n:param value: new widget value\n:param additionalFieldValues: of the potential additional fields\n\n.. versionadded:: 3.10\n"} + QgsAttributeFormEditorWidget.__attribute_docs__ = {'valueChanged': "Emitted when the widget's value changes\n\n:param value: new widget value\n\n.. deprecated:: 3.10\n\n Use :py:func:`~QgsAttributeFormEditorWidget.valuesChanged` instead.\n", 'valuesChanged': "Emitted when the widget's value changes\n\n:param value: new widget value\n:param additionalFieldValues: of the potential additional fields\n\n.. versionadded:: 3.10\n"} QgsAttributeFormEditorWidget.__signal_arguments__ = {'valueChanged': ['value: object'], 'valuesChanged': ['value: object', 'additionalFieldValues: List[object]']} except NameError: pass diff --git a/python/PyQt6/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in b/python/PyQt6/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in index 908af3259eca..6355da5e2c70 100644 --- a/python/PyQt6/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in +++ b/python/PyQt6/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in @@ -715,7 +715,7 @@ when a constraint is toggled. .. deprecated:: 3.22 - No longer used, will be removed in QGIS 4.0. Use pointChangedV2 instead. + No longer used, will be removed in QGIS 4.0. Use :py:func:`~QgsAdvancedDigitizingDockWidget.pointChangedV2` instead. %End diff --git a/python/PyQt6/gui/auto_generated/qgsattributeformeditorwidget.sip.in b/python/PyQt6/gui/auto_generated/qgsattributeformeditorwidget.sip.in index a093beeaa786..6a1a9e67e5c2 100644 --- a/python/PyQt6/gui/auto_generated/qgsattributeformeditorwidget.sip.in +++ b/python/PyQt6/gui/auto_generated/qgsattributeformeditorwidget.sip.in @@ -101,7 +101,7 @@ Emitted when the widget's value changes .. deprecated:: 3.10 - Use valuesChanged instead. + Use :py:func:`~QgsAttributeFormEditorWidget.valuesChanged` instead. %End void valuesChanged( const QVariant &value, const QVariantList &additionalFieldValues ); diff --git a/python/PyQt6/gui/auto_generated/qgshttpheaderwidget.sip.in b/python/PyQt6/gui/auto_generated/qgshttpheaderwidget.sip.in index 3ab60fa8657a..332cebf231e5 100644 --- a/python/PyQt6/gui/auto_generated/qgshttpheaderwidget.sip.in +++ b/python/PyQt6/gui/auto_generated/qgshttpheaderwidget.sip.in @@ -55,7 +55,7 @@ fill the inner header map from the settings defined at ``key`` .. deprecated:: 3.30 - Use setFromHeaders instead. + Use :py:func:`~QgsHttpHeaderWidget.setFromHeaders` instead. %End void updateSettings( QgsSettings &settings, const QString &key ) const /Deprecated/; diff --git a/python/core/auto_additions/qgscadutils.py b/python/core/auto_additions/qgscadutils.py index 9aea9fa772c6..49ceaeee8f31 100644 --- a/python/core/auto_additions/qgscadutils.py +++ b/python/core/auto_additions/qgscadutils.py @@ -4,7 +4,7 @@ except NameError: pass try: - QgsCadUtils.AlignMapPointOutput.__attribute_docs__ = {'valid': 'Whether the combination of constraints is actually valid', 'finalMapPoint': 'map point aligned according to the constraints', 'snapMatch': 'Snapped point - only valid if actually used for something\n\n.. versionadded:: 3.14', 'edgeMatch': 'Snapped segment - only valid if actually used for something\n\n.. deprecated:: 3.40\n\n Will be removed in QGIS 4.0 - use snapMatch instead.', 'softLockCommonAngle': 'Angle (in degrees) to which we have soft-locked ourselves (if not set it is -1)'} + QgsCadUtils.AlignMapPointOutput.__attribute_docs__ = {'valid': 'Whether the combination of constraints is actually valid', 'finalMapPoint': 'map point aligned according to the constraints', 'snapMatch': 'Snapped point - only valid if actually used for something\n\n.. versionadded:: 3.14', 'edgeMatch': 'Snapped segment - only valid if actually used for something\n\n.. deprecated:: 3.40\n\n Will be removed in QGIS 4.0 - use :py:func:`~AlignMapPointOutput.snapMatch` instead.', 'softLockCommonAngle': 'Angle (in degrees) to which we have soft-locked ourselves (if not set it is -1)'} except NameError: pass try: diff --git a/python/core/auto_additions/qgsgpsinformation.py b/python/core/auto_additions/qgsgpsinformation.py index 64facbec0010..34b6df5d1cc9 100644 --- a/python/core/auto_additions/qgsgpsinformation.py +++ b/python/core/auto_additions/qgsgpsinformation.py @@ -1,6 +1,6 @@ # The following has been generated automatically from src/core/gps/qgsgpsinformation.h try: - QgsGpsInformation.__attribute_docs__ = {'latitude': 'Latitude in decimal degrees, using the WGS84 datum. A positive value indicates the Northern Hemisphere, and\na negative value indicates the Southern Hemisphere.', 'longitude': 'Longitude in decimal degrees, using the WGS84 datum. A positive value indicates the Eastern Hemisphere, and\na negative value indicates the Western Hemisphere.', 'elevation': 'Altitude (in meters) above or below the mean sea level.', 'elevation_diff': 'Geoidal separation (in meters).\n\nThe difference between the WGS-84 Earth ellipsoid and the mean sea level (geoid).\n\nNegative values indicate that mean sea level is below the ellipsoid.\n\nThis value can be added to the elevation value to obtain the geoidal elevation.\n\n.. versionadded:: 3.18', 'speed': 'Ground speed, in km/h.', 'direction': 'The bearing measured in degrees clockwise from true north to the direction of travel.', 'satellitesInView': 'Contains a list of information relating to the current satellites in view.', 'pdop': 'Dilution of precision.', 'hdop': 'Horizontal dilution of precision.', 'vdop': 'Vertical dilution of precision.', 'hvacc': '3D RMS\n\n.. versionadded:: 3.18', 'utcTime': 'The time at which this position was reported, in UTC time.\n\n.. versionadded:: 3.30', 'utcDateTime': 'The date and time at which this position was reported, in UTC time.', 'fixMode': 'Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)', 'fixType': 'Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.constellationFixStatus` or :py:func:`~QgsGpsInformation.bestFixStatus` instead.', 'quality': 'GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)\n\n.. deprecated:: 3.40\n\n Use qualityIndicator instead.', 'qualityIndicator': 'Returns the signal quality indicator\n\n.. versionadded:: 3.22.6', 'satellitesUsed': 'Count of satellites used in obtaining the fix.', 'status': 'Status (A = active or V = void)', 'satPrn': 'IDs of satellites used in the position fix.', 'satInfoComplete': '``True`` if satellite information is complete.'} + QgsGpsInformation.__attribute_docs__ = {'latitude': 'Latitude in decimal degrees, using the WGS84 datum. A positive value indicates the Northern Hemisphere, and\na negative value indicates the Southern Hemisphere.', 'longitude': 'Longitude in decimal degrees, using the WGS84 datum. A positive value indicates the Eastern Hemisphere, and\na negative value indicates the Western Hemisphere.', 'elevation': 'Altitude (in meters) above or below the mean sea level.', 'elevation_diff': 'Geoidal separation (in meters).\n\nThe difference between the WGS-84 Earth ellipsoid and the mean sea level (geoid).\n\nNegative values indicate that mean sea level is below the ellipsoid.\n\nThis value can be added to the elevation value to obtain the geoidal elevation.\n\n.. versionadded:: 3.18', 'speed': 'Ground speed, in km/h.', 'direction': 'The bearing measured in degrees clockwise from true north to the direction of travel.', 'satellitesInView': 'Contains a list of information relating to the current satellites in view.', 'pdop': 'Dilution of precision.', 'hdop': 'Horizontal dilution of precision.', 'vdop': 'Vertical dilution of precision.', 'hvacc': '3D RMS\n\n.. versionadded:: 3.18', 'utcTime': 'The time at which this position was reported, in UTC time.\n\n.. versionadded:: 3.30', 'utcDateTime': 'The date and time at which this position was reported, in UTC time.', 'fixMode': 'Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)', 'fixType': 'Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.constellationFixStatus` or :py:func:`~QgsGpsInformation.bestFixStatus` instead.', 'quality': 'GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.qualityIndicator` instead.', 'qualityIndicator': 'Returns the signal quality indicator\n\n.. versionadded:: 3.22.6', 'satellitesUsed': 'Count of satellites used in obtaining the fix.', 'status': 'Status (A = active or V = void)', 'satPrn': 'IDs of satellites used in the position fix.', 'satInfoComplete': '``True`` if satellite information is complete.'} QgsGpsInformation.__group__ = ['gps'] except NameError: pass diff --git a/python/core/auto_generated/browser/qgsdataitem.sip.in b/python/core/auto_generated/browser/qgsdataitem.sip.in index 0ed4a79242f5..85203cae450f 100644 --- a/python/core/auto_generated/browser/qgsdataitem.sip.in +++ b/python/core/auto_generated/browser/qgsdataitem.sip.in @@ -292,7 +292,7 @@ Sets the capabilities for the data item. .. deprecated:: 3.40 - Use setCapabilitiesV2 instead. + Use :py:func:`~QgsDataItem.setCapabilitiesV2` instead. %End diff --git a/python/core/auto_generated/geometry/qgscircle.sip.in b/python/core/auto_generated/geometry/qgscircle.sip.in index 808e5c13d7a4..8cbcbb8a36f8 100644 --- a/python/core/auto_generated/geometry/qgscircle.sip.in +++ b/python/core/auto_generated/geometry/qgscircle.sip.in @@ -301,7 +301,7 @@ Returns the number of tangents (either 0 or 2). virtual void setSemiMajorAxis( double semiMajorAxis ) /HoldGIL/; %Docstring -Inherited method. Use setRadius instead. +Inherited method. Use :py:func:`~QgsCircle.setRadius` instead. .. seealso:: :py:func:`radius` @@ -311,7 +311,7 @@ Inherited method. Use setRadius instead. virtual void setSemiMinorAxis( double semiMinorAxis ) /HoldGIL/; %Docstring -Inherited method. Use setRadius instead. +Inherited method. Use :py:func:`~QgsCircle.setRadius` instead. .. seealso:: :py:func:`radius` diff --git a/python/core/auto_generated/geometry/qgslinestring.sip.in b/python/core/auto_generated/geometry/qgslinestring.sip.in index 647e37107336..624c294893ec 100644 --- a/python/core/auto_generated/geometry/qgslinestring.sip.in +++ b/python/core/auto_generated/geometry/qgslinestring.sip.in @@ -857,13 +857,14 @@ corresponds to the last point in the line. QgsBox3D calculateBoundingBox3d() const /Deprecated/; %Docstring Calculates the minimal 3D bounding box for the geometry. -Deprecated: use calculateBoundingBox3D instead .. seealso:: :py:func:`calculateBoundingBox` .. versionadded:: 3.26 .. deprecated:: 3.34 + + use :py:func:`~QgsLineString.calculateBoundingBox3D` instead %End virtual QgsBox3D calculateBoundingBox3D() const; diff --git a/python/core/auto_generated/project/qgsproject.sip.in b/python/core/auto_generated/project/qgsproject.sip.in index b1268483c092..62adc7817907 100644 --- a/python/core/auto_generated/project/qgsproject.sip.in +++ b/python/core/auto_generated/project/qgsproject.sip.in @@ -969,7 +969,7 @@ transaction. .. deprecated:: 3.26 - Use transactionMode instead. + Use :py:func:`~QgsProject.transactionMode` instead. %End void setAutoTransaction( bool autoTransaction ) /Deprecated/; @@ -984,7 +984,7 @@ transaction. .. deprecated:: 3.26 - Use setTransactionMode instead. + Use :py:func:`~QgsProject.setTransactionMode` instead. %End Qgis::TransactionMode transactionMode() const; diff --git a/python/core/auto_generated/qgsfeaturefiltermodel.sip.in b/python/core/auto_generated/qgsfeaturefiltermodel.sip.in index 401292276c75..e530ce27785a 100644 --- a/python/core/auto_generated/qgsfeaturefiltermodel.sip.in +++ b/python/core/auto_generated/qgsfeaturefiltermodel.sip.in @@ -33,7 +33,7 @@ If there are several identifier fields defined, the behavior is not guaranteed .. deprecated:: 3.10 - Use identifierFields instead. + Use :py:func:`~QgsFeatureFilterModel.identifierFields` instead. %End QStringList identifierFields() const; diff --git a/python/core/auto_generated/qgsmaptopixel.sip.in b/python/core/auto_generated/qgsmaptopixel.sip.in index 8f90d4c4a14e..1dbf008a8d2f 100644 --- a/python/core/auto_generated/qgsmaptopixel.sip.in +++ b/python/core/auto_generated/qgsmaptopixel.sip.in @@ -137,7 +137,7 @@ Transforms device coordinates to map (world) coordinates. .. deprecated:: 3.4 - Use toMapCoordinates instead. + Use :py:func:`~QgsMapToPixel.toMapCoordinates` instead. %End void setMapUnitsPerPixel( double mapUnitsPerPixel ); diff --git a/python/core/auto_generated/qgsvectorfilewriter.sip.in b/python/core/auto_generated/qgsvectorfilewriter.sip.in index b21aa4bead04..8e9a1f575485 100644 --- a/python/core/auto_generated/qgsvectorfilewriter.sip.in +++ b/python/core/auto_generated/qgsvectorfilewriter.sip.in @@ -485,7 +485,7 @@ Writes a layer out to a vector file. .. deprecated:: 3.20 - Use writeAsVectorFormatV3 instead. + Use :py:func:`~QgsVectorFileWriter.writeAsVectorFormatV3` instead. %End static QgsVectorFileWriter::WriterError writeAsVectorFormatV3( QgsVectorLayer *layer, diff --git a/python/core/auto_generated/settings/qgssettingsentry.sip.in b/python/core/auto_generated/settings/qgssettingsentry.sip.in index 799eb876ed5b..e8db91c3813f 100644 --- a/python/core/auto_generated/settings/qgssettingsentry.sip.in +++ b/python/core/auto_generated/settings/qgssettingsentry.sip.in @@ -252,7 +252,7 @@ Returns settings value with an optional default value override .. deprecated:: 3.26 - Use valueAsVariantWithDefaultOverride instead. + Use :py:func:`~QgsSettingsEntryBase.valueAsVariantWithDefaultOverride` instead. %End QVariant valueAsVariant( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const /Deprecated/; @@ -261,7 +261,7 @@ Returns settings value with an optional default value override .. deprecated:: 3.26 - Use valueAsVariantWithDefaultOverride instead. + Use :py:func:`~QgsSettingsEntryBase.valueAsVariantWithDefaultOverride` instead. %End diff --git a/python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in b/python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in index 2f3ea299ede1..fb3de728b77b 100644 --- a/python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in +++ b/python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in @@ -156,14 +156,14 @@ This will take ownership of the method .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End void setMode( Mode mode ) /Deprecated/; %Docstring .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End bool useSymmetricMode() const /Deprecated/; @@ -174,7 +174,7 @@ Returns if we want to classify symmetric around a given value .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End void setUseSymmetricMode( bool useSymmetricMode ) /Deprecated/; @@ -185,7 +185,7 @@ Set if we want to classify symmetric around a given value .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End double symmetryPoint() const /Deprecated/; @@ -196,7 +196,7 @@ Returns the pivot value for symmetric classification .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End void setSymmetryPoint( double symmetryPoint ) /Deprecated/; @@ -207,7 +207,7 @@ Set the pivot point .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End @@ -219,7 +219,7 @@ Returns if we want to have a central class astride the pivot value .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End void setAstride( bool astride ) /Deprecated/; @@ -230,7 +230,7 @@ Set if we want a central class astride the pivot value .. deprecated:: 3.10 - Use classficationMethod instead. + Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead. %End static void makeBreaksSymmetric( QList &breaks /In,Out/, double symmetryPoint, bool astride ) /Deprecated/; diff --git a/python/core/auto_generated/symbology/qgssymbol.sip.in b/python/core/auto_generated/symbology/qgssymbol.sip.in index ad492e708570..8f40a0557c78 100644 --- a/python/core/auto_generated/symbology/qgssymbol.sip.in +++ b/python/core/auto_generated/symbology/qgssymbol.sip.in @@ -534,7 +534,7 @@ Returns a large (roughly 100x100 pixel) preview image for the symbol. .. deprecated:: 3.40 - Use bigSymbolPreviewImageV2 instead. + Use :py:func:`~QgsSymbol.bigSymbolPreviewImageV2` instead. %End QString dump() const; diff --git a/python/core/auto_generated/symbology/qgssymbollayerreference.sip.in b/python/core/auto_generated/symbology/qgssymbollayerreference.sip.in index a38a13fe0a42..f1094ec90b42 100644 --- a/python/core/auto_generated/symbology/qgssymbollayerreference.sip.in +++ b/python/core/auto_generated/symbology/qgssymbollayerreference.sip.in @@ -136,7 +136,7 @@ The symbol layer's id .. deprecated:: 3.30 - Use symbolLayerIdV2 instead. + Use :py:func:`~QgsSymbolLayerReference.symbolLayerIdV2` instead. %End QString symbolLayerIdV2() const; diff --git a/python/core/auto_generated/vector/qgsvectordataprovider.sip.in b/python/core/auto_generated/vector/qgsvectordataprovider.sip.in index 3e4129505a5e..686403ef79ed 100644 --- a/python/core/auto_generated/vector/qgsvectordataprovider.sip.in +++ b/python/core/auto_generated/vector/qgsvectordataprovider.sip.in @@ -562,7 +562,7 @@ Returns the transaction this data provider is included in, if any. .. deprecated:: 3.12 - Will be removed in QGIS 4.0 - use reloadData instead. + Will be removed in QGIS 4.0 - use :py:func:`~QgsVectorDataProvider.reloadData` instead. %End virtual QSet dependencies() const; diff --git a/python/core/auto_generated/vector/qgsvectorlayer.sip.in b/python/core/auto_generated/vector/qgsvectorlayer.sip.in index 01a8fc1c864c..cbcccf086af2 100644 --- a/python/core/auto_generated/vector/qgsvectorlayer.sip.in +++ b/python/core/auto_generated/vector/qgsvectorlayer.sip.in @@ -1968,7 +1968,7 @@ A set of attributes that are not advertised in WMS requests with QGIS server. .. deprecated:: 3.16 - Use setFieldConfigurationFlag instead. + Use :py:func:`~QgsVectorLayer.setFieldConfigurationFlag` instead. %End QSet excludeAttributesWfs() const /Deprecated/; @@ -1986,7 +1986,7 @@ A set of attributes that are not advertised in WFS requests with QGIS server. .. deprecated:: 3.16 - Use setFieldConfigurationFlag instead. + Use :py:func:`~QgsVectorLayer.setFieldConfigurationFlag` instead. %End virtual bool deleteAttribute( int attr ); diff --git a/python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py b/python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py index e1862d77fa5e..8b5c5e5ca06f 100644 --- a/python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py +++ b/python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py @@ -2,7 +2,7 @@ QgsAdvancedDigitizingDockWidget.CadCapacities.baseClass = QgsAdvancedDigitizingDockWidget CadCapacities = QgsAdvancedDigitizingDockWidget # dirty hack since SIP seems to introduce the flags in module try: - QgsAdvancedDigitizingDockWidget.__attribute_docs__ = {'pushWarning': 'Push a warning\n\n:param message: An informative message\n', 'popWarning': 'Remove any previously emitted warnings (if any)\n', 'pointChangedV2': 'Sometimes a constraint may change the current point out of a mouse event. This happens normally\nwhen a constraint is toggled.\n\n:param point: The last known digitizing point. Can be used to emulate a mouse event.\n\n.. versionadded:: 3.22\n', 'pointChanged': 'Sometimes a constraint may change the current point out of a mouse event. This happens normally\nwhen a constraint is toggled.\n\n:param point: The last known digitizing point. Can be used to emulate a mouse event.\n\n.. deprecated:: 3.22\n\n No longer used, will be removed in QGIS 4.0. Use pointChangedV2 instead.\n', 'cadEnabledChanged': 'Emitted whenever CAD is enabled or disabled\n\n:param enabled: Whether CAD is enabled or not\n\n.. note::\n\n unstable API (will likely change).\n\n.. versionadded:: 3.8\n', 'valueXChanged': 'Emitted whenever the X ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueYChanged': 'Emitted whenever the Y ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueZChanged': 'Emitted whenever the Z ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'valueMChanged': 'Emitted whenever the M ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'valueAngleChanged': 'Emitted whenever the angle ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueDistanceChanged': 'Emitted whenever the distance ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueBearingChanged': 'Emitted whenever the bearing ``value`` changes.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.32\n', 'lockXChanged': 'Emitted whenever the X parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockYChanged': 'Emitted whenever the Y parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockZChanged': 'Emitted whenever the Z parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'lockMChanged': 'Emitted whenever the M parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'lockAngleChanged': 'Emitted whenever the angle parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockDistanceChanged': 'Emitted whenever the distance parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeXChanged': 'Emitted whenever the X parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the X parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeYChanged': 'Emitted whenever the Y parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the Y parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeZChanged': 'Emitted whenever the Z parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the Z parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'relativeMChanged': 'Emitted whenever the M parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the M parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'relativeAngleChanged': 'Emitted whenever the angleX parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the angle parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'softLockLineExtensionChanged': 'Emitted whenever the soft line extension parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.26\n', 'softLockXyChanged': 'Emitted whenever the soft x/y extension parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.26\n', 'enabledChangedX': 'Emitted whenever the X field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the X parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedY': 'Emitted whenever the Y field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the Y parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedZ': 'Emitted whenever the Z field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the Z parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'enabledChangedM': 'Emitted whenever the M field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the M parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'enabledChangedAngle': 'Emitted whenever the angle field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the angle parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedDistance': 'Emitted whenever the distance field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the distance parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnXRequested': 'Emitted whenever the X field should get the focus using the shortcuts (X).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnYRequested': 'Emitted whenever the Y field should get the focus using the shortcuts (Y).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnZRequested': 'Emitted whenever the Z field should get the focus using the shortcuts (Z).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'focusOnMRequested': 'Emitted whenever the M field should get the focus using the shortcuts (M).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'focusOnAngleRequested': 'Emitted whenever the angle field should get the focus using the shortcuts (A).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnDistanceRequested': 'Emitted whenever the distance field should get the focus using the shortcuts (D).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueCommonAngleSnappingChanged': 'Emitted whenever the snapping to common angle option changes, angle = 0 means that the functionality is disabled.\n\n.. versionadded:: 3.32\n'} + QgsAdvancedDigitizingDockWidget.__attribute_docs__ = {'pushWarning': 'Push a warning\n\n:param message: An informative message\n', 'popWarning': 'Remove any previously emitted warnings (if any)\n', 'pointChangedV2': 'Sometimes a constraint may change the current point out of a mouse event. This happens normally\nwhen a constraint is toggled.\n\n:param point: The last known digitizing point. Can be used to emulate a mouse event.\n\n.. versionadded:: 3.22\n', 'pointChanged': 'Sometimes a constraint may change the current point out of a mouse event. This happens normally\nwhen a constraint is toggled.\n\n:param point: The last known digitizing point. Can be used to emulate a mouse event.\n\n.. deprecated:: 3.22\n\n No longer used, will be removed in QGIS 4.0. Use :py:func:`~QgsAdvancedDigitizingDockWidget.pointChangedV2` instead.\n', 'cadEnabledChanged': 'Emitted whenever CAD is enabled or disabled\n\n:param enabled: Whether CAD is enabled or not\n\n.. note::\n\n unstable API (will likely change).\n\n.. versionadded:: 3.8\n', 'valueXChanged': 'Emitted whenever the X ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueYChanged': 'Emitted whenever the Y ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueZChanged': 'Emitted whenever the Z ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'valueMChanged': 'Emitted whenever the M ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'valueAngleChanged': 'Emitted whenever the angle ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueDistanceChanged': 'Emitted whenever the distance ``value`` changes (either the mouse moved, or the user changed the input).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueBearingChanged': 'Emitted whenever the bearing ``value`` changes.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.32\n', 'lockXChanged': 'Emitted whenever the X parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockYChanged': 'Emitted whenever the Y parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockZChanged': 'Emitted whenever the Z parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'lockMChanged': 'Emitted whenever the M parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'lockAngleChanged': 'Emitted whenever the angle parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'lockDistanceChanged': 'Emitted whenever the distance parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeXChanged': 'Emitted whenever the X parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the X parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeYChanged': 'Emitted whenever the Y parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the Y parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'relativeZChanged': 'Emitted whenever the Z parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the Z parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'relativeMChanged': 'Emitted whenever the M parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the M parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'relativeAngleChanged': 'Emitted whenever the angleX parameter is toggled between absolute and relative.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param relative: Whether the angle parameter is relative or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'softLockLineExtensionChanged': 'Emitted whenever the soft line extension parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.26\n', 'softLockXyChanged': 'Emitted whenever the soft x/y extension parameter is ``locked``.\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.26\n', 'enabledChangedX': 'Emitted whenever the X field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the X parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedY': 'Emitted whenever the Y field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the Y parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedZ': 'Emitted whenever the Z field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the Z parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'enabledChangedM': 'Emitted whenever the M field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the M parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'enabledChangedAngle': 'Emitted whenever the angle field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the angle parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'enabledChangedDistance': 'Emitted whenever the distance field is enabled or disabled. Depending on the context, some parameters\ndo not make sense (e.g. you need a previous point to define a distance).\nCould be used by widgets that must reflect the current advanced digitizing state.\n\n:param enabled: Whether the distance parameter is enabled or not.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnXRequested': 'Emitted whenever the X field should get the focus using the shortcuts (X).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnYRequested': 'Emitted whenever the Y field should get the focus using the shortcuts (Y).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnZRequested': 'Emitted whenever the Z field should get the focus using the shortcuts (Z).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'focusOnMRequested': 'Emitted whenever the M field should get the focus using the shortcuts (M).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.22\n', 'focusOnAngleRequested': 'Emitted whenever the angle field should get the focus using the shortcuts (A).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'focusOnDistanceRequested': 'Emitted whenever the distance field should get the focus using the shortcuts (D).\nCould be used by widgets to capture the focus when a field is being edited.\n\n.. note::\n\n unstable API (will likely change)\n\n.. versionadded:: 3.8\n', 'valueCommonAngleSnappingChanged': 'Emitted whenever the snapping to common angle option changes, angle = 0 means that the functionality is disabled.\n\n.. versionadded:: 3.32\n'} QgsAdvancedDigitizingDockWidget.__signal_arguments__ = {'pushWarning': ['message: str'], 'pointChangedV2': ['point: QgsPoint'], 'cadEnabledChanged': ['enabled: bool'], 'valueXChanged': ['value: str'], 'valueYChanged': ['value: str'], 'valueZChanged': ['value: str'], 'valueMChanged': ['value: str'], 'valueAngleChanged': ['value: str'], 'valueDistanceChanged': ['value: str'], 'valueBearingChanged': ['value: str'], 'lockXChanged': ['locked: bool'], 'lockYChanged': ['locked: bool'], 'lockZChanged': ['locked: bool'], 'lockMChanged': ['locked: bool'], 'lockAngleChanged': ['locked: bool'], 'lockDistanceChanged': ['locked: bool'], 'relativeXChanged': ['relative: bool'], 'relativeYChanged': ['relative: bool'], 'relativeZChanged': ['relative: bool'], 'relativeMChanged': ['relative: bool'], 'relativeAngleChanged': ['relative: bool'], 'softLockLineExtensionChanged': ['locked: bool'], 'softLockXyChanged': ['locked: bool'], 'enabledChangedX': ['enabled: bool'], 'enabledChangedY': ['enabled: bool'], 'enabledChangedZ': ['enabled: bool'], 'enabledChangedM': ['enabled: bool'], 'enabledChangedAngle': ['enabled: bool'], 'enabledChangedDistance': ['enabled: bool'], 'valueCommonAngleSnappingChanged': ['angle: float']} except NameError: pass diff --git a/python/gui/auto_additions/qgsattributeformeditorwidget.py b/python/gui/auto_additions/qgsattributeformeditorwidget.py index 5cc53cfe6ce1..c9801be0d202 100644 --- a/python/gui/auto_additions/qgsattributeformeditorwidget.py +++ b/python/gui/auto_additions/qgsattributeformeditorwidget.py @@ -1,6 +1,6 @@ # The following has been generated automatically from src/gui/qgsattributeformeditorwidget.h try: - QgsAttributeFormEditorWidget.__attribute_docs__ = {'valueChanged': "Emitted when the widget's value changes\n\n:param value: new widget value\n\n.. deprecated:: 3.10\n\n Use valuesChanged instead.\n", 'valuesChanged': "Emitted when the widget's value changes\n\n:param value: new widget value\n:param additionalFieldValues: of the potential additional fields\n\n.. versionadded:: 3.10\n"} + QgsAttributeFormEditorWidget.__attribute_docs__ = {'valueChanged': "Emitted when the widget's value changes\n\n:param value: new widget value\n\n.. deprecated:: 3.10\n\n Use :py:func:`~QgsAttributeFormEditorWidget.valuesChanged` instead.\n", 'valuesChanged': "Emitted when the widget's value changes\n\n:param value: new widget value\n:param additionalFieldValues: of the potential additional fields\n\n.. versionadded:: 3.10\n"} QgsAttributeFormEditorWidget.__signal_arguments__ = {'valueChanged': ['value: object'], 'valuesChanged': ['value: object', 'additionalFieldValues: List[object]']} except NameError: pass diff --git a/python/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in b/python/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in index f8d51b8d8317..aadac8e0269d 100644 --- a/python/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in +++ b/python/gui/auto_generated/qgsadvanceddigitizingdockwidget.sip.in @@ -715,7 +715,7 @@ when a constraint is toggled. .. deprecated:: 3.22 - No longer used, will be removed in QGIS 4.0. Use pointChangedV2 instead. + No longer used, will be removed in QGIS 4.0. Use :py:func:`~QgsAdvancedDigitizingDockWidget.pointChangedV2` instead. %End diff --git a/python/gui/auto_generated/qgsattributeformeditorwidget.sip.in b/python/gui/auto_generated/qgsattributeformeditorwidget.sip.in index a093beeaa786..6a1a9e67e5c2 100644 --- a/python/gui/auto_generated/qgsattributeformeditorwidget.sip.in +++ b/python/gui/auto_generated/qgsattributeformeditorwidget.sip.in @@ -101,7 +101,7 @@ Emitted when the widget's value changes .. deprecated:: 3.10 - Use valuesChanged instead. + Use :py:func:`~QgsAttributeFormEditorWidget.valuesChanged` instead. %End void valuesChanged( const QVariant &value, const QVariantList &additionalFieldValues ); diff --git a/python/gui/auto_generated/qgshttpheaderwidget.sip.in b/python/gui/auto_generated/qgshttpheaderwidget.sip.in index 3ab60fa8657a..332cebf231e5 100644 --- a/python/gui/auto_generated/qgshttpheaderwidget.sip.in +++ b/python/gui/auto_generated/qgshttpheaderwidget.sip.in @@ -55,7 +55,7 @@ fill the inner header map from the settings defined at ``key`` .. deprecated:: 3.30 - Use setFromHeaders instead. + Use :py:func:`~QgsHttpHeaderWidget.setFromHeaders` instead. %End void updateSettings( QgsSettings &settings, const QString &key ) const /Deprecated/; diff --git a/src/core/browser/qgsdataitem.h b/src/core/browser/qgsdataitem.h index 4800b9bb75f4..48bc8893a03a 100644 --- a/src/core/browser/qgsdataitem.h +++ b/src/core/browser/qgsdataitem.h @@ -304,7 +304,7 @@ class CORE_EXPORT QgsDataItem : public QObject virtual void setCapabilities( Qgis::BrowserItemCapabilities capabilities ) SIP_PYNAME( setCapabilitiesV2 ) { mCapabilities = capabilities; } /** - * \deprecated QGIS 3.40. Use setCapabilitiesV2 instead. + * \deprecated QGIS 3.40. Use setCapabilitiesV2() instead. */ Q_DECL_DEPRECATED void setCapabilities( int capabilities ) SIP_DEPRECATED; diff --git a/src/core/geometry/qgscircle.h b/src/core/geometry/qgscircle.h index a069e0b489b3..4ce628edc39e 100644 --- a/src/core/geometry/qgscircle.h +++ b/src/core/geometry/qgscircle.h @@ -293,14 +293,14 @@ class CORE_EXPORT QgsCircle : public QgsEllipse /** - * Inherited method. Use setRadius instead. + * Inherited method. Use setRadius() instead. * \see radius() * \see setRadius() */ void setSemiMajorAxis( double semiMajorAxis ) override SIP_HOLDGIL; /** - * Inherited method. Use setRadius instead. + * Inherited method. Use setRadius() instead. * \see radius() * \see setRadius() */ diff --git a/src/core/geometry/qgslinestring.h b/src/core/geometry/qgslinestring.h index 1e222e7de309..dff5b5e37b8e 100644 --- a/src/core/geometry/qgslinestring.h +++ b/src/core/geometry/qgslinestring.h @@ -1184,10 +1184,9 @@ class CORE_EXPORT QgsLineString: public QgsCurve /** * Calculates the minimal 3D bounding box for the geometry. - * Deprecated: use calculateBoundingBox3D instead * \see calculateBoundingBox() * \since QGIS 3.26 - * \deprecated QGIS 3.34 + * \deprecated QGIS 3.34 use calculateBoundingBox3D() instead */ Q_DECL_DEPRECATED QgsBox3D calculateBoundingBox3d() const SIP_DEPRECATED; diff --git a/src/core/gps/qgsgpsinformation.h b/src/core/gps/qgsgpsinformation.h index 6cb0bf5885c0..5db7f3cad4f5 100644 --- a/src/core/gps/qgsgpsinformation.h +++ b/src/core/gps/qgsgpsinformation.h @@ -171,7 +171,7 @@ class CORE_EXPORT QgsGpsInformation /** * GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.) - * \deprecated QGIS 3.40. Use qualityIndicator instead. + * \deprecated QGIS 3.40. Use qualityIndicator() instead. */ int quality = -1; diff --git a/src/core/project/qgsproject.h b/src/core/project/qgsproject.h index 446d51870b8b..d7baf4a7379c 100644 --- a/src/core/project/qgsproject.h +++ b/src/core/project/qgsproject.h @@ -1022,7 +1022,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * all tables that originate from the same database are synchronized and executed in a server side * transaction. * - * \deprecated QGIS 3.26. Use transactionMode instead. + * \deprecated QGIS 3.26. Use transactionMode() instead. */ Q_DECL_DEPRECATED bool autoTransaction() const SIP_DEPRECATED; @@ -1033,7 +1033,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * * \warning Make sure that this is only called when all layers are not in edit mode. * - * \deprecated QGIS 3.26. Use setTransactionMode instead. + * \deprecated QGIS 3.26. Use setTransactionMode() instead. */ Q_DECL_DEPRECATED void setAutoTransaction( bool autoTransaction ) SIP_DEPRECATED; diff --git a/src/core/qgscadutils.h b/src/core/qgscadutils.h index ac577cd697e6..5db052b192cb 100644 --- a/src/core/qgscadutils.h +++ b/src/core/qgscadutils.h @@ -80,7 +80,7 @@ class CORE_EXPORT QgsCadUtils /** * Snapped segment - only valid if actually used for something - * \deprecated QGIS 3.40. Will be removed in QGIS 4.0 - use snapMatch instead. + * \deprecated QGIS 3.40. Will be removed in QGIS 4.0 - use snapMatch() instead. */ QgsPointLocator::Match edgeMatch; diff --git a/src/core/qgsfeaturefiltermodel.h b/src/core/qgsfeaturefiltermodel.h index 17e9a0525050..69014c598c8e 100644 --- a/src/core/qgsfeaturefiltermodel.h +++ b/src/core/qgsfeaturefiltermodel.h @@ -51,7 +51,7 @@ class CORE_EXPORT QgsFeatureFilterModel : public QgsFeaturePickerModelBase * The identifier field should be a unique field that can be used to identify individual features. * It is normally set to the primary key of the layer. * If there are several identifier fields defined, the behavior is not guaranteed - * \deprecated QGIS 3.10. Use identifierFields instead. + * \deprecated QGIS 3.10. Use identifierFields() instead. */ Q_DECL_DEPRECATED QString identifierField() const; diff --git a/src/core/qgsmaptopixel.h b/src/core/qgsmaptopixel.h index 94ea9c9db8e5..d5b15a015df6 100644 --- a/src/core/qgsmaptopixel.h +++ b/src/core/qgsmaptopixel.h @@ -232,7 +232,7 @@ class CORE_EXPORT QgsMapToPixel /** * Transforms device coordinates to map (world) coordinates. * - * \deprecated QGIS 3.4. Use toMapCoordinates instead. + * \deprecated QGIS 3.4. Use toMapCoordinates() instead. */ Q_DECL_DEPRECATED QgsPointXY toMapPoint( double x, double y ) const SIP_DEPRECATED { diff --git a/src/core/qgsvectorfilewriter.h b/src/core/qgsvectorfilewriter.h index ae21bf4b336c..61d05a65b7bc 100644 --- a/src/core/qgsvectorfilewriter.h +++ b/src/core/qgsvectorfilewriter.h @@ -710,7 +710,7 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink * \param newLayer potentially modified layer name (output parameter) * \param errorMessage will be set to the error message text, if an error occurs while writing the layer * \returns Error message code, or QgsVectorFileWriter.NoError if the write operation was successful - * \deprecated QGIS 3.20. Use writeAsVectorFormatV3 instead. + * \deprecated QGIS 3.20. Use writeAsVectorFormatV3() instead. */ Q_DECL_DEPRECATED static QgsVectorFileWriter::WriterError writeAsVectorFormatV2( QgsVectorLayer *layer, const QString &fileName, diff --git a/src/core/settings/qgssettingsentry.h b/src/core/settings/qgssettingsentry.h index fd6d57b383a5..3b5d800ea834 100644 --- a/src/core/settings/qgssettingsentry.h +++ b/src/core/settings/qgssettingsentry.h @@ -254,13 +254,13 @@ class CORE_EXPORT QgsSettingsEntryBase /** * Returns settings value with an optional default value override - * \deprecated QGIS 3.26. Use valueAsVariantWithDefaultOverride instead. + * \deprecated QGIS 3.26. Use valueAsVariantWithDefaultOverride() instead. */ Q_DECL_DEPRECATED QVariant valueAsVariant( const QString &dynamicKeyPart, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const SIP_DEPRECATED; /** * Returns settings value with an optional default value override - * \deprecated QGIS 3.26. Use valueAsVariantWithDefaultOverride instead. + * \deprecated QGIS 3.26. Use valueAsVariantWithDefaultOverride() instead. */ Q_DECL_DEPRECATED QVariant valueAsVariant( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const SIP_DEPRECATED; diff --git a/src/core/symbology/qgsgraduatedsymbolrenderer.h b/src/core/symbology/qgsgraduatedsymbolrenderer.h index 461497be5340..417fb934f602 100644 --- a/src/core/symbology/qgsgraduatedsymbolrenderer.h +++ b/src/core/symbology/qgsgraduatedsymbolrenderer.h @@ -147,36 +147,36 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer // might be fixed in newer Doxygen (does not on 1.8.13, might be ok on 1.8.16) - //! \deprecated QGIS 3.10. Use classficationMethod instead. + //! \deprecated QGIS 3.10. Use classficationMethod() instead. Q_DECL_DEPRECATED Mode mode() const SIP_DEPRECATED { return modeFromMethodId( mClassificationMethod->id() ); } - //! \deprecated QGIS 3.10. Use classficationMethod instead. + //! \deprecated QGIS 3.10. Use classficationMethod() instead. Q_DECL_DEPRECATED void setMode( Mode mode ) SIP_DEPRECATED; /** * Returns if we want to classify symmetric around a given value * \since QGIS 3.4 - * \deprecated QGIS 3.10. Use classficationMethod instead. + * \deprecated QGIS 3.10. Use classficationMethod() instead. */ Q_DECL_DEPRECATED bool useSymmetricMode() const SIP_DEPRECATED { return mClassificationMethod->symmetricModeEnabled(); } /** * Set if we want to classify symmetric around a given value * \since QGIS 3.4 - * \deprecated QGIS 3.10. Use classficationMethod instead. + * \deprecated QGIS 3.10. Use classficationMethod() instead. */ Q_DECL_DEPRECATED void setUseSymmetricMode( bool useSymmetricMode ) SIP_DEPRECATED; /** * Returns the pivot value for symmetric classification * \since QGIS 3.4 - * \deprecated QGIS 3.10. Use classficationMethod instead. + * \deprecated QGIS 3.10. Use classficationMethod() instead. */ Q_DECL_DEPRECATED double symmetryPoint() const SIP_DEPRECATED { return mClassificationMethod->symmetryPoint(); } /** * Set the pivot point * \since QGIS 3.4 - * \deprecated QGIS 3.10. Use classficationMethod instead. + * \deprecated QGIS 3.10. Use classficationMethod() instead. */ Q_DECL_DEPRECATED void setSymmetryPoint( double symmetryPoint ) SIP_DEPRECATED; @@ -184,14 +184,14 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer /** * Returns if we want to have a central class astride the pivot value * \since QGIS 3.4 - * \deprecated QGIS 3.10. Use classficationMethod instead. + * \deprecated QGIS 3.10. Use classficationMethod() instead. */ Q_DECL_DEPRECATED bool astride() const SIP_DEPRECATED { return mClassificationMethod->symmetryAstride(); } /** * Set if we want a central class astride the pivot value * \since QGIS 3.4 - * \deprecated QGIS 3.10. Use classficationMethod instead. + * \deprecated QGIS 3.10. Use classficationMethod() instead. */ Q_DECL_DEPRECATED void setAstride( bool astride ) SIP_DEPRECATED; diff --git a/src/core/symbology/qgssymbol.h b/src/core/symbology/qgssymbol.h index 8007a43876c9..06fbc9a6945e 100644 --- a/src/core/symbology/qgssymbol.h +++ b/src/core/symbology/qgssymbol.h @@ -555,7 +555,7 @@ class CORE_EXPORT QgsSymbol QImage bigSymbolPreviewImage( QgsExpressionContext *expressionContext = nullptr, Qgis::SymbolPreviewFlags flags = Qgis::SymbolPreviewFlag::FlagIncludeCrosshairsForMarkerSymbols, const QgsScreenProperties &screen = QgsScreenProperties() ) SIP_PYNAME( bigSymbolPreviewImageV2 ); /** - * \deprecated QGIS 3.40. Use bigSymbolPreviewImageV2 instead. + * \deprecated QGIS 3.40. Use bigSymbolPreviewImageV2() instead. */ Q_DECL_DEPRECATED QImage bigSymbolPreviewImage( QgsExpressionContext *expressionContext = nullptr, int flags = static_cast< int >( Qgis::SymbolPreviewFlag::FlagIncludeCrosshairsForMarkerSymbols ) ) SIP_DEPRECATED; diff --git a/src/core/symbology/qgssymbollayerreference.h b/src/core/symbology/qgssymbollayerreference.h index 4cfc1adb5f6b..34f092707a8b 100644 --- a/src/core/symbology/qgssymbollayerreference.h +++ b/src/core/symbology/qgssymbollayerreference.h @@ -163,7 +163,7 @@ class CORE_EXPORT QgsSymbolLayerReference /** * The symbol layer's id - * \deprecated QGIS 3.30. Use symbolLayerIdV2 instead. + * \deprecated QGIS 3.30. Use symbolLayerIdV2() instead. */ Q_DECL_DEPRECATED QgsSymbolLayerId symbolLayerId() const SIP_DEPRECATED { return mDeprecatedSymbolLayerId; } diff --git a/src/core/vector/qgsvectordataprovider.h b/src/core/vector/qgsvectordataprovider.h index ae368f56cf2c..d3b1d60aadb4 100644 --- a/src/core/vector/qgsvectordataprovider.h +++ b/src/core/vector/qgsvectordataprovider.h @@ -552,7 +552,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider, public QgsFeat virtual QgsTransaction *transaction() const; /** - * \deprecated QGIS 3.12. Will be removed in QGIS 4.0 - use reloadData instead. + * \deprecated QGIS 3.12. Will be removed in QGIS 4.0 - use reloadData() instead. */ Q_DECL_DEPRECATED virtual void forceReload() SIP_DEPRECATED { reloadData(); } diff --git a/src/core/vector/qgsvectorlayer.h b/src/core/vector/qgsvectorlayer.h index d657931a4d4e..9e871b6ae870 100644 --- a/src/core/vector/qgsvectorlayer.h +++ b/src/core/vector/qgsvectorlayer.h @@ -1902,7 +1902,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * A set of attributes that are not advertised in WMS requests with QGIS server. - * \deprecated QGIS 3.16. Use setFieldConfigurationFlag instead. + * \deprecated QGIS 3.16. Use setFieldConfigurationFlag() instead. */ Q_DECL_DEPRECATED void setExcludeAttributesWms( const QSet &att ) SIP_DEPRECATED; @@ -1914,7 +1914,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * A set of attributes that are not advertised in WFS requests with QGIS server. - * \deprecated QGIS 3.16. Use setFieldConfigurationFlag instead. + * \deprecated QGIS 3.16. Use setFieldConfigurationFlag() instead. */ Q_DECL_DEPRECATED void setExcludeAttributesWfs( const QSet &att ) SIP_DEPRECATED; diff --git a/src/gui/layertree/qgslayertreemapcanvasbridge.h b/src/gui/layertree/qgslayertreemapcanvasbridge.h index 9e5255290913..2329d0bd7d63 100644 --- a/src/gui/layertree/qgslayertreemapcanvasbridge.h +++ b/src/gui/layertree/qgslayertreemapcanvasbridge.h @@ -64,7 +64,7 @@ class GUI_EXPORT QgsLayerTreeMapCanvasBridge : public QObject /** * Associates overview canvas with the bridge, so the overview will be updated whenever main canvas is updated - * \deprecated QGIS 3.40. Use setOverviewCanvas instead. + * \deprecated QGIS 3.40. Use setOverviewCanvas() instead. */ void setOvervewCanvas( QgsMapOverviewCanvas *overviewCanvas ) SIP_DEPRECATED; // TODO QGIS 4.0 remove % MethodCode diff --git a/src/gui/qgsadvanceddigitizingdockwidget.h b/src/gui/qgsadvanceddigitizingdockwidget.h index 46306de5fe00..fa305cee8732 100644 --- a/src/gui/qgsadvanceddigitizingdockwidget.h +++ b/src/gui/qgsadvanceddigitizingdockwidget.h @@ -667,7 +667,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private * when a constraint is toggled. * * \param point The last known digitizing point. Can be used to emulate a mouse event. - * \deprecated QGIS 3.22. No longer used, will be removed in QGIS 4.0. Use pointChangedV2 instead. + * \deprecated QGIS 3.22. No longer used, will be removed in QGIS 4.0. Use pointChangedV2() instead. */ Q_DECL_DEPRECATED void pointChanged( const QgsPointXY &point ) SIP_DEPRECATED; diff --git a/src/gui/qgsattributeformeditorwidget.h b/src/gui/qgsattributeformeditorwidget.h index ca60eb5384ef..586371bcc7f3 100644 --- a/src/gui/qgsattributeformeditorwidget.h +++ b/src/gui/qgsattributeformeditorwidget.h @@ -111,7 +111,7 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QgsAttributeFormWidget /** * Emitted when the widget's value changes * \param value new widget value - * \deprecated QGIS 3.10. Use valuesChanged instead. + * \deprecated QGIS 3.10. Use valuesChanged() instead. */ Q_DECL_DEPRECATED void valueChanged( const QVariant &value ); diff --git a/src/gui/qgshttpheaderwidget.h b/src/gui/qgshttpheaderwidget.h index b0a136d537f9..acd555fd68b2 100644 --- a/src/gui/qgshttpheaderwidget.h +++ b/src/gui/qgshttpheaderwidget.h @@ -62,7 +62,7 @@ class GUI_EXPORT QgsHttpHeaderWidget : public QWidget, private Ui::QgsHttpHeader * \see QgsHttpHeaders::setFromSettings() * \param settings * \param key - * \deprecated QGIS 3.30. Use setFromHeaders instead. + * \deprecated QGIS 3.30. Use setFromHeaders() instead. */ Q_DECL_DEPRECATED void setFromSettings( const QgsSettings &settings, const QString &key ) SIP_DEPRECATED; diff --git a/src/gui/settings/qgssettingstreemodel.h b/src/gui/settings/qgssettingstreemodel.h index bae599450213..545997d2c6b7 100644 --- a/src/gui/settings/qgssettingstreemodel.h +++ b/src/gui/settings/qgssettingstreemodel.h @@ -103,7 +103,7 @@ class GUI_EXPORT QgsSettingsTreeModelNodeData : public QObject const QgsSettingsEntryBase *setting() const {return mSetting;} private: - //! Private constructor, use createRootNodeData instead + //! Private constructor, use createRootNodeData() instead QgsSettingsTreeModelNodeData( QObject *parent ) : QObject( parent ) {} void addChildForTreeNode( const QgsSettingsTreeNode *node ); void addChildForNamedListItemNode( const QString &item, const QgsSettingsTreeNamedListNode *namedListNode );