sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-03-04 00:30:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #32258 from 3nids/pyqgis_deprecated

Browse Source 
[sipify] correctly output deprecation
This commit is contained in:
Denis Rouzaud 2019-10-15 14:43:05 +02:00 committed by GitHub
commit 6297da3d11
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
62 changed files with 327 additions and 170 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
python/analysis/auto_generated/raster/qgsrastercalculator.sip.in
View File

@ -120,7 +120,8 @@ QgsRasterCalculator constructor.
:param nOutputRows: number of rows in output raster
:param rasterEntries: list of referenced raster layers
.. deprecated:: since QGIS 3.8, use the version with transformContext instead
.. deprecated:: QGIS 3.8
use the version with transformContext instead
%End
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat,
@ -137,7 +138,8 @@ QgsRasterCalculator constructor.
:param nOutputRows: number of rows in output raster
:param rasterEntries: list of referenced raster layers
.. deprecated:: since QGIS 3.8, use the version with transformContext instead
.. deprecated:: QGIS 3.8
use the version with transformContext instead
.. versionadded:: 2.10
%End

12
python/core/auto_generated/annotations/qgsannotation.sip.in
View File

@ -149,7 +149,8 @@ Sets the annotation's frame's offset (in pixels) from the mapPosition() referenc
.. seealso:: :py:func:`frameOffsetFromReferencePoint`
.. deprecated:: use setFrameOffsetFromReferencePointMm() instead
.. deprecated::
use setFrameOffsetFromReferencePointMm() instead
%End
QPointF frameOffsetFromReferencePoint() const /Deprecated/;
@ -158,7 +159,8 @@ Returns the annotation's frame's offset (in pixels) from the mapPosition() refer
.. seealso:: :py:func:`setFrameOffsetFromReferencePoint`
.. deprecated:: use frameOffsetFromReferencePointMm() instead
.. deprecated::
use frameOffsetFromReferencePointMm() instead
%End
void setFrameOffsetFromReferencePointMm( QPointF offset );
@ -186,7 +188,8 @@ the annotation's content is drawn).
.. seealso:: :py:func:`frameSize`
.. deprecated:: use setFrameSizeMm() instead
.. deprecated::
use setFrameSizeMm() instead
%End
QSizeF frameSize() const /Deprecated/;
@ -196,7 +199,8 @@ the annotation's content is drawn).
.. seealso:: :py:func:`setFrameSize`
.. deprecated:: use frameSizeMm() instead
.. deprecated::
use frameSizeMm() instead
%End
void setFrameSizeMm( QSizeF size );

9
python/core/auto_generated/geometry/qgsgeometry.sip.in
View File

@ -850,7 +850,8 @@ Splits this geometry according to a given line.
:return: OperationResult a result code: success or reason of failure
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
OperationResult splitGeometry( const QgsPointSequence &splitLine, QVector<QgsGeometry> &newGeometries /Out/, bool topological, QgsPointSequence &topologyTestPoints /Out/ );
@ -2036,7 +2037,8 @@ Creates a QgsPolylineXY from a QPolygonF.
.. seealso:: :py:func:`createPolygonFromQPolygonF`
.. deprecated:: use QgsGeometry.fromQPolygonF() or QgsLineString.fromQPolygonF() instead.
.. deprecated::
use QgsGeometry.fromQPolygonF() or QgsLineString.fromQPolygonF() instead.
%End
static QgsPolygonXY createPolygonFromQPolygonF( const QPolygonF &polygon ) /Deprecated/;
@ -2049,7 +2051,8 @@ Creates a QgsPolygonXYfrom a QPolygonF.
.. seealso:: :py:func:`createPolylineFromQPolygonF`
.. deprecated:: use QgsGeometry.fromQPolygonF() or QgsLineString.fromQPolygonF() instead.
.. deprecated::
use QgsGeometry.fromQPolygonF() or QgsLineString.fromQPolygonF() instead.
%End

3
python/core/auto_generated/layertree/qgslayertreeregistrybridge.sip.in
View File

@ -57,7 +57,8 @@ Create the instance that synchronizes given project with a layer tree root
Set where the new layers should be inserted - can be used to follow current selection.
By default it is root group with zero index.
.. deprecated:: since QGIS 3.10 use setLayerInsertionPoint( const InsertionPoint &insertionPoint ) instead
.. deprecated:: QGIS 3.10
use setLayerInsertionPoint( const InsertionPoint &insertionPoint ) instead
%End
void setLayerInsertionPoint( const InsertionPoint &insertionPoint );

3
python/core/auto_generated/layout/qgslayoutitem.sip.in
View File

@ -419,7 +419,8 @@ their rendering to determine which layer should be drawn.
.. seealso:: :py:func:`exportLayerDetails`
.. deprecated:: Use nextExportPart() and exportLayerBehavior() instead.
.. deprecated::
Use nextExportPart() and exportLayerBehavior() instead.
%End
virtual void startLayeredExport();

12
python/core/auto_generated/layout/qgslayoutitemscalebar.sip.in
View File

@ -216,7 +216,8 @@ Returns the font used for drawing text in the scalebar.
.. seealso:: :py:func:`setFont`
.. deprecated:: use textFormat() instead
.. deprecated::
use textFormat() instead
%End
void setFont( const QFont &font ) /Deprecated/;
@ -225,7 +226,8 @@ Sets the ``font`` used for drawing text in the scalebar.
.. seealso:: :py:func:`font`
.. deprecated:: use setTextFormat() instead
.. deprecated::
use setTextFormat() instead
%End
QColor fontColor() const /Deprecated/;
@ -236,7 +238,8 @@ Returns the color used for drawing text in the scalebar.
.. seealso:: :py:func:`font`
.. deprecated:: use textFormat() instead
.. deprecated::
use textFormat() instead
%End
void setFontColor( const QColor &color ) /Deprecated/;
@ -247,7 +250,8 @@ Sets the ``color`` used for drawing text in the scalebar.
.. seealso:: :py:func:`setFont`
.. deprecated:: use setTextFormat() instead
.. deprecated::
use setTextFormat() instead
%End
QColor fillColor() const;

3
python/core/auto_generated/layout/qgslayoutpagecollection.sip.in
View File

@ -201,7 +201,8 @@ Returns the symbol to use for drawing pages in the collection.
.. seealso:: :py:func:`setPageStyleSymbol`
.. deprecated:: Use QgsLayoutItemPage.pageStyleSymbol() instead.
.. deprecated::
Use QgsLayoutItemPage.pageStyleSymbol() instead.
%End
void beginPageSizeChange();

6
python/core/auto_generated/layout/qgslayoutrendercontext.sip.in
View File

@ -194,7 +194,8 @@ If ``layer`` is -1, all item layers will be rendered.
.. seealso:: :py:func:`currentExportLayer`
.. deprecated:: Items should now handle this themselves, via QgsLayoutItem.exportLayerBehavior() and returning QgsLayoutItem.nextExportPart().
.. deprecated::
Items should now handle this themselves, via QgsLayoutItem.exportLayerBehavior() and returning QgsLayoutItem.nextExportPart().
%End
int currentExportLayer() const /Deprecated/;
@ -207,7 +208,8 @@ If ``layer`` is -1, all item layers should be rendered.
.. seealso:: :py:func:`setCurrentExportLayer`
.. deprecated:: Items should now handle this themselves, via QgsLayoutItem.exportLayerBehavior() and returning QgsLayoutItem.nextExportPart().
.. deprecated::
Items should now handle this themselves, via QgsLayoutItem.exportLayerBehavior() and returning QgsLayoutItem.nextExportPart().
%End
QgsRenderContext::TextRenderFormat textRenderFormat() const;

6
python/core/auto_generated/layout/qgslayoutreportcontext.sip.in
View File

@ -83,7 +83,8 @@ for maps which are set to the predefined atlas scaling mode.
.. seealso:: :py:func:`predefinedScales`
.. deprecated:: Use QgsLayoutRenderContext.setPredefinedScales()
.. deprecated::
Use QgsLayoutRenderContext.setPredefinedScales()
%End
QVector<qreal> predefinedScales() const /Deprecated/;
@ -92,7 +93,8 @@ Returns the current list of predefined scales for use with the layout.
.. seealso:: :py:func:`setPredefinedScales`
.. deprecated:: Use QgsLayoutRenderContext.predefinedScales()
.. deprecated::
Use QgsLayoutRenderContext.predefinedScales()
%End
signals:

3
python/core/auto_generated/locator/qgslocator.sip.in
View File

@ -89,7 +89,8 @@ with valid prefixes.
.. seealso:: :py:func:`filters`
.. deprecated:: since QGIS 3.2 use filters() instead
.. deprecated:: QGIS 3.2
use filters() instead
%End
void fetchResults( const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback = 0 );

3
python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in
View File

@ -153,7 +153,8 @@ helpString() or helpUrl().
.. seealso:: :py:func:`shortHelpString`
.. deprecated:: Unused, will be removed in QGIS 4.0
.. deprecated::
Unused, will be removed in QGIS 4.0
%End
virtual QString helpUrl() const;

3
python/core/auto_generated/processing/qgsprocessingutils.sip.in
View File

@ -191,7 +191,8 @@ using the specified ``context``.
Combines the extent of several map ``layers``. If specified, the target ``crs``
will be used to transform the layer's extent to the desired output reference system.
.. deprecated:: Use version with QgsProcessingContext argument instead
.. deprecated::
Use version with QgsProcessingContext argument instead
%End
static QVariant generateIteratingDestination( const QVariant &input, const QVariant &id, QgsProcessingContext &context );

6
python/core/auto_generated/qgsattributeeditorelement.sip.in
View File

@ -286,13 +286,15 @@ This element will load a relation editor onto the form.
QgsAttributeEditorRelation( const QString &name, const QString &relationId, QgsAttributeEditorElement *parent );
%Docstring
.. deprecated:: since QGIS 3.0.2. The name parameter is not used for anything and overwritten by the relationId internally.
.. deprecated:: QGIS 3.0.2.
The name parameter is not used for anything and overwritten by the relationId internally.
%End
QgsAttributeEditorRelation( const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent );
%Docstring
.. deprecated:: since QGIS 3.0.2. The name parameter is not used for anything and overwritten by the relationId internally.
.. deprecated:: QGIS 3.0.2.
The name parameter is not used for anything and overwritten by the relationId internally.
%End
QgsAttributeEditorRelation( const QString &relationId, QgsAttributeEditorElement *parent );

3
python/core/auto_generated/qgsbrowsermodel.sip.in
View File

@ -141,7 +141,8 @@ items, i.e. it does not fetch children.
void connectItem( QgsDataItem *item ) /Deprecated/;
%Docstring
.. deprecated:: Deprecated since QGIS 3.4 -- this method has no effect, and is dangerous to call in earlier QGIS versions. Any usage should be removed (and will have no harmful side-effects!).
.. deprecated::
Deprecated since QGIS 3.4 -- this method has no effect, and is dangerous to call in earlier QGIS versions. Any usage should be removed (and will have no harmful side-effects!).
%End
bool initialized() const;

12
python/core/auto_generated/qgscoordinatetransform.sip.in
View File

@ -338,7 +338,8 @@ but can be manually overwritten by a call to setSourceDatumTransformId().
.. seealso:: :py:func:`destinationDatumTransformId`
.. deprecated:: Unused on builds based on Proj 6.0 or later
.. deprecated::
Unused on builds based on Proj 6.0 or later
%End
void setSourceDatumTransformId( int datumId ) /Deprecated/;
@ -355,7 +356,8 @@ Calling this method will overwrite any automatically calculated datum transform.
.. seealso:: :py:func:`setDestinationDatumTransformId`
.. deprecated:: Unused on builds based on Proj 6.0 or later
.. deprecated::
Unused on builds based on Proj 6.0 or later
%End
int destinationDatumTransformId() const /Deprecated/;
@ -372,7 +374,8 @@ but can be manually overwritten by a call to setDestinationDatumTransformId().
.. seealso:: :py:func:`sourceDatumTransformId`
.. deprecated:: Unused on builds based on Proj 6.0 or later
.. deprecated::
Unused on builds based on Proj 6.0 or later
%End
void setDestinationDatumTransformId( int datumId ) /Deprecated/;
@ -389,7 +392,8 @@ Calling this method will overwrite any automatically calculated datum transform.
.. seealso:: :py:func:`setSourceDatumTransformId`
.. deprecated:: Unused on builds based on Proj 6.0 or later
.. deprecated::
Unused on builds based on Proj 6.0 or later
%End

12
python/core/auto_generated/qgscoordinatetransformcontext.sip.in
View File

@ -80,7 +80,8 @@ required for transformations for that source or destination.
.. seealso:: :py:func:`addSourceDestinationDatumTransform`
.. deprecated:: Has no effect on builds based on Proj 6.0 or later, use coordinateOperations() instead.
.. deprecated::
Has no effect on builds based on Proj 6.0 or later, use coordinateOperations() instead.
%End
QMap< QPair< QString, QString>, QString > coordinateOperations() const;
@ -120,7 +121,8 @@ Returns ``True`` if the new transform pair was added successfully.
.. seealso:: :py:func:`removeSourceDestinationDatumTransform`
.. deprecated:: Has no effect on builds based on Proj 6.0 or later, use addCoordinateOperation() instead.
.. deprecated::
Has no effect on builds based on Proj 6.0 or later, use addCoordinateOperation() instead.
%End
bool addCoordinateOperation( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QString &coordinateOperationProjString );
@ -154,7 +156,8 @@ Removes the source to destination datum transform pair for the specified ``sourc
.. seealso:: :py:func:`addSourceDestinationDatumTransform`
.. deprecated:: Use removeCoordinateOperation() instead
.. deprecated::
Use removeCoordinateOperation() instead
%End
void removeCoordinateOperation( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs );
@ -187,7 +190,8 @@ destination.
source and destination are reversible.
.. deprecated:: Has no effect on builds based on Proj 6.0 or later. Use calculateCoordinateOperation() instead.
.. deprecated::
Has no effect on builds based on Proj 6.0 or later. Use calculateCoordinateOperation() instead.
%End
QString calculateCoordinateOperation( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const;

18
python/core/auto_generated/qgsdataitem.sip.in
View File

@ -129,7 +129,8 @@ Returns source widget from data item for :py:class:`QgsBrowserPropertiesWidget`
Use QgsDataItemGuiProvider.createParamWidget() instead
.. deprecated:: QGIS 3.10
.. deprecated::
QGIS 3.10
%End
virtual QList<QAction *> actions( QWidget *parent );
@ -163,7 +164,8 @@ Subclasses should override this and handleDrop() to accept dropped layers.
.. seealso:: :py:func:`QgsDataItemGuiProvider.handleDrop`
.. deprecated:: QGIS 3.10
.. deprecated::
QGIS 3.10
%End
virtual bool handleDrop( const QMimeData * /*data*/, Qt::DropAction /*action*/ ) /Deprecated/;
@ -175,7 +177,8 @@ accept dropped layers.
.. seealso:: :py:func:`QgsDataItemGuiProvider.handleDrop`
.. deprecated:: QGIS 3.10
.. deprecated::
QGIS 3.10
%End
virtual bool handleDoubleClick();
@ -226,7 +229,8 @@ Items that return valid URI will be returned in mime data when dragging a select
Writes the selected crs into data source. The original data source will be modified when calling this
method.
.. deprecated:: since QGIS 3.6. This method is no longer used by QGIS and will be removed in QGIS 4.0.
.. deprecated:: QGIS 3.6.
This method is no longer used by QGIS and will be removed in QGIS 4.0.
%End
virtual bool rename( const QString &name ) /Deprecated/;
@ -241,7 +245,8 @@ Use QgsDataItemGuiProvider:
.. versionadded:: 3.4
.. deprecated:: QGIS 3.10
.. deprecated::
QGIS 3.10
%End
@ -514,7 +519,8 @@ Returns the icon name of the given ``layerType``
Delete this layer item
Use QgsDataItemGuiProvider.deleteLayer instead
.. deprecated:: QGIS 3.10
.. deprecated::
QGIS 3.10
%End
protected:

12
python/core/auto_generated/qgsdatumtransform.sip.in
View File

@ -151,7 +151,8 @@ Returns a list of datum transformations which are available for the given ``sour
.. seealso:: :py:func:`datumTransformInfo`
.. deprecated:: Not used for builds based on Proj >= 6.0
.. deprecated::
Not used for builds based on Proj >= 6.0
%End
static QString datumTransformToProj( int datumTransformId ) /Deprecated/;
@ -164,7 +165,8 @@ Returns a proj string representing the specified ``datumTransformId`` datum tran
.. seealso:: :py:func:`projStringToDatumTransformId`
.. deprecated:: Not used for builds based on Proj >= 6.0
.. deprecated::
Not used for builds based on Proj >= 6.0
%End
static int projStringToDatumTransformId( const QString &string ) /Deprecated/;
@ -174,7 +176,8 @@ Returns -1 if matching datum ID was not found.
.. seealso:: :py:func:`datumTransformToProj`
.. deprecated:: Not used for builds based on Proj >= 6.0
.. deprecated::
Not used for builds based on Proj >= 6.0
%End
static QgsDatumTransform::TransformInfo datumTransformInfo( int datumTransformId ) /Deprecated/;
@ -187,7 +190,8 @@ If ``datumTransformId`` was not a valid transform ID, a TransformInfo with Trans
.. seealso:: :py:func:`datumTransformToProj`
.. deprecated:: Not used for builds based on Proj >= 6.0
.. deprecated::
Not used for builds based on Proj >= 6.0
%End

9
python/core/auto_generated/qgsfeaturefiltermodel.sip.in
View File

@ -110,7 +110,8 @@ The identifier field should be a unique field that can be used to identify indiv
It is normally set to the primary key of the layer.
If there are several identifier fields defined, the behavior is not guaranteed
.. deprecated:: since QGIS 3.10 use identifierFields instead
.. deprecated:: QGIS 3.10
use identifierFields instead
%End
QStringList identifierFields() const;
@ -126,7 +127,7 @@ It is normally set to the primary key of the layer.
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.
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
void setIdentifierFields( const QStringList &identifierFields );
@ -146,7 +147,7 @@ It is normally set to the primary key of the layer.
Allows specifying one value that does not need to match the filter criteria but will
still be available in the model.
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
QVariantList extraIdentifierValues() const;
@ -162,7 +163,7 @@ still be available in the model.
Allows specifying one value that does not need to match the filter criteria but will
still be available in the model.
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
void setExtraIdentifierValues( const QVariantList &extraIdentifierValues );

6
python/core/auto_generated/qgsfeaturerequest.sip.in
View File

@ -667,7 +667,8 @@ at this moment. A negative value (which is set by default) will wait forever.
Only works if the provider supports this option.
.. deprecated:: Use timeout() instead.
.. deprecated::
Use timeout() instead.
.. versionadded:: 3.0
%End
@ -681,7 +682,8 @@ at this moment. A negative value (which is set by default) will wait forever.
Only works if the provider supports this option.
.. deprecated:: Use setTimeout() instead.
.. deprecated::
Use setTimeout() instead.
.. versionadded:: 3.0
%End

6
python/core/auto_generated/qgslabelingenginesettings.sip.in
View File

@ -80,14 +80,16 @@ Sets number of candidate positions that will be generated for each label feature
%Docstring
Used to set which search method to use for removal collisions between labels
.. deprecated:: since QGIS 3.10 - Chain is always used.
.. deprecated:: QGIS 3.10
- Chain is always used.
%End
Search searchMethod() const /Deprecated/;
%Docstring
Which search method to use for removal collisions between labels
.. deprecated:: since QGIS 3.10 - Chain is always used.
.. deprecated:: QGIS 3.10
- Chain is always used.
%End
void readSettingsFromProject( QgsProject *project );

2
python/core/auto_generated/qgsmaplayer.sip.in
View File

@ -1672,7 +1672,7 @@ Sets error message
Checks whether a new set of dependencies will introduce a cycle
this method is now deprecated and always return false, because circular dependencies are now correctly managed.
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End

3
python/core/auto_generated/qgsmaptopixel.sip.in
View File

@ -117,7 +117,8 @@ Transform device coordinates to map (world) coordinates
%Docstring
Transform device coordinates to map (world) coordinates
.. deprecated:: since QGIS 3.4 use toMapCoordinates instead
.. deprecated:: QGIS 3.4
use toMapCoordinates instead
%End
void setMapUnitsPerPixel( double mapUnitsPerPixel );

6
python/core/auto_generated/qgsnetworkaccessmanager.sip.in
View File

@ -324,7 +324,8 @@ The contents of the reply will be returned after the request is completed or an
void requestAboutToBeCreated( QNetworkAccessManager::Operation, const QNetworkRequest &, QIODevice * ) /Deprecated/;
%Docstring
.. deprecated:: Use the thread-safe requestAboutToBeCreated( QgsNetworkRequestParameters ) signal instead.
.. deprecated::
Use the thread-safe requestAboutToBeCreated( QgsNetworkRequestParameters ) signal instead.
%End
void requestAboutToBeCreated( QgsNetworkRequestParameters request );
@ -449,7 +450,8 @@ See QgsSslErrorHandler for details on how to handle SSL errors and potentially i
void requestCreated( QNetworkReply * ) /Deprecated/;
%Docstring
.. deprecated:: Use the thread-safe requestAboutToBeCreated( QgsNetworkRequestParameters ) signal instead.
.. deprecated::
Use the thread-safe requestAboutToBeCreated( QgsNetworkRequestParameters ) signal instead.
%End
void requestTimedOut( QNetworkReply * );

20
python/core/auto_generated/qgsproject.sip.in
View File

@ -110,7 +110,8 @@ Returns QFileInfo object for the project's associated file.
.. seealso:: :py:func:`fileName`
.. deprecated:: since QGIS 3.2 use absoluteFilePath(), baseName() or lastModifiedTime() instead
.. deprecated:: QGIS 3.2
use absoluteFilePath(), baseName() or lastModifiedTime() instead
%End
QgsProjectStorage *projectStorage() const;
@ -601,21 +602,24 @@ Returns pointer to the project's annotation manager.
%Docstring
Set a list of layers which should not be taken into account on map identification
.. deprecated:: since QGIS 3.4 use QgsMapLayer.setFlags() instead
.. deprecated:: QGIS 3.4
use QgsMapLayer.setFlags() instead
%End
void setNonIdentifiableLayers( const QStringList &layerIds );
%Docstring
Set a list of layers which should not be taken into account on map identification
.. deprecated:: since QGIS 3.4 use QgsMapLayer.setFlags() instead
.. deprecated:: QGIS 3.4
use QgsMapLayer.setFlags() instead
%End
QStringList nonIdentifiableLayers() const;
%Docstring
Gets the list of layers which currently should not be taken into account on map identification
.. deprecated:: since QGIS 3.4 use QgsMapLayer.setFlags() instead
.. deprecated:: QGIS 3.4
use QgsMapLayer.setFlags() instead
%End
bool autoTransaction() const;
@ -1048,7 +1052,8 @@ removed from the project. The set of layers may be configured by users in projec
and it is mainly a hint for the user interface to protect users from removing layers that important
in the project. The removeMapLayer(), removeMapLayers() calls do not block removal of layers listed here.
.. deprecated:: since QGIS 3.4 use QgsMapLayer.flags() instead
.. deprecated:: QGIS 3.4
use QgsMapLayer.flags() instead
.. versionadded:: 3.2
%End
@ -1060,7 +1065,8 @@ removed from the project. The set of layers may be configured by users in projec
and it is mainly a hint for the user interface to protect users from removing layers that important
in the project. The removeMapLayer(), removeMapLayers() calls do not block removal of layers listed here.
.. deprecated:: since QGIS 3.4 use QgsMapLayer.setFlags() instead
.. deprecated:: QGIS 3.4
use QgsMapLayer.setFlags() instead
.. versionadded:: 3.2
%End
@ -1284,7 +1290,7 @@ Emitted when loading layers has produced some messages
%Docstring
Emitted when the list of layer which are excluded from map identification changes
.. deprecated:: since QGIS 3.4
.. deprecated:: QGIS 3.4
%End
void fileNameChanged();

9
python/core/auto_generated/qgsprojectstorage.sip.in
View File

@ -103,7 +103,8 @@ Returns human-readable name of the storage. Used as the menu item text in QGIS.
indicates that the storage does not implement GUI support (showLoadGui() and showSaveGui()).
The name may be translatable and ideally unique as well.
.. deprecated:: since QGIS 3.10 - use QgsProjectStorageGuiProvider for GUI-related project storage functionality
.. deprecated:: QGIS 3.10
- use QgsProjectStorageGuiProvider for GUI-related project storage functionality
%End
virtual QString showLoadGui() /Deprecated/;
@ -111,7 +112,8 @@ The name may be translatable and ideally unique as well.
Opens GUI to allow user to select a project to be loaded (GUI specific to this storage type).
Returns project URI if user has picked a project or empty string if the GUI was canceled.
.. deprecated:: since QGIS 3.10 - use QgsProjectStorageGuiProvider for GUI-related project storage functionality
.. deprecated:: QGIS 3.10
- use QgsProjectStorageGuiProvider for GUI-related project storage functionality
%End
virtual QString showSaveGui() /Deprecated/;
@ -119,7 +121,8 @@ Returns project URI if user has picked a project or empty string if the GUI was
Opens GUI to allow user to select where a project should be saved (GUI specific to this storage type).
Returns project URI if user has picked a destination or empty string if the GUI was canceled.
.. deprecated:: since QGIS 3.10 - use QgsProjectStorageGuiProvider for GUI-related project storage functionality
.. deprecated:: QGIS 3.10
- use QgsProjectStorageGuiProvider for GUI-related project storage functionality
%End
};

3
python/core/auto_generated/qgsprovidermetadata.sip.in
View File

@ -70,7 +70,8 @@ This returns the library file name
This is used to QLibrary calls to load the data provider (only for dynamically loaded libraries)
.. deprecated:: QGIS 3.10 - providers may not need to be loaded from a library (empty string returned)
.. deprecated::
QGIS 3.10 - providers may not need to be loaded from a library (empty string returned)
%End

18
python/core/auto_generated/qgsproviderregistry.sip.in
View File

@ -57,7 +57,8 @@ Returns path for the library of the provider.
If the provider uses direct provider function pointers instead of a library an empty string will
be returned.
.. deprecated:: QGIS 3.10 - providers may not need to be loaded from a library (empty string returned)
.. deprecated::
QGIS 3.10 - providers may not need to be loaded from a library (empty string returned)
%End
QString pluginList( bool asHtml = false ) const;
@ -98,7 +99,8 @@ Returns the provider capabilities
.. versionadded:: 2.6
.. deprecated:: QGIS 3.10 (use instead capabilities() method of individual data item provider)
.. deprecated::
QGIS 3.10 (use instead capabilities() method of individual data item provider)
%End
@ -149,7 +151,8 @@ Returns a new widget for selecting layers from a provider.
Either the ``parent`` widget must be set or the caller becomes
responsible for deleting the returned widget.
.. deprecated:: QGIS 3.10 - use QgsGui.providerGuiRegistry()->createDataSourceWidget() instead
.. deprecated::
QGIS 3.10 - use QgsGui.providerGuiRegistry()->createDataSourceWidget() instead
%End
QList< QgsDataItemProvider * > dataItemProviders( const QString &providerKey ) const /Factory/;
@ -231,7 +234,8 @@ Gets pointer to provider function
:return: pointer to function or ``None`` on error. If the provider uses direct provider
function pointers instead of a library ``None`` will be returned.
.. deprecated:: QGIS 3.10 - any provider functionality should be accessed through QgsProviderMetadata
.. deprecated::
QGIS 3.10 - any provider functionality should be accessed through QgsProviderMetadata
%End
QLibrary *createProviderLibrary( const QString &providerKey ) const /Factory,Deprecated/;
@ -242,7 +246,8 @@ object is transferred to the caller and the caller is responsible for deleting i
If the provider uses direct provider function pointers instead of a library ``None`` will
be returned.
.. deprecated:: QGIS 3.10 - providers may not need to be loaded from a library
.. deprecated::
QGIS 3.10 - providers may not need to be loaded from a library
%End
QStringList providerList() const;
@ -331,7 +336,8 @@ Returns a string containing the available protocol drivers
void registerGuis( QWidget *widget ) /Deprecated/;
%Docstring
.. deprecated:: since QGIS 3.10 - does nothing - use QgsGui.providerGuiRegistry()
.. deprecated:: QGIS 3.10
- does nothing - use QgsGui.providerGuiRegistry()
%End
bool registerProvider( QgsProviderMetadata *providerMetadata /Transfer/ );

4
python/core/auto_generated/qgssnappingutils.sip.in
View File

@ -182,14 +182,14 @@ Emitted when the snapping settings object changes.
%Docstring
This methods is now deprecated and never called
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
virtual void prepareIndexProgress( int index );
%Docstring
This methods is now deprecated and never called
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
void clearAllLocators();

6
python/core/auto_generated/qgsspatialindex.sip.in
View File

@ -88,7 +88,8 @@ Copy constructor
%Docstring
Adds a ``feature`` to the index.
.. deprecated:: Use addFeature() instead
.. deprecated::
Use addFeature() instead
%End
virtual bool addFeature( QgsFeature &feature, QgsFeatureSink::Flags flags = 0 );
@ -117,7 +118,8 @@ Add a feature ``id`` to the index with a specified bounding box.
:return: ``True`` if feature was successfully added to index.
.. deprecated:: Use addFeature() instead
.. deprecated::
Use addFeature() instead
%End
bool addFeature( QgsFeatureId id, const QgsRectangle &bounds );

24
python/core/auto_generated/qgsvectorlayer.sip.in
View File

@ -1017,7 +1017,8 @@ if the geometry type of the new data source matches the current geometry type of
.. versionadded:: 2.10
.. deprecated:: Use version with ProviderOptions argument instead
.. deprecated::
Use version with ProviderOptions argument instead
%End
virtual void setDataSource( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag = false );
@ -1259,7 +1260,8 @@ Adds a ring to polygon/multipolygon features
to the underlying data provider until a commitChanges() call is made. Any uncommitted
changes can be discarded by calling rollBack().
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
@ -1336,7 +1338,8 @@ Adds a new part polygon to a multipart feature
to the underlying data provider until a commitChanges() call is made. Any uncommitted
changes can be discarded by calling rollBack().
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
QgsGeometry::OperationResult addPart( const QVector<QgsPointXY> &ring ) /PyName=addPartV2,Deprecated/;
@ -1364,7 +1367,8 @@ Adds a new part polygon to a multipart feature
to the underlying data provider until a commitChanges() call is made. Any uncommitted
changes can be discarded by calling rollBack().
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
QgsGeometry::OperationResult addPart( const QgsPointSequence &ring ) /PyName=addPartV2/;
@ -1449,7 +1453,8 @@ Splits parts cut by the given line
to the underlying data provider until a commitChanges() call is made. Any uncommitted
changes can be discarded by calling rollBack().
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
QgsGeometry::OperationResult splitParts( const QgsPointSequence &splitLine, bool topologicalEditing = false );
@ -1499,7 +1504,8 @@ Splits features cut by the given line
to the underlying data provider until a commitChanges() call is made. Any uncommitted
changes can be discarded by calling rollBack().
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
QgsGeometry::OperationResult splitFeatures( const QgsPointSequence &splitLine, bool topologicalEditing = false );
@ -1564,7 +1570,8 @@ editing.
to the underlying data provider until a commitChanges() call is made. Any uncommitted
changes can be discarded by calling rollBack().
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
int addTopologicalPoints( const QgsPoint &p );
@ -2021,7 +2028,8 @@ Destroy active command and reverts all changes in it
%Docstring
Draws a vertex symbol at (screen) coordinates x, y. (Useful to assist vertex editing.)
.. deprecated:: Use the equivalent QgsSymbolLayerUtils.drawVertexMarker function instead
.. deprecated::
Use the equivalent QgsSymbolLayerUtils.drawVertexMarker function instead
%End
void updateFields();

12
python/core/auto_generated/qgsvectorlayereditutils.sip.in
View File

@ -71,7 +71,8 @@ Adds a ring to polygon/multipolygon features
:return: OperationResult result code: success or reason of failure
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
QgsGeometry::OperationResult addRing( const QgsPointSequence &ring, const QgsFeatureIds &targetFeatureIds = QgsFeatureIds(), QgsFeatureId *modifiedFeatureId = 0 );
@ -112,7 +113,8 @@ Adds a new part polygon to a multipart feature
- QgsGeometry.InvalidBaseGeometry
- QgsGeometry.InvalidInput
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
QgsGeometry::OperationResult addPart( const QgsPointSequence &ring, QgsFeatureId featureId );
@ -171,7 +173,8 @@ Splits parts cut by the given line
- QgsGeometry.GeometryEngineError
- QgsGeometry.SplitCannotSplitPoint
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
QgsGeometry::OperationResult splitParts( const QgsPointSequence &splitLine, bool topologicalEditing = false );
@ -200,7 +203,8 @@ Splits features cut by the given line
:return: 0 in case of success,
4 if there is a selection but no feature split
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
QgsGeometry::OperationResult splitFeatures( const QgsPointSequence &splitLine, bool topologicalEditing = false );

3
python/core/auto_generated/raster/qgsrasterfilewriter.sip.in
View File

@ -94,7 +94,8 @@ Write raster file
:param crs: crs to reproject to
:param feedback: optional feedback object for progress reports
.. deprecated:: since QGIS 3.8, use version with transformContext instead
.. deprecated:: QGIS 3.8
use version with transformContext instead
%End
WriterError writeRaster( const QgsRasterPipe *pipe, int nCols, int nRows, const QgsRectangle &outputExtent,

6
python/core/auto_generated/raster/qgsrasterfilewritertask.sip.in
View File

@ -38,7 +38,8 @@ Constructor for QgsRasterFileWriterTask. Takes a source ``writer``,
Ownership of the ``pipe`` is transferred to the writer task, and will
be deleted when the task completes.
.. deprecated:: since QGIS 3.8, use version with transformContext instead
.. deprecated:: QGIS 3.8
use version with transformContext instead
%End
@ -72,7 +73,8 @@ parameter indicates the file path for the written file(s).
Emitted when an error occurs which prevented the file being written (or if
the task is canceled). The writing ``error`` will be reported.
.. deprecated:: since QGIS 3.10. Use errorOccurred(int, const QString&)
.. deprecated:: QGIS 3.10.
Use errorOccurred(int, const QString&)
%End
void errorOccurred( int error, const QString &errorMessage );

3
python/core/auto_generated/raster/qgsrasterlayer.sip.in
View File

@ -187,7 +187,8 @@ Returns time stamp for given file name
%Docstring
Set the data provider.
.. deprecated:: Use the version with ProviderOptions instead.
.. deprecated::
Use the version with ProviderOptions instead.
%End
void setDataProvider( const QString &provider, const QgsDataProvider::ProviderOptions &options );

3
python/core/auto_generated/raster/qgsrasterprojector.sip.in
View File

@ -51,7 +51,8 @@ which are used to calculate affine transformation matrices.
%Docstring
Sets the source and destination CRS
.. deprecated:: since QGIS 3.8, use transformContext version instead
.. deprecated:: QGIS 3.8
use transformContext version instead
%End
void setCrs( const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destCRS,

3
python/core/auto_generated/scalebar/qgsscalebarrenderer.sip.in
View File

@ -78,7 +78,8 @@ Returns the text used for the first label in the scalebar.
%Docstring
Returns the x-offset (in millimeters) used for the first label in the scalebar.
.. deprecated:: Use the version with QgsRenderContext instead.
.. deprecated::
Use the version with QgsRenderContext instead.
%End
double firstLabelXOffset( const QgsScaleBarSettings &settings, const QgsRenderContext &context, const ScaleBarContext &scaleContext ) const;

12
python/core/auto_generated/scalebar/qgsscalebarsettings.sip.in
View File

@ -243,7 +243,8 @@ Returns the font used for drawing text in the scalebar.
.. seealso:: :py:func:`setFont`
.. deprecated:: use textFormat() instead
.. deprecated::
use textFormat() instead
%End
void setFont( const QFont &font ) /Deprecated/;
@ -252,7 +253,8 @@ Sets the ``font`` used for drawing text in the scalebar.
.. seealso:: :py:func:`font`
.. deprecated:: use setTextFormat() instead
.. deprecated::
use setTextFormat() instead
%End
QColor fontColor() const /Deprecated/;
@ -263,7 +265,8 @@ Returns the color used for drawing text in the scalebar.
.. seealso:: :py:func:`font`
.. deprecated:: use textFormat() instead
.. deprecated::
use textFormat() instead
%End
void setFontColor( const QColor &color ) /Deprecated/;
@ -274,7 +277,8 @@ Sets the ``color`` used for drawing text in the scalebar.
.. seealso:: :py:func:`setFont`
.. deprecated:: use textFormat() instead
.. deprecated::
use textFormat() instead
%End
QColor fillColor() const;

6
python/core/auto_generated/symbology/qgscategorizedsymbolrenderer.sip.in
View File

@ -465,14 +465,16 @@ hashtable for faster access to symbols
QgsSymbol *skipRender() /Deprecated/;
%Docstring
.. deprecated:: No longer used, will be removed in QGIS 4.0
.. deprecated::
No longer used, will be removed in QGIS 4.0
%End
QgsSymbol *symbolForValue( const QVariant &value ) const /Deprecated/;
%Docstring
Returns the matching symbol corresponding to an attribute ``value``.
.. deprecated:: use variant which takes a second bool argument instead.
.. deprecated::
use variant which takes a second bool argument instead.
%End

40
python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in
View File

@ -146,12 +146,14 @@ This will take ownership of the method
Mode mode() const /Deprecated/;
%Docstring
.. deprecated:: since QGIS 3.10 use classficationMethod instead
.. deprecated:: QGIS 3.10
use classficationMethod instead
%End
void setMode( Mode mode ) /Deprecated/;
%Docstring
.. deprecated:: since QGIS 3.10 use classficationMethod instead
.. deprecated:: QGIS 3.10
use classficationMethod instead
%End
bool useSymmetricMode() const /Deprecated/;
@ -160,7 +162,8 @@ Returns if we want to classify symmetric around a given value
.. versionadded:: 3.4
.. deprecated:: since QGIS 3.10 use classficationMethod instead
.. deprecated:: QGIS 3.10
use classficationMethod instead
%End
void setUseSymmetricMode( bool useSymmetricMode ) /Deprecated/;
@ -169,7 +172,8 @@ Set if we want to classify symmetric around a given value
.. versionadded:: 3.4
.. deprecated:: since QGIS 3.10 use classficationMethod instead
.. deprecated:: QGIS 3.10
use classficationMethod instead
%End
double symmetryPoint() const /Deprecated/;
@ -178,7 +182,8 @@ Returns the pivot value for symmetric classification
.. versionadded:: 3.4
.. deprecated:: since QGIS 3.10 use classficationMethod instead
.. deprecated:: QGIS 3.10
use classficationMethod instead
%End
void setSymmetryPoint( double symmetryPoint ) /Deprecated/;
@ -187,7 +192,8 @@ Set the pivot point
.. versionadded:: 3.4
.. deprecated:: since QGIS 3.10 use classficationMethod instead
.. deprecated:: QGIS 3.10
use classficationMethod instead
%End
@ -197,7 +203,8 @@ Returns if we want to have a central class astride the pivot value
.. versionadded:: 3.4
.. deprecated:: since QGIS 3.10 use classficationMethod instead
.. deprecated:: QGIS 3.10
use classficationMethod instead
%End
void setAstride( bool astride ) /Deprecated/;
@ -206,7 +213,8 @@ Set if we want a central class astride the pivot value
.. versionadded:: 3.4
.. deprecated:: since QGIS 3.10 use classficationMethod instead
.. deprecated:: QGIS 3.10
use classficationMethod instead
%End
static void makeBreaksSymmetric( QList<double> &breaks /In,Out/, double symmetryPoint, bool astride ) /Deprecated/;
@ -220,7 +228,8 @@ Does not put a break on the symmetryPoint. This is done before.
.. versionadded:: 3.4
.. deprecated:: since QGIS 3.10, use QgsClassificationMethod.makeBreaksSymmetric instead
.. deprecated:: QGIS 3.10
use QgsClassificationMethod.makeBreaksSymmetric instead
%End
static QList<double> calcEqualIntervalBreaks( double minimum, double maximum, int classes, bool useSymmetricMode, double symmetryPoint, bool astride ) /Deprecated/;
@ -234,7 +243,8 @@ Compute the equal interval classification
:param symmetryPoint: The point around which we want a symmetry
:param astride: A bool indicating if the symmetry is made astride the symmetryPoint or not ( [-1,1] vs. [-1,0][0,1] )
.. deprecated:: since QGIS 3.10 use QgsClassificationEqualInterval class instead
.. deprecated:: QGIS 3.10
use QgsClassificationEqualInterval class instead
%End
void updateClasses( QgsVectorLayer *vlayer, Mode mode, int nclasses, bool useSymmetricMode = false, double symmetryPoint = 0.0, bool astride = false ) /Deprecated/;
@ -250,7 +260,7 @@ Recalculate classes for a layer
.. versionadded:: 2.6
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
void updateClasses( const QgsVectorLayer *vl, int nclasses );
@ -268,7 +278,8 @@ Returns the label format used to generate default classification labels
.. versionadded:: 2.6
.. deprecated:: since QGIS 3.10 use classificationMethod() and QgsClassificationMethod.setLabelFormat instead
.. deprecated:: QGIS 3.10
use classificationMethod() and QgsClassificationMethod.setLabelFormat instead
%End
void setLabelFormat( const QgsRendererRangeLabelFormat &labelFormat, bool updateRanges = false ) /Deprecated/;
@ -280,7 +291,8 @@ Set the label format used to generate default classification labels
.. versionadded:: 2.6
.. deprecated:: since QGIS 3.10 use classificationMethod() and QgsClassificationMethod.setLabelFormat instead
.. deprecated:: QGIS 3.10
use classificationMethod() and QgsClassificationMethod.setLabelFormat instead
%End
@ -322,7 +334,7 @@ Creates a new graduated renderer.
:return: new QgsGraduatedSymbolRenderer object
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;

6
python/core/auto_generated/symbology/qgslinesymbollayer.sip.in
View File

@ -641,14 +641,16 @@ Shall the marker be rotated.
:return: ``True`` if the marker should be rotated.
.. deprecated:: Use rotateSymbols() instead.
.. deprecated::
Use rotateSymbols() instead.
%End
void setRotateMarker( bool rotate ) /Deprecated/;
%Docstring
Shall the marker be rotated.
.. deprecated:: Use setRotateSymbols() instead.
.. deprecated::
Use setRotateSymbols() instead.
%End
protected:

3
python/core/auto_generated/symbology/qgsrendererrange.sip.in
View File

@ -80,7 +80,8 @@ class QgsRendererRangeLabelFormat /Deprecated/
.. versionadded:: 2.6
.. deprecated:: since QGIS 3.10, use QgsClassificationMethod instead
.. deprecated:: QGIS 3.10
use QgsClassificationMethod instead
%End
%TypeHeaderCode

3
python/core/auto_generated/symbology/qgssvgcache.sip.in
View File

@ -175,7 +175,8 @@ use in external scripts or QGIS server.
%Docstring
Emit a signal to be caught by qgisapp and display a msg on status bar.
.. deprecated:: Deprecated since QGIS 3.6 -- no longer emitted.
.. deprecated::
Deprecated since QGIS 3.6 -- no longer emitted.
%End
void remoteSvgFetched( const QString &url );

24
python/core/auto_generated/symbology/qgssymbol.sip.in
View File

@ -501,13 +501,15 @@ Returns whether the symbol utilizes any data defined properties.
the layer will be ``None`` after stopRender
.. deprecated:: Will be removed in QGIS 4.0
.. deprecated::
Will be removed in QGIS 4.0
%End
const QgsVectorLayer *layer() const /Deprecated/;
%Docstring
.. deprecated:: Will be removed in QGIS 4.0
.. deprecated::
Will be removed in QGIS 4.0
%End
void renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false, int currentVertexMarkerType = 0, double currentVertexMarkerSize = 0.0 ) throw( QgsCsException );
@ -632,26 +634,30 @@ Sets the original value variable value for data defined symbology
%Docstring
Returns the output unit for the context.
.. deprecated:: No longer used and will be removed in QGIS 4.0
.. deprecated::
No longer used and will be removed in QGIS 4.0
%End
void setOutputUnit( QgsUnitTypes::RenderUnit u ) /Deprecated/;
%Docstring
Sets the output unit for the context.
.. deprecated:: No longer used and will be removed in QGIS 4.0
.. deprecated::
No longer used and will be removed in QGIS 4.0
%End
QgsMapUnitScale mapUnitScale() const /Deprecated/;
%Docstring
.. deprecated:: Will be removed in QGIS 4.0
.. deprecated::
Will be removed in QGIS 4.0
%End
void setMapUnitScale( const QgsMapUnitScale &scale ) /Deprecated/;
%Docstring
.. deprecated:: Will be removed in QGIS 4.0
.. deprecated::
Will be removed in QGIS 4.0
%End
qreal opacity() const;
@ -768,13 +774,15 @@ Sets the part number of current geometry
double outputLineWidth( double width ) const /Deprecated/;
%Docstring
.. deprecated:: Use the size conversion methods in QgsRenderContext instead.
.. deprecated::
Use the size conversion methods in QgsRenderContext instead.
%End
double outputPixelSize( double size ) const /Deprecated/;
%Docstring
.. deprecated:: Use the size conversion methods in QgsRenderContext instead.
.. deprecated::
Use the size conversion methods in QgsRenderContext instead.
%End

12
python/gui/auto_generated/attributetable/qgsfeaturelistmodel.sip.in
View File

@ -157,28 +157,32 @@ Sort this model by its display expression.
%Docstring
Does nothing except for calling beginRemoveRows()
.. deprecated:: Use beginRemoveRows() instead
.. deprecated::
Use beginRemoveRows() instead
%End
void onEndRemoveRows( const QModelIndex &parent, int first, int last );
%Docstring
Does nothing except for calling endRemoveRows()
.. deprecated:: Use endRemoveRows() instead
.. deprecated::
Use endRemoveRows() instead
%End
void onBeginInsertRows( const QModelIndex &parent, int first, int last );
%Docstring
Does nothing except for calling beginInsertRows()
.. deprecated:: use beginInsertRows() instead
.. deprecated::
use beginInsertRows() instead
%End
void onEndInsertRows( const QModelIndex &parent, int first, int last );
%Docstring
Does nothing except for calling endInsertRows()
.. deprecated:: use endInsertRows() instead
.. deprecated::
use endInsertRows() instead
%End
};

9
python/gui/auto_generated/attributetable/qgsfieldconditionalformatwidget.sip.in
View File

@ -30,7 +30,8 @@ Constructor for QgsFieldConditionalFormatWidget.
%Docstring
Switches the widget to the rules page.
.. deprecated:: no longer used, will be removed in QGIS 4.0
.. deprecated::
no longer used, will be removed in QGIS 4.0
%End
void setLayer( QgsVectorLayer *layer );
@ -49,14 +50,16 @@ and ``style`` is the initial definition of the style.
void loadStyle( const QgsConditionalStyle &style ) /Deprecated/;
%Docstring
.. deprecated:: no longer used, use QgsEditConditionalFormatRuleWidget.loadStyle instead.
.. deprecated::
no longer used, use QgsEditConditionalFormatRuleWidget.loadStyle instead.
%End
void reset() /Deprecated/;
%Docstring
Resets the formatting options to their default state.
.. deprecated:: no longer used, will be removed in QGIS 4.0
.. deprecated::
no longer used, will be removed in QGIS 4.0
%End
void setPresets( const QList<QgsConditionalStyle> &styles );

3
python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
View File

@ -244,7 +244,8 @@ Emit this signal, whenever the value changed.
:param value: The new value
.. deprecated:: since QGIS 3.10 use valuesChanged signal instead
.. deprecated:: QGIS 3.10
use valuesChanged signal instead
%End
void valuesChanged( const QVariant &value, const QVariantList &additionalFieldValues = QVariantList() );

3
python/gui/auto_generated/editorwidgets/qgsrelationreferencesearchwidgetwrapper.sip.in
View File

@ -70,7 +70,8 @@ Returns a variant representing the current state of the widget.
%Docstring
Called when current value of search widget changes
.. deprecated:: since QGIS 3.10 made private
.. deprecated:: QGIS 3.10
made private
%End
protected slots:

7
python/gui/auto_generated/editorwidgets/qgsrelationreferencewidget.sip.in
View File

@ -50,7 +50,8 @@ class QgsRelationReferenceWidget : QWidget
%Docstring
this sets the related feature using from the foreign key
.. deprecated:: since QGIS 3.10 use setForeignKeys
.. deprecated:: QGIS 3.10
use setForeignKeys
%End
void setForeignKeys( const QVariantList &values );
@ -64,7 +65,7 @@ Sets the related feature using the foreign keys
%Docstring
returns the related feature foreign key
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
@ -198,7 +199,7 @@ unset the currently related feature
%Docstring
Emitted when the foreign key changed
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
void foreignKeysChanged( const QVariantList & );

6
python/gui/auto_generated/layertree/qgslayertreeviewdefaultactions.sip.in
View File

@ -62,7 +62,8 @@ Action to zoom to selected features of a vector layer
QAction *actionMakeTopLevel( QObject *parent = 0 ) /Factory/;
%Docstring
.. deprecated:: since QGIS 3.2, use actionMoveOutOfGroup()
.. deprecated:: QGIS 3.2
use actionMoveOutOfGroup()
%End
QAction *actionMoveOutOfGroup( QObject *parent = 0 ) /Factory/;
@ -121,7 +122,8 @@ Slot to zoom to selected features of a vector layer
void makeTopLevel();
%Docstring
.. deprecated:: since QGIS 3.2, use moveOutOfGroup()
.. deprecated:: QGIS 3.2
use moveOutOfGroup()
%End
void moveOutOfGroup();

3
python/gui/auto_generated/qgisinterface.sip.in
View File

@ -1111,7 +1111,8 @@ QGIS documentation, set useQgisDocDirectory to ``False``.
:param useQgisDocDirectory: If ``True``, the URL will be formed by concatenating
url to the QGIS documentation directory path (prefix/share/doc)
.. deprecated:: Use QDesktopServices instead
.. deprecated::
Use QDesktopServices instead
%End
virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;

3
python/gui/auto_generated/qgsabstractdatasourcewidget.sip.in
View File

@ -117,7 +117,8 @@ Emitted when a layer needs to be replaced
%Docstring
Emitted when a progress dialog is shown by the provider dialog.
.. deprecated:: Since QGIS 3.4 this signal is no longer used. Use QgsProxyProgressTask instead to show progress reports.
.. deprecated:: QGIS 3.4
this signal is no longer used. Use QgsProxyProgressTask instead to show progress reports.
%End
void progressMessage( QString message );

3
python/gui/auto_generated/qgsattributeform.sip.in
View File

@ -168,7 +168,8 @@ back to the original one.
:param attribute: The name of the attribute that changed.
:param value: The new value of the attribute.
.. deprecated:: since 3.0
.. deprecated::
since 3.0
%End
void widgetValueChanged( const QString &attribute, const QVariant &value, bool attributeChanged );

3
python/gui/auto_generated/qgsattributeformeditorwidget.sip.in
View File

@ -101,7 +101,8 @@ Emitted when the widget's value changes
:param value: new widget value
.. deprecated:: since QGIS 3.10 use valuesChanged instead
.. deprecated:: QGIS 3.10
use valuesChanged instead
%End
void valuesChanged( const QVariant &value, const QVariantList &additionalFieldValues );

18
python/gui/auto_generated/qgsbrowserdockwidget.sip.in
View File

@ -36,7 +36,8 @@ Constructor for QgsBrowserDockWidget
%Docstring
Add directory to favorites.
.. deprecated:: will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
.. deprecated::
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
%End
void setMessageBar( QgsMessageBar *bar );
@ -68,7 +69,8 @@ Adds the layer corresponding to the specified model ``index``.
Returns ``True`` if the index was successfully intrepreted as a map layer and loaded, or
``False`` if the index is not a map layer or could not be loaded.
.. deprecated:: will be removed in QGIS 4.0 - retrieve the QgsLayerItem itself and manually add to project.
.. deprecated::
will be removed in QGIS 4.0 - retrieve the QgsLayerItem itself and manually add to project.
%End
void showContextMenu( QPoint );
@ -80,21 +82,24 @@ Show context menu
%Docstring
Add current item to favorite.
.. deprecated:: will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
.. deprecated::
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
%End
void addFavoriteDirectory() /Deprecated/;
%Docstring
Add directory from file dialog to favorite.
.. deprecated:: will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
.. deprecated::
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
%End
void removeFavorite() /Deprecated/;
%Docstring
Remove from favorite.
.. deprecated:: will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
.. deprecated::
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
%End
void refresh();
@ -148,7 +153,8 @@ Hide current item
%Docstring
Toggle fast scan
.. deprecated:: will be removed in QGIS 4.0
.. deprecated::
will be removed in QGIS 4.0
%End

3
python/gui/auto_generated/qgscustomdrophandler.sip.in
View File

@ -89,7 +89,8 @@ Accordingly, only implementations must be lightweight and return ASAP.
(For instance by copying the relevant parts of ``data`` and then handling
the data after a short timeout).
.. deprecated:: in QGIS 3.10 - use handleMimeDataV2() instead.
.. deprecated::
in QGIS 3.10 - use handleMimeDataV2() instead.
%End
virtual bool handleMimeDataV2( const QMimeData *data );

9
python/gui/auto_generated/qgsfeaturelistcombobox.sip.in
View File

@ -87,7 +87,7 @@ TODO!
The identifier value of the currently selected feature. A value from the
identifierField.
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
QVariantList identifierValues() const;
@ -104,7 +104,8 @@ identifierField.
The identifier value of the currently selected feature. A value from the
identifierField.
.. deprecated:: since QGIS 3.10 use setIdentifierValues
.. deprecated:: QGIS 3.10
use setIdentifierValues
%End
void setIdentifierValues( const QVariantList &identifierValues );
@ -143,7 +144,7 @@ Determines if a NULL value should be available in the list.
Field name that will be used to uniquely identify the current feature.
Normally the primary key of the layer.
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
QStringList identifierFields() const;
@ -159,7 +160,7 @@ Normally the primary key of the layer.
Field name that will be used to uniquely identify the current feature.
Normally the primary key of the layer.
.. deprecated:: since QGIS 3.10
.. deprecated:: QGIS 3.10
%End
void setIdentifierFields( const QStringList &identifierFields );

6
python/gui/auto_generated/qgsmaptoolcapture.sip.in
View File

@ -219,7 +219,8 @@ List of digitized points
:return: List of points
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant returns QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant returns QgsPoint objects instead of QgsPointXY.
%End
@ -238,7 +239,8 @@ Set the points on which to work
:param pointList: A list of points
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
void setPoints( const QgsPointSequence &pointList );

3
python/gui/auto_generated/qgsmaptooledit.sip.in
View File

@ -73,7 +73,8 @@ Returns the current vector layer of the map canvas or 0
Adds a list of ``vertices`` to other features to keep topology up to date, e.g. to neighbouring polygons.
The ``vertices`` list specifies a set of topological points to add, in the layer's coordinate reference system.
.. deprecated:: in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
.. deprecated::
in QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
%End
TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &vertices );

3
python/gui/auto_generated/qgsnewvectorlayerdialog.sip.in
View File

@ -26,7 +26,8 @@ If the ``initialPath`` argument is specified, then the dialog will default to th
:return: fileName on success, empty string use aborted, QString() if creation failed
.. deprecated:: in QGIS 3.4.5 - use execAndCreateLayer() instead.
.. deprecated::
in QGIS 3.4.5 - use execAndCreateLayer() instead.
%End
static QString execAndCreateLayer( QString &errorMessage /Out/, QWidget *parent = 0, const QString &initialPath = QString(), QString *encoding /Out/ = 0, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );

24
python/gui/auto_generated/symbology/qgsstylemanagerdialog.sip.in
View File

@ -154,7 +154,8 @@ Opens the associated help
void itemChanged( QStandardItem *item ) /Deprecated/;
%Docstring
.. deprecated:: in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
.. deprecated::
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
%End
void groupChanged( const QModelIndex & );
@ -195,7 +196,8 @@ Triggers the dialog for editing the selected smart group.
void regrouped( QStandardItem * ) /Deprecated/;
%Docstring
.. deprecated:: in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
.. deprecated::
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
%End
void filterSymbols( const QString &filter );
@ -248,7 +250,8 @@ Remove all tags from selected symbols
%Docstring
Populate combo box with known style items (symbols, color ramps).
.. deprecated:: in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
.. deprecated::
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
%End
void populateGroups();
@ -259,21 +262,24 @@ populate the groups
void setSymbolsChecked( const QStringList & ) /Deprecated/;
%Docstring
.. deprecated:: in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
.. deprecated::
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
%End
void populateSymbols( const QStringList &symbolNames, bool checkable = false ) /Deprecated/;
%Docstring
Populates the list view with symbols of the current type with the given names.
.. deprecated:: No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0
.. deprecated::
No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0
%End
void populateColorRamps( const QStringList &colorRamps, bool checkable = false ) /Deprecated/;
%Docstring
Populates the list view with color ramps of the current type with the given names.
.. deprecated:: No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0
.. deprecated::
No longer required in QGIS 3.6, as the model is updated live. Has no effect and will be removed in QGIS 4.0
%End
int currentItemType();
@ -294,13 +300,15 @@ add a new color ramp to style
bool removeSymbol() /Deprecated/;
%Docstring
.. deprecated:: in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
.. deprecated::
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
%End
bool removeColorRamp() /Deprecated/;
%Docstring
.. deprecated:: in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
.. deprecated::
in QGIS 3.6 - has no effect and will be removed in QGIS 4.0
%End
void enableSymbolInputs( bool );

7
scripts/sipify.pl
View File

@ -242,9 +242,12 @@ sub processDoxygenLine {
$FOUND_SINCE = 1;
return "\n.. versionadded:: $1\n";
}
if ( $line =~ m/\\deprecated(.*)/i ) {
if ( $line =~ m/\\deprecated(?:\s+since\s+(?:QGIS\s+)(?<DEPR_VERSION>[0-9.]+)(,\s*)?)?(?<DEPR_MESSAGE>.*)?/i ) {
$INDENT = '';
return "\n.. deprecated::$1\n";
my $depr_line = "\n.. deprecated::";
$depr_line .= " QGIS $+{DEPR_VERSION}" if (defined $+{DEPR_VERSION});
$depr_line .= "\n $+{DEPR_MESSAGE}\n" if (defined $+{DEPR_MESSAGE});
return $depr_line;
}
# create links in see also