mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-22 00:06:12 -05:00
api(deprecated): add message to deprecated SIP annotation
This commit is contained in:
parent
92db5c2d82
commit
ed64834106
@ -132,7 +132,7 @@ it may be useful to temporarily disable scene updates.
|
||||
.. versionadded:: 3.40
|
||||
%End
|
||||
|
||||
static QMap<QString, Qgs3DMapScene *> openScenes() /Deprecated/;
|
||||
static QMap<QString, Qgs3DMapScene *> openScenes() /Deprecated="Since 3.36. Use QgisAppInterface.mapCanvases3D() instead."/;
|
||||
%Docstring
|
||||
Returns a map of 3D map scenes (by name) open in the QGIS application.
|
||||
|
||||
|
@ -75,7 +75,7 @@ Returns width of the line symbol (in map units)
|
||||
Sets width of the line symbol (in map units)
|
||||
%End
|
||||
|
||||
float height() const /Deprecated/;
|
||||
float height() const /Deprecated="Since 3.36. Use offset() instead."/;
|
||||
%Docstring
|
||||
Returns height (altitude) of the symbol (in map units)
|
||||
|
||||
@ -84,7 +84,7 @@ Returns height (altitude) of the symbol (in map units)
|
||||
Use :py:func:`~QgsLine3DSymbol.offset` instead.
|
||||
%End
|
||||
|
||||
void setHeight( float height ) /Deprecated/;
|
||||
void setHeight( float height ) /Deprecated="Since 3.36. Use setOffset() instead."/;
|
||||
%Docstring
|
||||
Sets height (altitude) of the symbol (in map units)
|
||||
|
||||
|
@ -67,7 +67,7 @@ Returns method that determines how altitude is bound to individual vertices
|
||||
Sets method that determines how altitude is bound to individual vertices
|
||||
%End
|
||||
|
||||
float height() const /Deprecated/;
|
||||
float height() const /Deprecated="Since 3.36. Use offset() instead."/;
|
||||
%Docstring
|
||||
Returns height (altitude) of the symbol (in map units)
|
||||
|
||||
@ -76,7 +76,7 @@ Returns height (altitude) of the symbol (in map units)
|
||||
Use :py:func:`~QgsPolygon3DSymbol.offset` instead.
|
||||
%End
|
||||
|
||||
void setHeight( float height ) /Deprecated/;
|
||||
void setHeight( float height ) /Deprecated="Since 3.36. Use setOffset() instead."/;
|
||||
%Docstring
|
||||
Sets height (altitude) of the symbol (in map units)
|
||||
|
||||
|
@ -132,7 +132,7 @@ it may be useful to temporarily disable scene updates.
|
||||
.. versionadded:: 3.40
|
||||
%End
|
||||
|
||||
static QMap<QString, Qgs3DMapScene *> openScenes() /Deprecated/;
|
||||
static QMap<QString, Qgs3DMapScene *> openScenes() /Deprecated="Since 3.36. Use QgisAppInterface.mapCanvases3D() instead."/;
|
||||
%Docstring
|
||||
Returns a map of 3D map scenes (by name) open in the QGIS application.
|
||||
|
||||
|
@ -75,7 +75,7 @@ Returns width of the line symbol (in map units)
|
||||
Sets width of the line symbol (in map units)
|
||||
%End
|
||||
|
||||
float height() const /Deprecated/;
|
||||
float height() const /Deprecated="Since 3.36. Use offset() instead."/;
|
||||
%Docstring
|
||||
Returns height (altitude) of the symbol (in map units)
|
||||
|
||||
@ -84,7 +84,7 @@ Returns height (altitude) of the symbol (in map units)
|
||||
Use :py:func:`~QgsLine3DSymbol.offset` instead.
|
||||
%End
|
||||
|
||||
void setHeight( float height ) /Deprecated/;
|
||||
void setHeight( float height ) /Deprecated="Since 3.36. Use setOffset() instead."/;
|
||||
%Docstring
|
||||
Sets height (altitude) of the symbol (in map units)
|
||||
|
||||
|
@ -67,7 +67,7 @@ Returns method that determines how altitude is bound to individual vertices
|
||||
Sets method that determines how altitude is bound to individual vertices
|
||||
%End
|
||||
|
||||
float height() const /Deprecated/;
|
||||
float height() const /Deprecated="Since 3.36. Use offset() instead."/;
|
||||
%Docstring
|
||||
Returns height (altitude) of the symbol (in map units)
|
||||
|
||||
@ -76,7 +76,7 @@ Returns height (altitude) of the symbol (in map units)
|
||||
Use :py:func:`~QgsPolygon3DSymbol.offset` instead.
|
||||
%End
|
||||
|
||||
void setHeight( float height ) /Deprecated/;
|
||||
void setHeight( float height ) /Deprecated="Since 3.36. Use setOffset() instead."/;
|
||||
%Docstring
|
||||
Sets height (altitude) of the symbol (in map units)
|
||||
|
||||
|
@ -97,7 +97,7 @@ QgsRasterCalculator constructor.
|
||||
%End
|
||||
|
||||
|
||||
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries ) /Deprecated/;
|
||||
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries ) /Deprecated="Since 3.8. Use the version with transformContext instead."/;
|
||||
%Docstring
|
||||
QgsRasterCalculator constructor.
|
||||
|
||||
@ -114,7 +114,7 @@ QgsRasterCalculator constructor.
|
||||
Use the version with transformContext instead.
|
||||
%End
|
||||
|
||||
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries ) /Deprecated/;
|
||||
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries ) /Deprecated="Since 3.8. Use the version with transformContext instead."/;
|
||||
%Docstring
|
||||
QgsRasterCalculator constructor.
|
||||
|
||||
|
@ -191,7 +191,7 @@ Returns a list of available resolution methods.
|
||||
.. versionadded:: 3.12
|
||||
%End
|
||||
|
||||
virtual QStringList resolutionMethods() const /Deprecated/;
|
||||
virtual QStringList resolutionMethods() const /Deprecated="Since 3.12. Use availableResolutionMethods() instead."/;
|
||||
%Docstring
|
||||
Returns a list of descriptions for available resolutions for errors.
|
||||
The index will be passed as ``method`` to :py:func:`fixError`.
|
||||
|
@ -144,7 +144,7 @@ the relative percentage for the position compared to the map width and height.
|
||||
.. seealso:: :py:func:`relativePosition`
|
||||
%End
|
||||
|
||||
void setFrameOffsetFromReferencePoint( QPointF offset ) /Deprecated/;
|
||||
void setFrameOffsetFromReferencePoint( QPointF offset ) /Deprecated="Since 3.40. Use setFrameOffsetFromReferencePointMm() instead."/;
|
||||
%Docstring
|
||||
Sets the annotation's frame's offset (in pixels) from the :py:func:`~QgsAnnotation.mapPosition` reference point.
|
||||
|
||||
@ -155,7 +155,7 @@ Sets the annotation's frame's offset (in pixels) from the :py:func:`~QgsAnnotati
|
||||
Use :py:func:`~QgsAnnotation.setFrameOffsetFromReferencePointMm` instead.
|
||||
%End
|
||||
|
||||
QPointF frameOffsetFromReferencePoint() const /Deprecated/;
|
||||
QPointF frameOffsetFromReferencePoint() const /Deprecated="Since 3.40. Use frameOffsetFromReferencePointMm() instead."/;
|
||||
%Docstring
|
||||
Returns the annotation's frame's offset (in pixels) from the :py:func:`~QgsAnnotation.mapPosition` reference point.
|
||||
|
||||
@ -184,7 +184,7 @@ Returns the annotation's frame's offset (in millimeters) from the :py:func:`~Qgs
|
||||
.. versionadded:: 3.4.8
|
||||
%End
|
||||
|
||||
void setFrameSize( QSizeF size ) /Deprecated/;
|
||||
void setFrameSize( QSizeF size ) /Deprecated="Since 3.40. Use setFrameSizeMm() instead."/;
|
||||
%Docstring
|
||||
Sets the size (in pixels) of the annotation's frame (the main area in which
|
||||
the annotation's content is drawn).
|
||||
@ -196,7 +196,7 @@ the annotation's content is drawn).
|
||||
Use :py:func:`~QgsAnnotation.setFrameSizeMm` instead.
|
||||
%End
|
||||
|
||||
QSizeF frameSize() const /Deprecated/;
|
||||
QSizeF frameSize() const /Deprecated="Since 3.40. Use frameSizeMm() instead."/;
|
||||
%Docstring
|
||||
Returns the size (in pixels) of the annotation's frame (the main area in which
|
||||
the annotation's content is drawn).
|
||||
|
@ -123,7 +123,7 @@ Implementations should include a call to :py:func:`~QgsAnnotationItem.readCommon
|
||||
.. seealso:: :py:func:`readCommonProperties`
|
||||
%End
|
||||
|
||||
virtual Qgis::AnnotationItemEditOperationResult applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) /Deprecated/;
|
||||
virtual Qgis::AnnotationItemEditOperationResult applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) /Deprecated="Since 3.40. Use applyEditV2() instead."/;
|
||||
%Docstring
|
||||
Applies an edit ``operation`` to the item.
|
||||
|
||||
@ -189,7 +189,7 @@ Sets if the item will be rendered or not in the layer.
|
||||
.. versionadded:: 3.36
|
||||
%End
|
||||
|
||||
virtual QList< QgsAnnotationItemNode > nodes() const /Deprecated/;
|
||||
virtual QList< QgsAnnotationItemNode > nodes() const /Deprecated="Since 3.40. Use nodesV2() instead."/;
|
||||
%Docstring
|
||||
Returns the nodes for the item, used for editing the item.
|
||||
|
||||
|
@ -120,7 +120,7 @@ The optional ``feedback`` argument can be used to cancel the search early.
|
||||
.. versionadded:: 3.22
|
||||
%End
|
||||
|
||||
Qgis::AnnotationItemEditOperationResult applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) /Deprecated/;
|
||||
Qgis::AnnotationItemEditOperationResult applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) /Deprecated="Since 3.40. Use applyEditV2() instead."/;
|
||||
%Docstring
|
||||
Applies an edit ``operation`` to the layer.
|
||||
|
||||
|
@ -34,7 +34,7 @@ and to utilize configurations through various authentication method plugins
|
||||
CRITICAL
|
||||
};
|
||||
|
||||
bool init( const QString &pluginPath = QString(), const QString &authDatabasePath = QString() ) /Deprecated/;
|
||||
bool init( const QString &pluginPath = QString(), const QString &authDatabasePath = QString() ) /Deprecated="Since 3.36. Use setup() or ensureInitialized() instead."/;
|
||||
%Docstring
|
||||
init initialize QCA, prioritize qca-ossl plugin and optionally set up the authentication database
|
||||
|
||||
@ -84,7 +84,7 @@ Returns the authentication configuration storage registry.
|
||||
.. versionadded:: 3.40
|
||||
%End
|
||||
|
||||
QSqlDatabase authDatabaseConnection() const /Deprecated/;
|
||||
QSqlDatabase authDatabaseConnection() const /Deprecated="Since 3.40. Direct access to the DB is not allowed, use QgsAuthConfigurationStorage API instead."/;
|
||||
%Docstring
|
||||
Sets up the application instance of the authentication database connection
|
||||
|
||||
@ -93,7 +93,7 @@ Sets up the application instance of the authentication database connection
|
||||
Direct access to the DB is not allowed, use :py:class:`QgsAuthConfigurationStorage` API instead.
|
||||
%End
|
||||
|
||||
const QString authDatabaseConfigTable() const /Deprecated/;
|
||||
const QString authDatabaseConfigTable() const /Deprecated="Since 3.40. Direct access to the DB is not allowed, use methodConfigTableName() instead."/;
|
||||
%Docstring
|
||||
Name of the authentication database table that stores configs
|
||||
|
||||
@ -110,7 +110,7 @@ or an empty string if none available. The table is prefixed with schema and esca
|
||||
.. versionadded:: 3.40
|
||||
%End
|
||||
|
||||
const QString authDatabaseServersTable() const /Deprecated/;
|
||||
const QString authDatabaseServersTable() const /Deprecated="Since 3.40. Direct access to the DB is not allowed, use QgsAuthConfigurationStorage API instead."/;
|
||||
%Docstring
|
||||
Name of the authentication database table that stores server exceptions/configs
|
||||
|
||||
@ -829,7 +829,7 @@ Signals emitted on password helper success,
|
||||
mainly used in the tests to exit main application loop
|
||||
%End
|
||||
|
||||
void messageOut( const QString &message, const QString &tag = QgsAuthManager::AUTH_MAN_TAG, QgsAuthManager::MessageLevel level = QgsAuthManager::INFO ) const /Deprecated/;
|
||||
void messageOut( const QString &message, const QString &tag = QgsAuthManager::AUTH_MAN_TAG, QgsAuthManager::MessageLevel level = QgsAuthManager::INFO ) const /Deprecated="Since 3.40. Use messageLog() instead."/;
|
||||
%Docstring
|
||||
Custom logging signal to relay to console output and :py:class:`QgsMessageLog`
|
||||
|
||||
@ -857,7 +857,7 @@ Custom logging signal to relay to console output and :py:class:`QgsMessageLog`
|
||||
.. versionadded:: 3.40
|
||||
%End
|
||||
|
||||
void passwordHelperMessageOut( const QString &message, const QString &tag = QgsAuthManager::AUTH_MAN_TAG, QgsAuthManager::MessageLevel level = QgsAuthManager::INFO ) /Deprecated/;
|
||||
void passwordHelperMessageOut( const QString &message, const QString &tag = QgsAuthManager::AUTH_MAN_TAG, QgsAuthManager::MessageLevel level = QgsAuthManager::INFO ) /Deprecated="Since 3.40. Use passwordHelperMessageLog() instead."/;
|
||||
%Docstring
|
||||
Custom logging signal to inform the user about master password <-> password manager interactions
|
||||
|
||||
|
@ -142,7 +142,7 @@ items, i.e. it does not fetch children.
|
||||
.. versionadded:: 3.6
|
||||
%End
|
||||
|
||||
void connectItem( QgsDataItem *item ) /Deprecated/;
|
||||
void connectItem( QgsDataItem *item ) /Deprecated="Since 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!)."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.4
|
||||
|
@ -154,7 +154,7 @@ Removes a child item and returns it without deleting it. Emits relevant signals
|
||||
Returns ``True`` if this item is equal to another item (by testing item type and path).
|
||||
%End
|
||||
|
||||
virtual QWidget *paramWidget() /Factory,Deprecated/;
|
||||
virtual QWidget *paramWidget() /Factory,Deprecated="Since 3.10. "/;
|
||||
%Docstring
|
||||
Returns source widget from data item for :py:class:`QgsBrowserPropertiesWidget`
|
||||
|
||||
@ -183,7 +183,7 @@ created menus is correctly handled by parenting them to the specified parent wid
|
||||
:return: list of menus
|
||||
%End
|
||||
|
||||
virtual bool acceptDrop() /Deprecated/;
|
||||
virtual bool acceptDrop() /Deprecated="Since 3.10. "/;
|
||||
%Docstring
|
||||
Returns whether the item accepts drag and dropped layers - e.g. for importing a dataset to a provider.
|
||||
Subclasses should override this and :py:func:`~QgsDataItem.handleDrop` to accept dropped layers.
|
||||
@ -196,7 +196,7 @@ Subclasses should override this and :py:func:`~QgsDataItem.handleDrop` to accept
|
||||
%End
|
||||
|
||||
|
||||
virtual bool handleDrop( const QMimeData * /*data*/, Qt::DropAction /*action*/ ) /Deprecated/;
|
||||
virtual bool handleDrop( const QMimeData * /*data*/, Qt::DropAction /*action*/ ) /Deprecated="Since 3.10. "/;
|
||||
%Docstring
|
||||
Attempts to process the mime data dropped on this item. Subclasses must override this and :py:func:`~QgsDataItem.acceptDrop` if they
|
||||
accept dropped layers.
|
||||
@ -224,7 +224,7 @@ A draggable item has to implement :py:func:`~QgsDataItem.mimeUris` that will be
|
||||
.. seealso:: :py:func:`mimeUris`
|
||||
%End
|
||||
|
||||
virtual QgsMimeDataUtils::Uri mimeUri() const /Deprecated/;
|
||||
virtual QgsMimeDataUtils::Uri mimeUri() const /Deprecated="Since 3.18. Use mimeUris() instead."/;
|
||||
%Docstring
|
||||
Returns mime URI for the data item.
|
||||
Items that return valid URI will be returned in mime data when dragging a selection from browser model.
|
||||
@ -247,7 +247,7 @@ Items that return valid URI will be returned in mime data when dragging a select
|
||||
.. versionadded:: 3.18
|
||||
%End
|
||||
|
||||
virtual bool setCrs( const QgsCoordinateReferenceSystem &crs ) /Deprecated/;
|
||||
virtual bool setCrs( const QgsCoordinateReferenceSystem &crs ) /Deprecated="Since 3.6. This method is no longer used by QGIS and will be removed in QGIS 4.0."/;
|
||||
%Docstring
|
||||
Writes the selected crs into data source. The original data source will be modified when calling this
|
||||
method.
|
||||
@ -257,7 +257,7 @@ method.
|
||||
This method is no longer used by QGIS and will be removed in QGIS 4.0.
|
||||
%End
|
||||
|
||||
virtual bool rename( const QString &name ) /Deprecated/;
|
||||
virtual bool rename( const QString &name ) /Deprecated="Since 3.10. "/;
|
||||
%Docstring
|
||||
Sets a new ``name`` for the item, and returns ``True`` if the item was successfully renamed.
|
||||
|
||||
@ -287,7 +287,7 @@ Sets the capabilities for the data item.
|
||||
.. seealso:: :py:func:`capabilities2`
|
||||
%End
|
||||
|
||||
void setCapabilities( int capabilities ) /Deprecated/;
|
||||
void setCapabilities( int capabilities ) /Deprecated="Since 3.40. Use setCapabilitiesV2() instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
|
@ -107,7 +107,7 @@ If ``color`` is an invalid color then the default icon color will be used.
|
||||
.. versionadded:: 3.20
|
||||
%End
|
||||
|
||||
virtual QWidget *paramWidget() /Factory,Deprecated/;
|
||||
virtual QWidget *paramWidget() /Factory,Deprecated="Since 3.20. "/;
|
||||
|
||||
%Docstring
|
||||
|
||||
|
@ -86,7 +86,7 @@ Returns the icon name of the given ``layerType``
|
||||
.. versionadded:: 3
|
||||
%End
|
||||
|
||||
virtual bool deleteLayer() /Deprecated/;
|
||||
virtual bool deleteLayer() /Deprecated="Since 3.10. "/;
|
||||
%Docstring
|
||||
Delete this layer item
|
||||
Use :py:class:`QgsDataItemGuiProvider`.deleteLayer instead
|
||||
|
@ -47,7 +47,7 @@ Constructor
|
||||
|
||||
static QStringList sProviderNames;
|
||||
|
||||
static QString vsiPrefix( const QString &uri ) /Deprecated/;
|
||||
static QString vsiPrefix( const QString &uri ) /Deprecated="Since 3.40. Will be removed in QGIS 4.0."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
|
@ -442,7 +442,7 @@ The ``calloutContext`` argument is used to specify additional contextual informa
|
||||
how a callout is being rendered.
|
||||
%End
|
||||
|
||||
QgsGeometry labelAnchorGeometry( const QRectF &bodyBoundingBox, const double angle, LabelAnchorPoint anchor ) const /Deprecated/;
|
||||
QgsGeometry labelAnchorGeometry( const QRectF &bodyBoundingBox, const double angle, LabelAnchorPoint anchor ) const /Deprecated="Since 3.20. Use calloutLabelPoint() instead."/;
|
||||
%Docstring
|
||||
Returns the anchor point geometry for a label with the given bounding box and ``anchor`` point mode.
|
||||
|
||||
|
@ -240,7 +240,7 @@ Defines if the trailing 0 are trimmed in the label
|
||||
Transforms a list of classes to a list of breaks
|
||||
%End
|
||||
|
||||
QList<QgsClassificationRange> classes( const QgsVectorLayer *layer, const QString &expression, int nclasses ) /Deprecated/;
|
||||
QList<QgsClassificationRange> classes( const QgsVectorLayer *layer, const QString &expression, int nclasses ) /Deprecated="Since 3.38. Use classesV2() instead."/;
|
||||
%Docstring
|
||||
This will calculate the classes for a given layer to define the classes.
|
||||
|
||||
|
@ -55,7 +55,7 @@ Returns the container type.
|
||||
.. versionadded:: 3.32
|
||||
%End
|
||||
|
||||
virtual void setIsGroupBox( bool isGroupBox ) /Deprecated/;
|
||||
virtual void setIsGroupBox( bool isGroupBox ) /Deprecated="Since 3.40. Use setType() instead."/;
|
||||
%Docstring
|
||||
Determines if this container is rendered as collapsible group box or tab in a tabwidget
|
||||
|
||||
@ -66,7 +66,7 @@ Determines if this container is rendered as collapsible group box or tab in a ta
|
||||
Use :py:func:`~QgsAttributeEditorContainer.setType` instead.
|
||||
%End
|
||||
|
||||
virtual bool isGroupBox() const /Deprecated/;
|
||||
virtual bool isGroupBox() const /Deprecated="Since 3.40. Use type() instead."/;
|
||||
%Docstring
|
||||
Returns if this container is going to be a group box
|
||||
|
||||
|
@ -266,7 +266,7 @@ Write XML information
|
||||
Serialize on project save
|
||||
%End
|
||||
|
||||
QgsAttributeEditorElement *attributeEditorElementFromDomElement( QDomElement &elem, QgsAttributeEditorElement *parent, const QString &layerId = QString(), const QgsReadWriteContext &context = QgsReadWriteContext() ) /Deprecated/;
|
||||
QgsAttributeEditorElement *attributeEditorElementFromDomElement( QDomElement &elem, QgsAttributeEditorElement *parent, const QString &layerId = QString(), const QgsReadWriteContext &context = QgsReadWriteContext() ) /Deprecated="Since 3.18. Use QgsAttributeEditorElement.create instead."/;
|
||||
%Docstring
|
||||
Deserialize drag and drop designer elements.
|
||||
|
||||
|
@ -302,7 +302,7 @@ effects.
|
||||
.. seealso:: :py:func:`sourceAsImage`
|
||||
%End
|
||||
|
||||
void fixQPictureDpi( QPainter *painter ) const /Deprecated/;
|
||||
void fixQPictureDpi( QPainter *painter ) const /Deprecated="Since 3.40. Use QgsPainting.drawPicture() or QgsPainting.applyScaleFixForQPictureDpi() instead."/;
|
||||
%Docstring
|
||||
Applies a workaround to a QPainter to avoid an issue with incorrect scaling
|
||||
when drawing QPictures. This may need to be called by derived classes prior
|
||||
|
@ -562,7 +562,7 @@ quotations where required.
|
||||
.. seealso:: :py:func:`quotedColumnRef`
|
||||
%End
|
||||
|
||||
static QString quotedValue( const QVariant &value, QVariant::Type type ) /Deprecated/;
|
||||
static QString quotedValue( const QVariant &value, QVariant::Type type ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Returns a string representation of a literal value, including appropriate
|
||||
quotations where required.
|
||||
@ -673,7 +673,7 @@ value. The value may be null.
|
||||
:return: the expression to evaluate field equality
|
||||
%End
|
||||
|
||||
static QString createFieldEqualityExpression( const QString &fieldName, const QVariant &value, QVariant::Type fieldType ) /Deprecated/;
|
||||
static QString createFieldEqualityExpression( const QString &fieldName, const QVariant &value, QVariant::Type fieldType ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Create an expression allowing to evaluate if a field is equal to a
|
||||
value. The value may be null.
|
||||
|
@ -46,7 +46,7 @@ The type is expected to be one of
|
||||
- QVariant.Time
|
||||
%End
|
||||
|
||||
static QString defaultFormat( QVariant::Type type ) /Deprecated/;
|
||||
static QString defaultFormat( QVariant::Type type ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Gets the default format in function of the type.
|
||||
The type is expected to be one of
|
||||
@ -72,7 +72,7 @@ The type is expected to be one of
|
||||
.. versionadded:: 3.30
|
||||
%End
|
||||
|
||||
static QString defaultDisplayFormat( QVariant::Type type ) /Deprecated/;
|
||||
static QString defaultDisplayFormat( QVariant::Type type ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Gets the default display format in function of the type.
|
||||
The type is expected to be one of
|
||||
|
@ -148,7 +148,7 @@ and a deep copy. Where possible, use :py:func:`~QgsGeometry.constGet` instead.
|
||||
.. seealso:: :py:func:`set`
|
||||
%End
|
||||
|
||||
void set( QgsAbstractGeometry *geometry /Transfer/ ) /Deprecated/;
|
||||
void set( QgsAbstractGeometry *geometry /Transfer/ ) /Deprecated="Since 3.0. "/;
|
||||
%Docstring
|
||||
Sets the underlying geometry store. Ownership of geometry is transferred.
|
||||
|
||||
@ -856,7 +856,7 @@ Adds a new ring to this geometry. This makes only sense for polygon and multipol
|
||||
:return: OperationResult a result code: success or reason of failure
|
||||
%End
|
||||
|
||||
Qgis::GeometryOperationResult addPart( const QVector<QgsPointXY> &points, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown ) /PyName=addPointsXY,Deprecated/;
|
||||
Qgis::GeometryOperationResult addPart( const QVector<QgsPointXY> &points, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown ) /PyName=addPointsXY,Deprecated="Since 3.38. Will be removed in QGIS 4.0. Use addPartV2 which accepts Qgis.WkbType geometry type instead of Qgis.GeometryType."/;
|
||||
%Docstring
|
||||
Adds a new part to a the geometry.
|
||||
|
||||
@ -882,7 +882,7 @@ Adds a new part to a the geometry.
|
||||
.. versionadded:: 3.38
|
||||
%End
|
||||
|
||||
Qgis::GeometryOperationResult addPart( const QgsPointSequence &points, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown ) /PyName=addPoints,Deprecated/;
|
||||
Qgis::GeometryOperationResult addPart( const QgsPointSequence &points, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown ) /PyName=addPoints,Deprecated="Since 3.38. Will be removed in QGIS 4.0. Use addPartV2 which accepts Qgis.WkbType geometry type instead of Qgis.GeometryType."/;
|
||||
%Docstring
|
||||
Adds a new part to a the geometry.
|
||||
|
||||
@ -908,7 +908,7 @@ Adds a new part to a the geometry.
|
||||
.. versionadded:: 3.38
|
||||
%End
|
||||
|
||||
Qgis::GeometryOperationResult addPart( QgsAbstractGeometry *part /Transfer/, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown ) /Deprecated/;
|
||||
Qgis::GeometryOperationResult addPart( QgsAbstractGeometry *part /Transfer/, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown ) /Deprecated="Since 3.38. Will be removed in QGIS 4.0. Use addPartV2 which accepts Qgis.WkbType geometry type instead of Qgis.GeometryType."/;
|
||||
%Docstring
|
||||
Adds a new part to this geometry.
|
||||
|
||||
@ -2471,7 +2471,7 @@ empty if none of the child geometries match the desired type.
|
||||
.. versionadded:: 3.2
|
||||
%End
|
||||
|
||||
int avoidIntersections( const QList<QgsVectorLayer *> &avoidIntersectionsLayers ) /Deprecated/;
|
||||
int avoidIntersections( const QList<QgsVectorLayer *> &avoidIntersectionsLayers ) /Deprecated="Since 3.34. "/;
|
||||
%Docstring
|
||||
Modifies geometry to avoid intersections with the layers specified in project properties
|
||||
|
||||
@ -2793,7 +2793,7 @@ geometry will be a polyline.
|
||||
:param polygon: source QPolygonF
|
||||
%End
|
||||
|
||||
static QgsPolylineXY createPolylineFromQPolygonF( const QPolygonF &polygon ) /Deprecated/;
|
||||
static QgsPolylineXY createPolylineFromQPolygonF( const QPolygonF &polygon ) /Deprecated="Since 3.40. Use QgsGeometry.fromQPolygonF() or QgsLineString.fromQPolygonF() instead."/;
|
||||
%Docstring
|
||||
Creates a :py:class:`QgsPolylineXY` from a QPolygonF.
|
||||
|
||||
@ -2808,7 +2808,7 @@ Creates a :py:class:`QgsPolylineXY` from a QPolygonF.
|
||||
Use :py:func:`QgsGeometry.fromQPolygonF()` or :py:func:`QgsLineString.fromQPolygonF()` instead.
|
||||
%End
|
||||
|
||||
static QgsPolygonXY createPolygonFromQPolygonF( const QPolygonF &polygon ) /Deprecated/;
|
||||
static QgsPolygonXY createPolygonFromQPolygonF( const QPolygonF &polygon ) /Deprecated="Since 3.40. Use QgsGeometry.fromQPolygonF() or QgsLineString.fromQPolygonF() instead."/;
|
||||
%Docstring
|
||||
Creates a :py:class:`QgsPolygonXYfrom` a QPolygonF.
|
||||
|
||||
|
@ -385,7 +385,7 @@ Create a perpendicular line segment from p to segment [s1, s2]
|
||||
:return: A line (segment) from p to perpendicular point on segment [s1, s2]
|
||||
%End
|
||||
|
||||
static bool setZValueFromPoints( const QgsPointSequence &points, QgsPoint &point ) /Deprecated/;
|
||||
static bool setZValueFromPoints( const QgsPointSequence &points, QgsPoint &point ) /Deprecated="Since 3.20. Use transferFirstZValueToPoint( const QgsPointSequence &points, QgsPoint &point ) instead."/;
|
||||
%Docstring
|
||||
A Z dimension is added to ``point`` if one of the point in the list
|
||||
``points`` is in 3D. Moreover, the Z value of ``point`` is updated
|
||||
@ -493,7 +493,7 @@ looping twice over the set of points.
|
||||
|
||||
|
||||
|
||||
static double sqrDistance2D( double x1, double y1, double x2, double y2 ) /Deprecated,HoldGIL/;
|
||||
static double sqrDistance2D( double x1, double y1, double x2, double y2 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns the squared 2D distance between (``x1``, ``y1``) and (``x2``, ``y2``).
|
||||
|
||||
@ -518,7 +518,7 @@ Returns the squared 3D distance between two points.
|
||||
.. versionadded:: 3.36
|
||||
%End
|
||||
|
||||
static double distance2D( double x1, double y1, double x2, double y2 ) /Deprecated,HoldGIL/;
|
||||
static double distance2D( double x1, double y1, double x2, double y2 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns the 2D distance between (``x1``, ``y1``) and (``x2``, ``y2``).
|
||||
|
||||
@ -544,7 +544,7 @@ Returns the 3D distance between two points.
|
||||
%End
|
||||
|
||||
|
||||
static double sqrDistToLine( double ptX, double ptY, double x1, double y1, double x2, double y2, double &minDistX /Out/, double &minDistY /Out/, double epsilon ) /Deprecated,HoldGIL/;
|
||||
static double sqrDistToLine( double ptX, double ptY, double x1, double y1, double x2, double y2, double &minDistX /Out/, double &minDistY /Out/, double epsilon ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns the squared distance between a point and a line.
|
||||
|
||||
@ -553,7 +553,7 @@ Returns the squared distance between a point and a line.
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static int leftOfLine( const double x, const double y, const double x1, const double y1, const double x2, const double y2 ) /Deprecated,HoldGIL/;
|
||||
static int leftOfLine( const double x, const double y, const double x1, const double y1, const double x2, const double y2 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns a value < 0 if the point (``x``, ``y``) is left of the line from (``x1``, ``y1``) -> (``x2``, ``y2``).
|
||||
A positive return value indicates the point is to the right of the line.
|
||||
@ -605,7 +605,7 @@ Example
|
||||
|
||||
|
||||
|
||||
static double ccwAngle( double dy, double dx ) /Deprecated,HoldGIL/;
|
||||
static double ccwAngle( double dy, double dx ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns the counter clockwise angle between a line with components dx, dy and the line with dx > 0 and dy = 0
|
||||
|
||||
@ -615,7 +615,7 @@ Returns the counter clockwise angle between a line with components dx, dy and th
|
||||
%End
|
||||
|
||||
|
||||
static bool circleClockwise( double angle1, double angle2, double angle3 ) /Deprecated,HoldGIL/;
|
||||
static bool circleClockwise( double angle1, double angle2, double angle3 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns ``True`` if the circle defined by three angles is ordered clockwise.
|
||||
|
||||
@ -627,7 +627,7 @@ Euclidean angles as opposed to geographic "North up" angles.
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static bool circleAngleBetween( double angle, double angle1, double angle2, bool clockwise ) /Deprecated,HoldGIL/;
|
||||
static bool circleAngleBetween( double angle, double angle1, double angle2, bool clockwise ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns ``True`` if, in a circle, angle is between angle1 and angle2
|
||||
|
||||
@ -636,7 +636,7 @@ Returns ``True`` if, in a circle, angle is between angle1 and angle2
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static bool angleOnCircle( double angle, double angle1, double angle2, double angle3 ) /Deprecated,HoldGIL/;
|
||||
static bool angleOnCircle( double angle, double angle1, double angle2, double angle3 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns ``True`` if an angle is between angle1 and angle3 on a circle described by
|
||||
angle1, angle2 and angle3.
|
||||
@ -646,7 +646,7 @@ angle1, angle2 and angle3.
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double circleLength( double x1, double y1, double x2, double y2, double x3, double y3 ) /Deprecated,HoldGIL/;
|
||||
static double circleLength( double x1, double y1, double x2, double y2, double x3, double y3 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Length of a circular string segment defined by pt1, pt2, pt3
|
||||
|
||||
@ -655,7 +655,7 @@ Length of a circular string segment defined by pt1, pt2, pt3
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double sweepAngle( double centerX, double centerY, double x1, double y1, double x2, double y2, double x3, double y3 ) /Deprecated,HoldGIL/;
|
||||
static double sweepAngle( double centerX, double centerY, double x1, double y1, double x2, double y2, double x3, double y3 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Calculates angle of a circular string part defined by pt1, pt2, pt3
|
||||
|
||||
@ -664,7 +664,7 @@ Calculates angle of a circular string part defined by pt1, pt2, pt3
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double interpolateArcValue( double angle, double a1, double a2, double a3, double zm1, double zm2, double zm3 ) /Deprecated,HoldGIL/;
|
||||
static double interpolateArcValue( double angle, double a1, double a2, double a3, double zm1, double zm2, double zm3 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Interpolate a value at given angle on circular arc given values (zm1, zm2, zm3) at three different angles (a1, a2, a3).
|
||||
|
||||
@ -673,7 +673,7 @@ Interpolate a value at given angle on circular arc given values (zm1, zm2, zm3)
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double normalizedAngle( double angle ) /Deprecated,HoldGIL/;
|
||||
static double normalizedAngle( double angle ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Ensures that an angle is in the range 0 <= angle < 2 pi.
|
||||
|
||||
@ -686,7 +686,7 @@ Ensures that an angle is in the range 0 <= angle < 2 pi.
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double lineAngle( double x1, double y1, double x2, double y2 ) /Deprecated,HoldGIL/;
|
||||
static double lineAngle( double x1, double y1, double x2, double y2 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Calculates the direction of line joining two points in radians, clockwise from the north direction.
|
||||
|
||||
@ -702,7 +702,7 @@ Calculates the direction of line joining two points in radians, clockwise from t
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double angleBetweenThreePoints( double x1, double y1, double x2, double y2, double x3, double y3 ) /Deprecated,HoldGIL/;
|
||||
static double angleBetweenThreePoints( double x1, double y1, double x2, double y2, double x3, double y3 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Calculates the angle between the lines AB and BC, where AB and BC described
|
||||
by points a, b and b, c.
|
||||
@ -721,7 +721,7 @@ by points a, b and b, c.
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double linePerpendicularAngle( double x1, double y1, double x2, double y2 ) /Deprecated,HoldGIL/;
|
||||
static double linePerpendicularAngle( double x1, double y1, double x2, double y2 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Calculates the perpendicular angle to a line joining two points. Returned angle is in radians,
|
||||
clockwise from the north direction.
|
||||
@ -738,7 +738,7 @@ clockwise from the north direction.
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double averageAngle( double x1, double y1, double x2, double y2, double x3, double y3 ) /Deprecated,HoldGIL/;
|
||||
static double averageAngle( double x1, double y1, double x2, double y2, double x3, double y3 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Calculates the average angle (in radians) between the two linear segments from
|
||||
(``x1``, ``y1``) to (``x2``, ``y2``) and (``x2``, ``y2``) to (``x3``, ``y3``).
|
||||
@ -748,7 +748,7 @@ Calculates the average angle (in radians) between the two linear segments from
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double averageAngle( double a1, double a2 ) /Deprecated,HoldGIL/;
|
||||
static double averageAngle( double a1, double a2 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Averages two angles, correctly handling negative angles and ensuring the result is between 0 and 2 pi.
|
||||
|
||||
@ -826,7 +826,7 @@ The result is a line (segment) centered in point p and perpendicular to segment
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double skewLinesDistance( const QgsVector3D &P1, const QgsVector3D &P12, const QgsVector3D &P2, const QgsVector3D &P22 ) /Deprecated,HoldGIL/;
|
||||
static double skewLinesDistance( const QgsVector3D &P1, const QgsVector3D &P12, const QgsVector3D &P2, const QgsVector3D &P22 ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
An algorithm to calculate the shortest distance between two skew lines.
|
||||
|
||||
@ -911,7 +911,7 @@ Example
|
||||
Use :py:class:`QgsGeometryUtilsBase` methods instead.
|
||||
%End
|
||||
|
||||
static double triangleArea( double aX, double aY, double bX, double bY, double cX, double cY ) /Deprecated,HoldGIL/;
|
||||
static double triangleArea( double aX, double aY, double bX, double bY, double cX, double cY ) /Deprecated="Since 3.40. Use QgsGeometryUtilsBase methods instead.",HoldGIL/;
|
||||
%Docstring
|
||||
Returns the area of the triangle denoted by the points (``aX``, ``aY``), (``bX``, ``bY``) and
|
||||
(``cX``, ``cY``).
|
||||
|
@ -854,7 +854,7 @@ corresponds to the last point in the line.
|
||||
%End
|
||||
|
||||
|
||||
QgsBox3D calculateBoundingBox3d() const /Deprecated/;
|
||||
QgsBox3D calculateBoundingBox3d() const /Deprecated="Since 3.34. use calculateBoundingBox3D() instead"/;
|
||||
%Docstring
|
||||
Calculates the minimal 3D bounding box for the geometry.
|
||||
|
||||
|
@ -120,7 +120,7 @@ A null rectangle is also empty by definition.
|
||||
.. versionadded:: 3.34
|
||||
%End
|
||||
|
||||
void setMinimal() /Deprecated/;
|
||||
void setMinimal() /Deprecated="Since 3.34. Will be removed in QGIS 4.0. Use setNull()."/;
|
||||
%Docstring
|
||||
Set a rectangle so that min corner is at max
|
||||
and max corner is at min. It is NOT normalized.
|
||||
|
@ -76,7 +76,7 @@ Call :py:func:`~QgsGpsDetector.takeConnection` to take ownership of the detected
|
||||
.. versionadded:: 3.38
|
||||
%End
|
||||
|
||||
void detected( QgsGpsConnection *connection ) /Deprecated/;
|
||||
void detected( QgsGpsConnection *connection ) /Deprecated="Since 3.40. This signal is dangerous and extremely unsafe! It is recommended to instead set the ``useUnsafeSignals`` parameter to ``False`` in the QgsGpsDetector constructor and use the safe connectionDetected() signal instead."/;
|
||||
%Docstring
|
||||
Emitted when the GPS connection has been detected. A single connection must listen for this signal and
|
||||
immediately take ownership of the ``connection`` object.
|
||||
|
@ -113,7 +113,7 @@ Returns whether the connection information is valid
|
||||
.. versionadded:: 3.10
|
||||
%End
|
||||
|
||||
Qgis::GpsFixStatus fixStatus() const /Deprecated/;
|
||||
Qgis::GpsFixStatus fixStatus() const /Deprecated="Since 3.40. Use constellationFixStatus() or bestFixStatus() instead."/;
|
||||
%Docstring
|
||||
Returns the fix status
|
||||
|
||||
|
@ -92,7 +92,7 @@ Sets the maximum number of polygon label ``candidates`` per centimeter squared.
|
||||
.. versionadded:: 3.12
|
||||
%End
|
||||
|
||||
void numCandidatePositions( int &candPoint, int &candLine, int &candPolygon ) const /Deprecated/;
|
||||
void numCandidatePositions( int &candPoint, int &candLine, int &candPolygon ) const /Deprecated="Since 3.12. Use maximumPolygonCandidatesPerCmSquared() and maximumLineCandidatesPerCm() instead."/;
|
||||
%Docstring
|
||||
Gets number of candidate positions that will be generated for each label feature.
|
||||
|
||||
@ -101,7 +101,7 @@ Gets number of candidate positions that will be generated for each label feature
|
||||
Use :py:func:`~QgsLabelingEngineSettings.maximumPolygonCandidatesPerCmSquared` and :py:func:`~QgsLabelingEngineSettings.maximumLineCandidatesPerCm` instead.
|
||||
%End
|
||||
|
||||
void setNumCandidatePositions( int candPoint, int candLine, int candPolygon ) /Deprecated/;
|
||||
void setNumCandidatePositions( int candPoint, int candLine, int candPolygon ) /Deprecated="Since 3.12. Use setMaximumPolygonCandidatesPerCmSquared() and setMaximumLineCandidatesPerCm() instead."/;
|
||||
%Docstring
|
||||
Sets the number of candidate positions that will be generated for each label feature.
|
||||
|
||||
@ -110,7 +110,7 @@ Sets the number of candidate positions that will be generated for each label fea
|
||||
Use :py:func:`~QgsLabelingEngineSettings.setMaximumPolygonCandidatesPerCmSquared` and :py:func:`~QgsLabelingEngineSettings.setMaximumLineCandidatesPerCm` instead.
|
||||
%End
|
||||
|
||||
void setSearchMethod( Search s ) /Deprecated/;
|
||||
void setSearchMethod( Search s ) /Deprecated="Since 3.10. Chain is always used."/;
|
||||
%Docstring
|
||||
Used to set which search method to use for removal collisions between labels
|
||||
|
||||
@ -119,7 +119,7 @@ Used to set which search method to use for removal collisions between labels
|
||||
Chain is always used.
|
||||
%End
|
||||
|
||||
Search searchMethod() const /Deprecated/;
|
||||
Search searchMethod() const /Deprecated="Since 3.10. Chain is always used."/;
|
||||
%Docstring
|
||||
Which search method to use for removal collisions between labels
|
||||
|
||||
|
@ -27,7 +27,7 @@ A class to query the labeling structure at a given point (small wrapper around p
|
||||
~QgsLabelSearchTree();
|
||||
|
||||
|
||||
void clear() /Deprecated/;
|
||||
void clear() /Deprecated="Since 3.40. Has no effect since QGIS 3.12."/;
|
||||
%Docstring
|
||||
Removes and deletes all the entries.
|
||||
|
||||
|
@ -371,7 +371,7 @@ legendString
|
||||
:return: the string to show in the legend and in the preview icon
|
||||
%End
|
||||
|
||||
void calculateLabelSize( const QFontMetricsF *fm, const QString &text, double &labelX, double &labelY, const QgsFeature *f = 0, QgsRenderContext *context = 0, double *rotatedLabelX /Out/ = 0, double *rotatedLabelY /Out/ = 0 ) /Deprecated/;
|
||||
void calculateLabelSize( const QFontMetricsF *fm, const QString &text, double &labelX, double &labelY, const QgsFeature *f = 0, QgsRenderContext *context = 0, double *rotatedLabelX /Out/ = 0, double *rotatedLabelY /Out/ = 0 ) /Deprecated="Since 3.40. Will be removed from public API in QGIS 4.0."/;
|
||||
%Docstring
|
||||
Calculates the space required to render the provided ``text`` in map units.
|
||||
Results will be written to ``labelX`` and ``labelY``.
|
||||
|
@ -234,7 +234,7 @@ A scale <= 0 indicates that no scale filtering is being performed.
|
||||
.. seealso:: :py:func:`setLegendFilterByScale`
|
||||
%End
|
||||
|
||||
void setLegendFilterByMap( const QgsMapSettings *settings ) /Deprecated/;
|
||||
void setLegendFilterByMap( const QgsMapSettings *settings ) /Deprecated="Since 3.32. Use setFilterSettings() instead."/;
|
||||
%Docstring
|
||||
Force only display of legend nodes which are valid for given map settings.
|
||||
Setting ``None`` or invalid map settings will disable the functionality.
|
||||
@ -245,7 +245,7 @@ Ownership of map settings pointer does not change, a copy is made.
|
||||
Use :py:func:`~QgsLayerTreeModel.setFilterSettings` instead.
|
||||
%End
|
||||
|
||||
void setLegendFilter( const QgsMapSettings *settings, bool useExtent = true, const QgsGeometry &polygon = QgsGeometry(), bool useExpressions = true ) /Deprecated/;
|
||||
void setLegendFilter( const QgsMapSettings *settings, bool useExtent = true, const QgsGeometry &polygon = QgsGeometry(), bool useExpressions = true ) /Deprecated="Since 3.32. Use setFilterSettings() instead."/;
|
||||
%Docstring
|
||||
Filter display of legend nodes for given map settings
|
||||
|
||||
|
@ -50,7 +50,7 @@ Create the instance that synchronizes given project with a layer tree root
|
||||
void setNewLayersVisible( bool enabled );
|
||||
bool newLayersVisible() const;
|
||||
|
||||
void setLayerInsertionPoint( QgsLayerTreeGroup *parentGroup, int index ) /Deprecated/;
|
||||
void setLayerInsertionPoint( QgsLayerTreeGroup *parentGroup, int index ) /Deprecated="Since 3.10. Use setLayerInsertionPoint( const InsertionPoint &insertionPoint ) instead."/;
|
||||
%Docstring
|
||||
Set where the new layers should be inserted - can be used to follow current selection.
|
||||
By default it is root group with zero index.
|
||||
|
@ -29,7 +29,7 @@ onto a scene with custom composition modes.
|
||||
|
||||
QgsLayoutEffect();
|
||||
|
||||
void setCompositionMode( QPainter::CompositionMode mode ) /Deprecated/;
|
||||
void setCompositionMode( QPainter::CompositionMode mode ) /Deprecated="Since 3.34. This class should not be used, it is non-stable and results in crashes. See https//bugreports.qt.io/browse/QTBUG-58501."/;
|
||||
%Docstring
|
||||
Sets the composition (blending) ``mode`` used for rendering
|
||||
the item.
|
||||
@ -41,7 +41,7 @@ the item.
|
||||
This class should not be used, it is non-stable and results in crashes. See https://bugreports.qt.io/browse/QTBUG-58501.
|
||||
%End
|
||||
|
||||
QPainter::CompositionMode compositionMode() const /Deprecated/;
|
||||
QPainter::CompositionMode compositionMode() const /Deprecated="Since 3.34. This class should not be used, it is non-stable and results in crashes. See https//bugreports.qt.io/browse/QTBUG-58501."/;
|
||||
%Docstring
|
||||
Returns the composition (blending) mode used for rendering
|
||||
the item.
|
||||
|
@ -441,7 +441,7 @@ Returns the behavior of this item during exporting to layered exports (e.g. SVG
|
||||
.. versionadded:: 3.10
|
||||
%End
|
||||
|
||||
virtual int numberExportLayers() const /Deprecated/;
|
||||
virtual int numberExportLayers() const /Deprecated="Since 3.40. Use nextExportPart() and exportLayerBehavior() instead."/;
|
||||
%Docstring
|
||||
Returns the number of layers that this item requires for exporting during layered exports (e.g. SVG).
|
||||
Returns 0 if this item is to be placed on the same layer as the previous item,
|
||||
|
@ -109,7 +109,7 @@ to switch between font based and HTML based rendering.
|
||||
.. seealso:: :py:func:`mode`
|
||||
%End
|
||||
|
||||
QFont font() const /Deprecated/;
|
||||
QFont font() const /Deprecated="Since 3.40. Use textFormat() instead (since QGIS 3.24)."/;
|
||||
%Docstring
|
||||
Returns the label's current font.
|
||||
|
||||
@ -120,7 +120,7 @@ Returns the label's current font.
|
||||
Use :py:func:`~QgsLayoutItemLabel.textFormat` instead (since QGIS 3.24).
|
||||
%End
|
||||
|
||||
void setFont( const QFont &font ) /Deprecated/;
|
||||
void setFont( const QFont &font ) /Deprecated="Since 3.40. Use setTextFormat() instead (since QGIS 3.24)."/;
|
||||
%Docstring
|
||||
Sets the label's current ``font``.
|
||||
|
||||
@ -221,7 +221,7 @@ contents, in layout units.
|
||||
.. seealso:: :py:func:`setMarginX`
|
||||
%End
|
||||
|
||||
void setFontColor( const QColor &color ) /Deprecated/;
|
||||
void setFontColor( const QColor &color ) /Deprecated="Since 3.40. Use setTextFormat() instead (since QGIS 3.24)."/;
|
||||
%Docstring
|
||||
Sets the label font ``color``.
|
||||
|
||||
@ -232,7 +232,7 @@ Sets the label font ``color``.
|
||||
Use :py:func:`~QgsLayoutItemLabel.setTextFormat` instead (since QGIS 3.24).
|
||||
%End
|
||||
|
||||
QColor fontColor() const /Deprecated/;
|
||||
QColor fontColor() const /Deprecated="Since 3.40. Use textFormat() instead (since QGIS 3.24)."/;
|
||||
%Docstring
|
||||
Returns the label font color.
|
||||
|
||||
|
@ -211,7 +211,7 @@ Returns legend style.
|
||||
Sets the style of ``component`` to ``style`` for the legend.
|
||||
%End
|
||||
|
||||
QFont styleFont( QgsLegendStyle::Style component ) const /Deprecated/;
|
||||
QFont styleFont( QgsLegendStyle::Style component ) const /Deprecated="Since 3.40. Use QgsLegendStyle.textFormat() from style() instead."/;
|
||||
%Docstring
|
||||
Returns the font settings for a legend ``component``.
|
||||
|
||||
@ -222,7 +222,7 @@ Returns the font settings for a legend ``component``.
|
||||
Use :py:func:`QgsLegendStyle.textFormat()` from :py:func:`~QgsLayoutItemLegend.style` instead.
|
||||
%End
|
||||
|
||||
void setStyleFont( QgsLegendStyle::Style component, const QFont &font ) /Deprecated/;
|
||||
void setStyleFont( QgsLegendStyle::Style component, const QFont &font ) /Deprecated="Since 3.40. Use QgsLegendStyle.setTextFormat() from style() instead."/;
|
||||
%Docstring
|
||||
Sets the style ``font`` for a legend ``component``.
|
||||
|
||||
@ -243,7 +243,7 @@ Set the ``margin`` for a legend ``component``.
|
||||
Set the ``margin`` for a particular ``side`` of a legend ``component``.
|
||||
%End
|
||||
|
||||
double lineSpacing() const /Deprecated/;
|
||||
double lineSpacing() const /Deprecated="Since 3.40. Use QgsLegendStyle.textFormat() from style() instead."/;
|
||||
%Docstring
|
||||
Returns the spacing in-between lines in layout units.
|
||||
|
||||
@ -254,7 +254,7 @@ Returns the spacing in-between lines in layout units.
|
||||
Use :py:func:`QgsLegendStyle.textFormat()` from :py:func:`~QgsLayoutItemLegend.style` instead.
|
||||
%End
|
||||
|
||||
void setLineSpacing( double spacing ) /Deprecated/;
|
||||
void setLineSpacing( double spacing ) /Deprecated="Since 3.40. Use QgsLegendStyle.setTextFormat() from style() instead."/;
|
||||
%Docstring
|
||||
Sets the ``spacing`` in-between multiple lines.
|
||||
|
||||
@ -293,7 +293,7 @@ Sets the legend column ``spacing``.
|
||||
.. seealso:: :py:func:`columnSpace`
|
||||
%End
|
||||
|
||||
QColor fontColor() const /Deprecated/;
|
||||
QColor fontColor() const /Deprecated="Since 3.40. Use QgsLegendStyle.setTextFormat() from style() instead."/;
|
||||
%Docstring
|
||||
Returns the legend font color.
|
||||
|
||||
@ -304,7 +304,7 @@ Returns the legend font color.
|
||||
Use :py:func:`QgsLegendStyle.setTextFormat()` from :py:func:`~QgsLayoutItemLegend.style` instead.
|
||||
%End
|
||||
|
||||
void setFontColor( const QColor &color ) /Deprecated/;
|
||||
void setFontColor( const QColor &color ) /Deprecated="Since 3.40. Use QgsLegendStyle.setTextFormat() from style() instead."/;
|
||||
%Docstring
|
||||
Sets the legend font ``color``.
|
||||
|
||||
|
@ -362,7 +362,7 @@ The caller takes responsibility for deleting the returned object.
|
||||
virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget );
|
||||
|
||||
|
||||
virtual int numberExportLayers() const /Deprecated/;
|
||||
virtual int numberExportLayers() const /Deprecated="Since 3.10. "/;
|
||||
|
||||
%Docstring
|
||||
|
||||
|
@ -589,7 +589,7 @@ Returns the text format used when rendering grid annotations.
|
||||
.. versionadded:: 3.16
|
||||
%End
|
||||
|
||||
void setAnnotationFont( const QFont &font ) /Deprecated/;
|
||||
void setAnnotationFont( const QFont &font ) /Deprecated="Since 3.40. Use setAnnotationTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the ``font`` used for drawing grid annotations.
|
||||
Shortcut for :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.setFont().
|
||||
@ -601,7 +601,7 @@ Shortcut for :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.setFont().
|
||||
Use :py:func:`~QgsLayoutItemMapGrid.setAnnotationTextFormat` instead.
|
||||
%End
|
||||
|
||||
QFont annotationFont() const /Deprecated/;
|
||||
QFont annotationFont() const /Deprecated="Since 3.40. Use annotationTextFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the font used for drawing grid annotations.
|
||||
Shortcut for :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.font().
|
||||
@ -613,7 +613,7 @@ Shortcut for :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.font().
|
||||
Use :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat` instead.
|
||||
%End
|
||||
|
||||
void setAnnotationFontColor( const QColor &color ) /Deprecated/;
|
||||
void setAnnotationFontColor( const QColor &color ) /Deprecated="Since 3.40. Use setAnnotationTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the font ``color`` used for drawing grid annotations.
|
||||
Shortcut for :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.setColor() and :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.setOpacity().
|
||||
@ -625,7 +625,7 @@ Shortcut for :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.setColor() an
|
||||
Use :py:func:`~QgsLayoutItemMapGrid.setAnnotationTextFormat` instead.
|
||||
%End
|
||||
|
||||
QColor annotationFontColor() const /Deprecated/;
|
||||
QColor annotationFontColor() const /Deprecated="Since 3.40. Use annotationTextFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the font color used for drawing grid annotations.
|
||||
Shortcut for :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.color() and :py:func:`~QgsLayoutItemMapGrid.annotationTextFormat`.opacity().
|
||||
|
@ -392,7 +392,7 @@ transferred to the scalebar.
|
||||
.. versionadded:: 3.14
|
||||
%End
|
||||
|
||||
QFont font() const /Deprecated/;
|
||||
QFont font() const /Deprecated="Since 3.40. Use textFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the font used for drawing text in the scalebar.
|
||||
|
||||
@ -403,7 +403,7 @@ Returns the font used for drawing text in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.textFormat` instead.
|
||||
%End
|
||||
|
||||
void setFont( const QFont &font ) /Deprecated/;
|
||||
void setFont( const QFont &font ) /Deprecated="Since 3.40. Use setTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the ``font`` used for drawing text in the scalebar.
|
||||
|
||||
@ -414,7 +414,7 @@ Sets the ``font`` used for drawing text in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.setTextFormat` instead.
|
||||
%End
|
||||
|
||||
QColor fontColor() const /Deprecated/;
|
||||
QColor fontColor() const /Deprecated="Since 3.40. Use textFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the color used for drawing text in the scalebar.
|
||||
|
||||
@ -427,7 +427,7 @@ Returns the color used for drawing text in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.textFormat` instead.
|
||||
%End
|
||||
|
||||
void setFontColor( const QColor &color ) /Deprecated/;
|
||||
void setFontColor( const QColor &color ) /Deprecated="Since 3.40. Use setTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the ``color`` used for drawing text in the scalebar.
|
||||
|
||||
@ -440,7 +440,7 @@ Sets the ``color`` used for drawing text in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.setTextFormat` instead.
|
||||
%End
|
||||
|
||||
QColor fillColor() const /Deprecated/;
|
||||
QColor fillColor() const /Deprecated="Since 3.40. Use fillSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the color used for fills in the scalebar.
|
||||
|
||||
@ -453,7 +453,7 @@ Returns the color used for fills in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.fillSymbol` instead.
|
||||
%End
|
||||
|
||||
void setFillColor( const QColor &color ) /Deprecated/;
|
||||
void setFillColor( const QColor &color ) /Deprecated="Since 3.40. Use setFillSymbol() instead."/;
|
||||
%Docstring
|
||||
Sets the ``color`` used for fills in the scalebar.
|
||||
|
||||
@ -466,7 +466,7 @@ Sets the ``color`` used for fills in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.setFillSymbol` instead.
|
||||
%End
|
||||
|
||||
QColor fillColor2() const /Deprecated/;
|
||||
QColor fillColor2() const /Deprecated="Since 3.40. Use alternateFillSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the secondary color used for fills in the scalebar.
|
||||
|
||||
@ -479,7 +479,7 @@ Returns the secondary color used for fills in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.alternateFillSymbol` instead.
|
||||
%End
|
||||
|
||||
void setFillColor2( const QColor &color ) /Deprecated/;
|
||||
void setFillColor2( const QColor &color ) /Deprecated="Since 3.40. Use setAlternateFillSymbol() instead."/;
|
||||
%Docstring
|
||||
Sets the secondary ``color`` used for fills in the scalebar.
|
||||
|
||||
@ -492,7 +492,7 @@ Sets the secondary ``color`` used for fills in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.setAlternateFillSymbol` instead.
|
||||
%End
|
||||
|
||||
QColor lineColor() const /Deprecated/;
|
||||
QColor lineColor() const /Deprecated="Since 3.40. Use lineSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the color used for lines in the scalebar.
|
||||
|
||||
@ -503,7 +503,7 @@ Returns the color used for lines in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.lineSymbol` instead.
|
||||
%End
|
||||
|
||||
void setLineColor( const QColor &color ) /Deprecated/;
|
||||
void setLineColor( const QColor &color ) /Deprecated="Since 3.40. Use setLineSymbol() instead."/;
|
||||
%Docstring
|
||||
Sets the ``color`` used for lines in the scalebar.
|
||||
|
||||
@ -514,7 +514,7 @@ Sets the ``color`` used for lines in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.setLineSymbol` instead.
|
||||
%End
|
||||
|
||||
double lineWidth() const /Deprecated/;
|
||||
double lineWidth() const /Deprecated="Since 3.40. Use lineSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the line width in millimeters for lines in the scalebar.
|
||||
|
||||
@ -525,7 +525,7 @@ Returns the line width in millimeters for lines in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.lineSymbol` instead.
|
||||
%End
|
||||
|
||||
void setLineWidth( double width ) /Deprecated/;
|
||||
void setLineWidth( double width ) /Deprecated="Since 3.40. Use setLineSymbol() instead."/;
|
||||
%Docstring
|
||||
Sets the line ``width`` in millimeters for lines in the scalebar.
|
||||
|
||||
@ -536,7 +536,7 @@ Sets the line ``width`` in millimeters for lines in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.setLineSymbol` instead.
|
||||
%End
|
||||
|
||||
QPen pen() const /Deprecated/;
|
||||
QPen pen() const /Deprecated="Since 3.40. Use lineSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the pen used for drawing outlines in the scalebar.
|
||||
|
||||
@ -547,7 +547,7 @@ Returns the pen used for drawing outlines in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.lineSymbol` instead.
|
||||
%End
|
||||
|
||||
QBrush brush() const /Deprecated/;
|
||||
QBrush brush() const /Deprecated="Since 3.40. Use fillSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the primary brush for the scalebar.
|
||||
|
||||
@ -562,7 +562,7 @@ Returns the primary brush for the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.fillSymbol` instead.
|
||||
%End
|
||||
|
||||
QBrush brush2() const /Deprecated/;
|
||||
QBrush brush2() const /Deprecated="Since 3.40. Use alternateFillSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the secondary brush for the scalebar. This is used for alternating color style scalebars, such
|
||||
as single and double box styles.
|
||||
@ -696,7 +696,7 @@ Sets the distance ``units`` used by the scalebar.
|
||||
.. seealso:: :py:func:`units`
|
||||
%End
|
||||
|
||||
Qt::PenJoinStyle lineJoinStyle() const /Deprecated/;
|
||||
Qt::PenJoinStyle lineJoinStyle() const /Deprecated="Since 3.40. Use lineSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the join style used for drawing lines in the scalebar.
|
||||
|
||||
@ -707,7 +707,7 @@ Returns the join style used for drawing lines in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.lineSymbol` instead.
|
||||
%End
|
||||
|
||||
void setLineJoinStyle( Qt::PenJoinStyle style ) /Deprecated/;
|
||||
void setLineJoinStyle( Qt::PenJoinStyle style ) /Deprecated="Since 3.40. Use setLineSymbol() instead."/;
|
||||
%Docstring
|
||||
Sets the join ``style`` used when drawing the lines in the scalebar
|
||||
|
||||
@ -718,7 +718,7 @@ Sets the join ``style`` used when drawing the lines in the scalebar
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.setLineSymbol` instead.
|
||||
%End
|
||||
|
||||
Qt::PenCapStyle lineCapStyle() const /Deprecated/;
|
||||
Qt::PenCapStyle lineCapStyle() const /Deprecated="Since 3.40. Use lineSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the cap style used for drawing lines in the scalebar.
|
||||
|
||||
@ -729,7 +729,7 @@ Returns the cap style used for drawing lines in the scalebar.
|
||||
Use :py:func:`~QgsLayoutItemScaleBar.lineSymbol` instead.
|
||||
%End
|
||||
|
||||
void setLineCapStyle( Qt::PenCapStyle style ) /Deprecated/;
|
||||
void setLineCapStyle( Qt::PenCapStyle style ) /Deprecated="Since 3.40. Use setLineSymbol() instead."/;
|
||||
%Docstring
|
||||
Sets the cap ``style`` used when drawing the lines in the scalebar.
|
||||
|
||||
|
@ -193,7 +193,7 @@ Ownership is not transferred, and a copy of the symbol is created internally.
|
||||
.. seealso:: :py:func:`pageStyleSymbol`
|
||||
%End
|
||||
|
||||
const QgsFillSymbol *pageStyleSymbol() const /Deprecated/;
|
||||
const QgsFillSymbol *pageStyleSymbol() const /Deprecated="Since 3.40. Use QgsLayoutItemPage.pageStyleSymbol() instead."/;
|
||||
%Docstring
|
||||
Returns the symbol to use for drawing pages in the collection.
|
||||
|
||||
|
@ -185,7 +185,7 @@ whether they will be rendered in layout exports.
|
||||
.. seealso:: :py:func:`setPagesVisible`
|
||||
%End
|
||||
|
||||
void setCurrentExportLayer( int layer = -1 ) /Deprecated/;
|
||||
void setCurrentExportLayer( int layer = -1 ) /Deprecated="Since 3.40. Items should now handle this themselves, via QgsLayoutItem.exportLayerBehavior() and returning QgsLayoutItem.nextExportPart()."/;
|
||||
%Docstring
|
||||
Sets the current item ``layer`` to draw while exporting. :py:class:`QgsLayoutItem` subclasses
|
||||
which support multi-layer SVG exports must check the :py:func:`~QgsLayoutRenderContext.currentExportLayer`
|
||||
@ -200,7 +200,7 @@ If ``layer`` is -1, all item layers will be rendered.
|
||||
Items should now handle this themselves, via :py:func:`QgsLayoutItem.exportLayerBehavior()` and returning :py:func:`QgsLayoutItem.nextExportPart()`.
|
||||
%End
|
||||
|
||||
int currentExportLayer() const /Deprecated/;
|
||||
int currentExportLayer() const /Deprecated="Since 3.40. Items should now handle this themselves, via QgsLayoutItem.exportLayerBehavior() and returning QgsLayoutItem.nextExportPart()."/;
|
||||
%Docstring
|
||||
Returns the current item layer to draw while exporting. :py:class:`QgsLayoutItem` subclasses
|
||||
which support multi-layer SVG exports must check this
|
||||
|
@ -74,7 +74,7 @@ Emits the :py:func:`~QgsLayoutReportContext.changed` signal.
|
||||
.. seealso:: :py:func:`layer`
|
||||
%End
|
||||
|
||||
void setPredefinedScales( const QVector<qreal> &scales ) /Deprecated/;
|
||||
void setPredefinedScales( const QVector<qreal> &scales ) /Deprecated="Since 3.40. Use QgsLayoutRenderContext.setPredefinedScales()."/;
|
||||
%Docstring
|
||||
Sets the list of predefined ``scales`` to use with the layout. This is used
|
||||
for maps which are set to the predefined atlas scaling mode.
|
||||
@ -86,7 +86,7 @@ for maps which are set to the predefined atlas scaling mode.
|
||||
Use :py:func:`QgsLayoutRenderContext.setPredefinedScales()`.
|
||||
%End
|
||||
|
||||
QVector<qreal> predefinedScales() const /Deprecated/;
|
||||
QVector<qreal> predefinedScales() const /Deprecated="Since 3.40. Use QgsLayoutRenderContext.predefinedScales()."/;
|
||||
%Docstring
|
||||
Returns the current list of predefined scales for use with the layout.
|
||||
|
||||
|
@ -187,7 +187,7 @@ Returns whether empty rows are drawn in the table.
|
||||
.. seealso:: :py:func:`setShowEmptyRows`
|
||||
%End
|
||||
|
||||
void setHeaderFont( const QFont &font ) /Deprecated/;
|
||||
void setHeaderFont( const QFont &font ) /Deprecated="Since 3.40. Use setHeaderTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the ``font`` used to draw header text in the table.
|
||||
|
||||
@ -200,7 +200,7 @@ Sets the ``font`` used to draw header text in the table.
|
||||
Use :py:func:`~QgsLayoutTable.setHeaderTextFormat` instead.
|
||||
%End
|
||||
|
||||
QFont headerFont() const /Deprecated/;
|
||||
QFont headerFont() const /Deprecated="Since 3.40. Use headerTextFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the font used to draw header text in the table.
|
||||
|
||||
@ -213,7 +213,7 @@ Returns the font used to draw header text in the table.
|
||||
Use :py:func:`~QgsLayoutTable.headerTextFormat` instead.
|
||||
%End
|
||||
|
||||
void setHeaderFontColor( const QColor &color ) /Deprecated/;
|
||||
void setHeaderFontColor( const QColor &color ) /Deprecated="Since 3.40. Use setHeaderTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the ``color`` used to draw header text in the table.
|
||||
|
||||
@ -228,7 +228,7 @@ Sets the ``color`` used to draw header text in the table.
|
||||
Use :py:func:`~QgsLayoutTable.setHeaderTextFormat` instead.
|
||||
%End
|
||||
|
||||
QColor headerFontColor() const /Deprecated/;
|
||||
QColor headerFontColor() const /Deprecated="Since 3.40. Use headerTextFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the color used to draw header text in the table.
|
||||
|
||||
@ -295,7 +295,7 @@ if and where headers are shown in the table.
|
||||
.. seealso:: :py:func:`setHeaderMode`
|
||||
%End
|
||||
|
||||
void setContentFont( const QFont &font ) /Deprecated/;
|
||||
void setContentFont( const QFont &font ) /Deprecated="Since 3.40. Use setContentTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the ``font`` used to draw text in table body cells.
|
||||
|
||||
@ -308,7 +308,7 @@ Sets the ``font`` used to draw text in table body cells.
|
||||
Use :py:func:`~QgsLayoutTable.setContentTextFormat` instead.
|
||||
%End
|
||||
|
||||
QFont contentFont() const /Deprecated/;
|
||||
QFont contentFont() const /Deprecated="Since 3.40. Use contextTextFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the font used to draw text in table body cells.
|
||||
|
||||
@ -321,7 +321,7 @@ Returns the font used to draw text in table body cells.
|
||||
Use :py:func:`~QgsLayoutTable.contextTextFormat` instead.
|
||||
%End
|
||||
|
||||
void setContentFontColor( const QColor &color ) /Deprecated/;
|
||||
void setContentFontColor( const QColor &color ) /Deprecated="Since 3.40. Use setContentTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the ``color`` used to draw text in table body cells.
|
||||
|
||||
@ -336,7 +336,7 @@ Sets the ``color`` used to draw text in table body cells.
|
||||
Use :py:func:`~QgsLayoutTable.setContentTextFormat` instead.
|
||||
%End
|
||||
|
||||
QColor contentFontColor() const /Deprecated/;
|
||||
QColor contentFontColor() const /Deprecated="Since 3.40. Use contextTextFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the color used to draw text in table body cells.
|
||||
|
||||
|
@ -174,7 +174,7 @@ is part of a :py:class:`QgsLayoutItemAttributeTable` and when :py:func:`~QgsLayo
|
||||
.. seealso:: :py:func:`setSortByRank`
|
||||
%End
|
||||
|
||||
int sortByRank() const /Deprecated/;
|
||||
int sortByRank() const /Deprecated="Since 3.14. The order is now hold in a dedicated model."/;
|
||||
%Docstring
|
||||
Returns the sort rank for the column. If the sort rank is > 0 then the column
|
||||
will be sorted in the table. The sort rank specifies the priority given to the
|
||||
@ -197,7 +197,7 @@ If sort rank is <= 0 then the column is not being sorted.
|
||||
The order is now hold in a dedicated model.
|
||||
%End
|
||||
|
||||
void setSortByRank( int rank ) /Deprecated/;
|
||||
void setSortByRank( int rank ) /Deprecated="Since 3.14. The order is now hold in a dedicated model."/;
|
||||
%Docstring
|
||||
Sets the sort ``rank`` for the column. If the sort rank is > 0 then the column
|
||||
will be sorted in the table. The sort rank specifies the priority given to the
|
||||
@ -219,7 +219,7 @@ If the sort ``rank`` is <= 0 then the column is not being sorted.
|
||||
The order is now hold in a dedicated model.
|
||||
%End
|
||||
|
||||
QgsLayoutTableColumn *clone() /Deprecated,Factory/;
|
||||
QgsLayoutTableColumn *clone() /Deprecated="Since 3.14. Use a copy instead.",Factory/;
|
||||
%Docstring
|
||||
Creates a duplicate column which is a deep copy of this column.
|
||||
|
||||
|
@ -218,7 +218,7 @@ decoded orientation.
|
||||
If the string was correctly decoded, ``ok`` will be set to ``True``.
|
||||
%End
|
||||
|
||||
static double scaleFactorFromItemStyle( const QStyleOptionGraphicsItem *style ) /Deprecated/;
|
||||
static double scaleFactorFromItemStyle( const QStyleOptionGraphicsItem *style ) /Deprecated="Since 3.40. Use the variant with a QPainter argument instead."/;
|
||||
%Docstring
|
||||
Extracts the scale factor from an item ``style``.
|
||||
|
||||
|
@ -42,7 +42,7 @@ Invalidates the cache contents, clearing all cached images.
|
||||
.. seealso:: :py:func:`clearCacheImage`
|
||||
%End
|
||||
|
||||
bool init( const QgsRectangle &extent, double scale ) /Deprecated/;
|
||||
bool init( const QgsRectangle &extent, double scale ) /Deprecated="Since 3.18. Will be removed in QGIS 4.0. Use the updateParameters() and clear()."/;
|
||||
%Docstring
|
||||
Initialize cache: sets extent and scale parameters and clears the cache if any
|
||||
parameters have changed since last initialization.
|
||||
|
@ -49,7 +49,7 @@ Resulting dataset is always scalar
|
||||
const QgsRectangle &outputExtent,
|
||||
double startTime,
|
||||
double endTime,
|
||||
QgsMeshLayer *layer ) /Deprecated/;
|
||||
QgsMeshLayer *layer ) /Deprecated="Since 3.12. "/;
|
||||
%Docstring
|
||||
Creates calculator with bounding box (rectangular) mask
|
||||
|
||||
@ -68,7 +68,7 @@ Creates calculator with bounding box (rectangular) mask
|
||||
const QgsGeometry &outputMask,
|
||||
double startTime,
|
||||
double endTime,
|
||||
QgsMeshLayer *layer ) /Deprecated/;
|
||||
QgsMeshLayer *layer ) /Deprecated="Since 3.12. "/;
|
||||
%Docstring
|
||||
Creates calculator with geometry mask
|
||||
|
||||
@ -182,7 +182,7 @@ Starts the calculation, creates new dataset group and adds it to the mesh layer
|
||||
%End
|
||||
|
||||
static Result expression_valid( const QString &formulaString,
|
||||
QgsMeshLayer *layer ) /Deprecated/;
|
||||
QgsMeshLayer *layer ) /Deprecated="Since 3.12. Use expressionIsValid."/;
|
||||
%Docstring
|
||||
Returns whether formula is valid for particular mesh layer
|
||||
|
||||
|
@ -304,7 +304,7 @@ Returns whether the faces are active for particular dataset
|
||||
const QVector<QgsMeshDataBlock> &datasetValues,
|
||||
const QVector<QgsMeshDataBlock> &datasetActive,
|
||||
const QVector<double> ×
|
||||
) /Deprecated/;
|
||||
) /Deprecated="Since 3.12.3. "/;
|
||||
%Docstring
|
||||
Creates a new dataset group from a data and
|
||||
persists it into a destination path
|
||||
|
@ -216,7 +216,7 @@ Aborts the network request immediately.
|
||||
Emitted when when data arrives during a request.
|
||||
%End
|
||||
|
||||
void downloadFinished() /Deprecated/;
|
||||
void downloadFinished() /Deprecated="Since 3.40. Use the finished() signal instead."/;
|
||||
%Docstring
|
||||
Emitted once a request has finished downloading.
|
||||
|
||||
|
@ -35,7 +35,7 @@ Constructor from map
|
||||
|
||||
QgsHttpHeaders();
|
||||
|
||||
QgsHttpHeaders( const QgsSettings &settings, const QString &key = QString() ) /Deprecated/;
|
||||
QgsHttpHeaders( const QgsSettings &settings, const QString &key = QString() ) /Deprecated="Since 3.30. Use a variant map settings and the default constructor instead."/;
|
||||
%Docstring
|
||||
Constructor from :py:class:`QgsSettings` ``settings`` object and root ``key``
|
||||
|
||||
@ -70,7 +70,7 @@ Returns the headers as a variant map
|
||||
.. versionadded:: 3.30
|
||||
%End
|
||||
|
||||
bool updateSettings( QgsSettings &settings, const QString &key = QString() ) const /Deprecated/;
|
||||
bool updateSettings( QgsSettings &settings, const QString &key = QString() ) const /Deprecated="Since 3.30. Directly use a variant setting instead."/;
|
||||
%Docstring
|
||||
Updates the ``settings`` by adding all the http headers in the path "key/PATH_PREFIX/"
|
||||
|
||||
|
@ -471,7 +471,7 @@ Preprocesses request
|
||||
|
||||
signals:
|
||||
|
||||
void requestAboutToBeCreated( QNetworkAccessManager::Operation operation, const QNetworkRequest &request, QIODevice *device ) /Deprecated/;
|
||||
void requestAboutToBeCreated( QNetworkAccessManager::Operation operation, const QNetworkRequest &request, QIODevice *device ) /Deprecated="Since 3.40. Use the thread-safe requestAboutToBeCreated( QgsNetworkRequestParameters ) signal instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
@ -617,7 +617,7 @@ See :py:class:`QgsSslErrorHandler` for details on how to handle SSL errors and p
|
||||
|
||||
|
||||
|
||||
void requestCreated( QNetworkReply *reply ) /Deprecated/;
|
||||
void requestCreated( QNetworkReply *reply ) /Deprecated="Since 3.40. Use the thread-safe requestAboutToBeCreated( QgsNetworkRequestParameters ) signal instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
|
@ -27,7 +27,7 @@ used later as clip path
|
||||
%End
|
||||
public:
|
||||
|
||||
QgsMaskPaintDevice( bool usePathStroker = false ) /Deprecated/;
|
||||
QgsMaskPaintDevice( bool usePathStroker = false ) /Deprecated="Since 3.38. Use QgsGeometryPaintDevice instead."/;
|
||||
%Docstring
|
||||
!
|
||||
Constructor
|
||||
@ -45,7 +45,7 @@ pen configuration
|
||||
virtual int metric( PaintDeviceMetric metric ) const;
|
||||
|
||||
|
||||
QPainterPath maskPainterPath() const /Deprecated/;
|
||||
QPainterPath maskPainterPath() const /Deprecated="Since 3.40. Use QgsGeometryPaintDevice instead."/;
|
||||
%Docstring
|
||||
Returns the mask painter path painted on this paint device
|
||||
|
||||
|
@ -126,7 +126,7 @@ about what the algorithm does and the parameters and outputs associated with it.
|
||||
.. seealso:: :py:func:`helpUrl`
|
||||
%End
|
||||
|
||||
virtual QString helpString() const /HoldGIL,Deprecated/;
|
||||
virtual QString helpString() const /HoldGIL,Deprecated="Since 3.40. Unused, will be removed in QGIS 4.0."/;
|
||||
%Docstring
|
||||
Returns a localised help string for the algorithm. Algorithm subclasses should implement either
|
||||
:py:func:`~QgsProcessingAlgorithm.helpString` or :py:func:`~QgsProcessingAlgorithm.helpUrl`.
|
||||
@ -935,7 +935,7 @@ Evaluates the parameter with matching ``name`` to a list of files (for :py:class
|
||||
Evaluates the parameter with matching ``name`` to a range of values.
|
||||
%End
|
||||
|
||||
QStringList parameterAsFields( const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context ) const /Deprecated/;
|
||||
QStringList parameterAsFields( const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context ) const /Deprecated="Since 3.40. Use parameterAsStrings() instead."/;
|
||||
%Docstring
|
||||
Evaluates the parameter with matching ``name`` to a list of fields.
|
||||
|
||||
|
@ -1462,7 +1462,7 @@ Evaluates the parameter with matching ``definition`` and ``value`` to a range of
|
||||
.. versionadded:: 3.4
|
||||
%End
|
||||
|
||||
static QStringList parameterAsFields( const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context ) /Deprecated/;
|
||||
static QStringList parameterAsFields( const QgsProcessingParameterDefinition *definition, const QVariantMap ¶meters, QgsProcessingContext &context ) /Deprecated="Since 3.40. Use parameterAsStrings() instead."/;
|
||||
%Docstring
|
||||
Evaluates the parameter with matching ``definition`` to a list of fields.
|
||||
|
||||
@ -1471,7 +1471,7 @@ Evaluates the parameter with matching ``definition`` to a list of fields.
|
||||
Use :py:func:`~QgsProcessingParameters.parameterAsStrings` instead.
|
||||
%End
|
||||
|
||||
static QStringList parameterAsFields( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context ) /Deprecated/;
|
||||
static QStringList parameterAsFields( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context ) /Deprecated="Since 3.40. Use parameterAsStrings() instead."/;
|
||||
%Docstring
|
||||
Evaluates the parameter with matching ``definition`` and ``value`` to a list of fields.
|
||||
|
||||
|
@ -397,7 +397,7 @@ using the specified ``context``.
|
||||
.. versionadded:: 3.8
|
||||
%End
|
||||
|
||||
static QgsRectangle combineLayerExtents( const QList<QgsMapLayer *> &layers, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() ) /Deprecated/;
|
||||
static QgsRectangle combineLayerExtents( const QList<QgsMapLayer *> &layers, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() ) /Deprecated="Since 3.40. Use version with QgsProcessingContext argument instead."/;
|
||||
%Docstring
|
||||
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.
|
||||
|
@ -212,7 +212,7 @@ If no prefix is specified, WKT definition is assumed.
|
||||
%End
|
||||
|
||||
|
||||
explicit QgsCoordinateReferenceSystem( long id, CrsType type = PostgisCrsId ) /Deprecated/;
|
||||
explicit QgsCoordinateReferenceSystem( long id, CrsType type = PostgisCrsId ) /Deprecated="Since 3.10. We encourage you to use EPSG codes or WKT to describe CRSes in your code wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile, and Proj strings are a lossy format."/;
|
||||
%Docstring
|
||||
Constructor
|
||||
|
||||
@ -276,7 +276,7 @@ Creates a CRS from a given EPSG ID.
|
||||
:return: matching CRS, or an invalid CRS if string could not be matched
|
||||
%End
|
||||
|
||||
static QgsCoordinateReferenceSystem fromProj4( const QString &proj4 ) /Deprecated/;
|
||||
static QgsCoordinateReferenceSystem fromProj4( const QString &proj4 ) /Deprecated="Since 3.10. Use fromProj() instead."/;
|
||||
%Docstring
|
||||
Creates a CRS from a proj style formatted string.
|
||||
|
||||
@ -360,7 +360,7 @@ or the compound CRS could not be created for the combination.
|
||||
|
||||
|
||||
|
||||
bool createFromId( long id, CrsType type = PostgisCrsId ) /Deprecated/;
|
||||
bool createFromId( long id, CrsType type = PostgisCrsId ) /Deprecated="Since 3.10. We encourage you to use EPSG code or WKT to describe CRSes in your code wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile, and Proj strings are a lossy format."/;
|
||||
%Docstring
|
||||
Sets this CRS by lookup of the given ID in the CRS database.
|
||||
|
||||
@ -391,7 +391,7 @@ and refer to QGIS internal CRS IDs.
|
||||
%End
|
||||
|
||||
|
||||
bool createFromSrid( long srid ) /Deprecated/;
|
||||
bool createFromSrid( long srid ) /Deprecated="Since 3.10. Use alternative methods for SRS construction instead -- this method was specifically created for use by the postgres provider alone, and using it elsewhere will lead to subtle bugs."/;
|
||||
%Docstring
|
||||
Sets this CRS by lookup of the given PostGIS SRID in the CRS database.
|
||||
|
||||
@ -451,7 +451,7 @@ user's local CRS database from home directory is used.
|
||||
using auth:id codes or WKT strings
|
||||
%End
|
||||
|
||||
bool createFromProj4( const QString &projString ) /Deprecated/;
|
||||
bool createFromProj4( const QString &projString ) /Deprecated="Since 3.10. Use createFromProj() instead."/;
|
||||
%Docstring
|
||||
Sets this CRS by passing it a PROJ style formatted string.
|
||||
|
||||
@ -578,7 +578,7 @@ For more details on supported formats see OGRSpatialReference.SetFromUserInput()
|
||||
Call :py:func:`~QgsCoordinateReferenceSystem.invalidateCache` to clear the cache.
|
||||
%End
|
||||
|
||||
static void setupESRIWktFix() /Deprecated/;
|
||||
static void setupESRIWktFix() /Deprecated="Since 3.10. Not used on builds based on Proj version 6 or later."/;
|
||||
%Docstring
|
||||
Make sure that ESRI WKT import is done properly.
|
||||
This is required for proper shapefile CRS import when using gdal>= 1.9.
|
||||
@ -623,7 +623,7 @@ if that involves resorting to a hard coded default of geocs:wgs84.
|
||||
%End
|
||||
|
||||
|
||||
long findMatchingProj() /Deprecated/;
|
||||
long findMatchingProj() /Deprecated="Since 3.10. Not used in Proj >= 6 based builds."/;
|
||||
%Docstring
|
||||
Walks the CRS databases (both system and user database) trying to match
|
||||
stored PROJ string to a database entry in order to fill in further
|
||||
@ -766,7 +766,7 @@ This is only used on builds based on Proj >= 6.
|
||||
.. seealso:: :py:func:`toProj`
|
||||
%End
|
||||
|
||||
QString toProj4() const /Deprecated/;
|
||||
QString toProj4() const /Deprecated="Since 3.10. Use toProj() instead."/;
|
||||
%Docstring
|
||||
Returns a Proj string representation of this CRS.
|
||||
|
||||
@ -1185,7 +1185,7 @@ Returns auth id of related geographic CRS
|
||||
%End
|
||||
|
||||
|
||||
static QStringList recentProjections() /Deprecated/;
|
||||
static QStringList recentProjections() /Deprecated="Since 3.10. Use QgsApplication.coordinateReferenceSystemRegistry()->recentCrs() instead."/;
|
||||
%Docstring
|
||||
Returns a list of recently used projections
|
||||
|
||||
@ -1196,7 +1196,7 @@ Returns a list of recently used projections
|
||||
Use :py:func:`QgsApplication.coordinateReferenceSystemRegistry()`->:py:func:`~QgsCoordinateReferenceSystem.recentCrs` instead.
|
||||
%End
|
||||
|
||||
static QList< QgsCoordinateReferenceSystem > recentCoordinateReferenceSystems() /Deprecated/;
|
||||
static QList< QgsCoordinateReferenceSystem > recentCoordinateReferenceSystems() /Deprecated="Since 3.36. Use QgsApplication.coordinateReferenceSystemRegistry()->recentCrs() instead."/;
|
||||
%Docstring
|
||||
Returns a list of recently used CRS.
|
||||
|
||||
@ -1205,7 +1205,7 @@ Returns a list of recently used CRS.
|
||||
Use :py:func:`QgsApplication.coordinateReferenceSystemRegistry()`->:py:func:`~QgsCoordinateReferenceSystem.recentCrs` instead.
|
||||
%End
|
||||
|
||||
static void pushRecentCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &crs ) /Deprecated/;
|
||||
static void pushRecentCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &crs ) /Deprecated="Since 3.36. Use QgsApplication.coordinateReferenceSystemRegistry()->pushRecent() instead."/;
|
||||
%Docstring
|
||||
Pushes a recently used CRS to the top of the recent CRS list.
|
||||
|
||||
@ -1214,7 +1214,7 @@ Pushes a recently used CRS to the top of the recent CRS list.
|
||||
Use :py:func:`QgsApplication.coordinateReferenceSystemRegistry()`->:py:func:`~QgsCoordinateReferenceSystem.pushRecent` instead.
|
||||
%End
|
||||
|
||||
static void removeRecentCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &crs ) /Deprecated/;
|
||||
static void removeRecentCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &crs ) /Deprecated="Since 3.36. Use QgsApplication.coordinateReferenceSystemRegistry()->removeRecent() instead."/;
|
||||
%Docstring
|
||||
Removes a CRS from the list of recently used CRS.
|
||||
|
||||
@ -1223,7 +1223,7 @@ Removes a CRS from the list of recently used CRS.
|
||||
Use :py:func:`QgsApplication.coordinateReferenceSystemRegistry()`->:py:func:`~QgsCoordinateReferenceSystem.removeRecent` instead.
|
||||
%End
|
||||
|
||||
static void clearRecentCoordinateReferenceSystems() /Deprecated/;
|
||||
static void clearRecentCoordinateReferenceSystems() /Deprecated="Since 3.36. Use QgsApplication.coordinateReferenceSystemRegistry()->clearRecent() instead."/;
|
||||
%Docstring
|
||||
Cleans the list of recently used CRS.
|
||||
|
||||
|
@ -119,7 +119,7 @@ which dictate the behavior of the transformation.
|
||||
explicit QgsCoordinateTransform( const QgsCoordinateReferenceSystem &source,
|
||||
const QgsCoordinateReferenceSystem &destination,
|
||||
int sourceDatumTransformId,
|
||||
int destinationDatumTransformId ) /Deprecated/;
|
||||
int destinationDatumTransformId ) /Deprecated="Since 3.40. Will be removed in QGIS 4.0. Use the constructor with a QgsCoordinateTransformContext argument instead."/;
|
||||
%Docstring
|
||||
Constructs a QgsCoordinateTransform to transform from the ``source``
|
||||
to ``destination`` coordinate reference system, with the specified
|
||||
@ -527,7 +527,7 @@ Returns ``True`` if a fallback operation occurred for the most recent transform.
|
||||
.. versionadded:: 3.12
|
||||
%End
|
||||
|
||||
int sourceDatumTransformId() const /Deprecated/;
|
||||
int sourceDatumTransformId() const /Deprecated="Since 3.40. Unused on builds based on Proj 6.0 or later."/;
|
||||
%Docstring
|
||||
Returns the ID of the datum transform to use when projecting from the source
|
||||
CRS.
|
||||
@ -546,7 +546,7 @@ but can be manually overwritten by a call to :py:func:`~QgsCoordinateTransform.s
|
||||
Unused on builds based on Proj 6.0 or later.
|
||||
%End
|
||||
|
||||
void setSourceDatumTransformId( int datumId ) /Deprecated/;
|
||||
void setSourceDatumTransformId( int datumId ) /Deprecated="Since 3.40. Unused on builds based on Proj 6.0 or later."/;
|
||||
%Docstring
|
||||
Sets the ``datumId`` ID of the datum transform to use when projecting from the source
|
||||
CRS.
|
||||
@ -565,7 +565,7 @@ Calling this method will overwrite any automatically calculated datum transform.
|
||||
Unused on builds based on Proj 6.0 or later.
|
||||
%End
|
||||
|
||||
int destinationDatumTransformId() const /Deprecated/;
|
||||
int destinationDatumTransformId() const /Deprecated="Since 3.40. Unused on builds based on Proj 6.0 or later."/;
|
||||
%Docstring
|
||||
Returns the ID of the datum transform to use when projecting to the destination
|
||||
CRS.
|
||||
@ -584,7 +584,7 @@ but can be manually overwritten by a call to :py:func:`~QgsCoordinateTransform.s
|
||||
Unused on builds based on Proj 6.0 or later.
|
||||
%End
|
||||
|
||||
void setDestinationDatumTransformId( int datumId ) /Deprecated/;
|
||||
void setDestinationDatumTransformId( int datumId ) /Deprecated="Since 3.40. Unused on builds based on Proj 6.0 or later."/;
|
||||
%Docstring
|
||||
Sets the ``datumId`` ID of the datum transform to use when projecting to the destination
|
||||
CRS.
|
||||
|
@ -56,7 +56,7 @@ Constructor for QgsCoordinateTransformContext.
|
||||
Clears all stored transform information from the context.
|
||||
%End
|
||||
|
||||
QMap< QPair< QString, QString>, QgsDatumTransform::TransformPair > sourceDestinationDatumTransforms() const /Deprecated/;
|
||||
QMap< QPair< QString, QString>, QgsDatumTransform::TransformPair > sourceDestinationDatumTransforms() const /Deprecated="Since 3.40. Has no effect on builds based on Proj 6.0 or later, use coordinateOperations() instead."/;
|
||||
%Docstring
|
||||
Returns the stored mapping for source to destination CRS pairs to associated datum transforms to use.
|
||||
The map keys will be :py:class:`QgsCoordinateReferenceSystems`.authid()s.
|
||||
@ -98,7 +98,7 @@ Returns the stored mapping for source to destination CRS pairs to associated coo
|
||||
.. versionadded:: 3.8
|
||||
%End
|
||||
|
||||
bool addSourceDestinationDatumTransform( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, int sourceTransformId, int destinationTransformId ) /Deprecated/;
|
||||
bool addSourceDestinationDatumTransform( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, int sourceTransformId, int destinationTransformId ) /Deprecated="Since 3.40. Has no effect on builds based on Proj 6.0 or later, use addCoordinateOperation() instead."/;
|
||||
%Docstring
|
||||
Adds a new ``sourceTransform`` and ``destinationTransform`` to use when projecting coordinates
|
||||
from the specified ``sourceCrs`` to the specified ``destinationCrs``.
|
||||
@ -155,7 +155,7 @@ Returns ``True`` if the new coordinate operation was added successfully.
|
||||
.. versionadded:: 3.8
|
||||
%End
|
||||
|
||||
void removeSourceDestinationDatumTransform( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs ) /Deprecated/;
|
||||
void removeSourceDestinationDatumTransform( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs ) /Deprecated="Since 3.40. Use removeCoordinateOperation() instead."/;
|
||||
%Docstring
|
||||
Removes the source to destination datum transform pair for the specified ``sourceCrs`` and
|
||||
``destinationCrs``.
|
||||
@ -185,7 +185,7 @@ when transforming from the specified ``source`` CRS to ``destination`` CRS.
|
||||
source and destination are reversible.
|
||||
%End
|
||||
|
||||
QgsDatumTransform::TransformPair calculateDatumTransforms( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const /Deprecated/;
|
||||
QgsDatumTransform::TransformPair calculateDatumTransforms( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const /Deprecated="Since 3.40. Has no effect on builds based on Proj 6.0 or later. Use calculateCoordinateOperation() instead."/;
|
||||
%Docstring
|
||||
Returns the pair of source and destination datum transforms to use
|
||||
for a transform from the specified ``source`` CRS to ``destination`` CRS.
|
||||
|
@ -141,7 +141,7 @@ in the results. This requires Proj >= 6.2.
|
||||
.. versionadded:: 3.8
|
||||
%End
|
||||
|
||||
static QList< QgsDatumTransform::TransformPair > datumTransformations( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) /Deprecated/;
|
||||
static QList< QgsDatumTransform::TransformPair > datumTransformations( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) /Deprecated="Since 3.40. Not used for builds based on Proj >= 6.0."/;
|
||||
%Docstring
|
||||
Returns a list of datum transformations which are available for the given ``source`` and ``destination`` CRS.
|
||||
|
||||
@ -154,7 +154,7 @@ Returns a list of datum transformations which are available for the given ``sour
|
||||
Not used for builds based on Proj >= 6.0.
|
||||
%End
|
||||
|
||||
static QString datumTransformToProj( int datumTransformId ) /Deprecated/;
|
||||
static QString datumTransformToProj( int datumTransformId ) /Deprecated="Since 3.40. Not used for builds based on Proj >= 6.0."/;
|
||||
%Docstring
|
||||
Returns a proj string representing the specified ``datumTransformId`` datum transform ID.
|
||||
|
||||
@ -169,7 +169,7 @@ Returns a proj string representing the specified ``datumTransformId`` datum tran
|
||||
Not used for builds based on Proj >= 6.0.
|
||||
%End
|
||||
|
||||
static int projStringToDatumTransformId( const QString &string ) /Deprecated/;
|
||||
static int projStringToDatumTransformId( const QString &string ) /Deprecated="Since 3.40. Not used for builds based on Proj >= 6.0."/;
|
||||
%Docstring
|
||||
Returns the datum transform ID corresponding to a specified proj ``string``.
|
||||
Returns -1 if matching datum ID was not found.
|
||||
@ -181,7 +181,7 @@ Returns -1 if matching datum ID was not found.
|
||||
Not used for builds based on Proj >= 6.0.
|
||||
%End
|
||||
|
||||
static QgsDatumTransform::TransformInfo datumTransformInfo( int datumTransformId ) /Deprecated/;
|
||||
static QgsDatumTransform::TransformInfo datumTransformInfo( int datumTransformId ) /Deprecated="Since 3.40. Not used for builds based on Proj >= 6.0."/;
|
||||
%Docstring
|
||||
Returns detailed information about the specified ``datumTransformId``.
|
||||
If ``datumTransformId`` was not a valid transform ID, a TransformInfo with TransformInfo.datumTransformId of
|
||||
|
@ -228,7 +228,7 @@ QGIS) project file to be overwritten when the project is next saved.
|
||||
.. versionadded:: 3.14
|
||||
%End
|
||||
|
||||
QFileInfo fileInfo() const /Deprecated/;
|
||||
QFileInfo fileInfo() const /Deprecated="Since 3.2. Use absoluteFilePath(), baseName() or lastModifiedTime() instead."/;
|
||||
%Docstring
|
||||
Returns QFileInfo object for the project's associated file.
|
||||
|
||||
@ -961,7 +961,7 @@ Gets the list of layers which currently should not be taken into account on map
|
||||
Use :py:func:`QgsMapLayer.setFlags()` instead.
|
||||
%End
|
||||
|
||||
bool autoTransaction() const /Deprecated/;
|
||||
bool autoTransaction() const /Deprecated="Since 3.26. Use transactionMode() instead."/;
|
||||
%Docstring
|
||||
Transactional editing means that on supported datasources (postgres databases) the edit state of
|
||||
all tables that originate from the same database are synchronized and executed in a server side
|
||||
@ -972,7 +972,7 @@ transaction.
|
||||
Use :py:func:`~QgsProject.transactionMode` instead.
|
||||
%End
|
||||
|
||||
void setAutoTransaction( bool autoTransaction ) /Deprecated/;
|
||||
void setAutoTransaction( bool autoTransaction ) /Deprecated="Since 3.26. Use setTransactionMode() instead."/;
|
||||
%Docstring
|
||||
Transactional editing means that on supported datasources (postgres databases) the edit state of
|
||||
all tables that originate from the same database are synchronized and executed in a server side
|
||||
@ -1028,7 +1028,7 @@ Returns the edit buffer group
|
||||
.. versionadded:: 3.26
|
||||
%End
|
||||
|
||||
bool evaluateDefaultValues() const /Deprecated/;
|
||||
bool evaluateDefaultValues() const /Deprecated="Since 3.40. Test whether the flags() method returns the Qgis.ProjectFlag.EvaluateDefaultValuesOnProviderSide flag instead."/;
|
||||
%Docstring
|
||||
Should default values be evaluated on provider side when requested and not when committed.
|
||||
|
||||
@ -1037,7 +1037,7 @@ Should default values be evaluated on provider side when requested and not when
|
||||
Test whether the :py:func:`~QgsProject.flags` method returns the :py:class:`Qgis`.ProjectFlag.EvaluateDefaultValuesOnProviderSide flag instead.
|
||||
%End
|
||||
|
||||
void setEvaluateDefaultValues( bool evaluateDefaultValues ) /Deprecated/;
|
||||
void setEvaluateDefaultValues( bool evaluateDefaultValues ) /Deprecated="Since 3.40. Use setFlag( Qgis.ProjectFlag.EvaluateDefaultValuesOnProviderSide ) instead."/;
|
||||
%Docstring
|
||||
Defines if default values should be evaluated on provider side when requested and not when committed.
|
||||
|
||||
@ -1375,7 +1375,7 @@ Returns the default CRS for new layers based on the settings and
|
||||
the current project CRS
|
||||
%End
|
||||
|
||||
void setTrustLayerMetadata( bool trust ) /Deprecated/;
|
||||
void setTrustLayerMetadata( bool trust ) /Deprecated="Since 3.40. Use setFlag( Qgis.ProjectFlag.TrustStoredLayerStatistics ) instead."/;
|
||||
%Docstring
|
||||
Sets the trust option allowing to indicate if the extent has to be
|
||||
read from the XML document when data source has no metadata or if the
|
||||
@ -1390,7 +1390,7 @@ materialized views with Postgres provider.
|
||||
Use setFlag( :py:class:`Qgis`.ProjectFlag.TrustStoredLayerStatistics ) instead.
|
||||
%End
|
||||
|
||||
bool trustLayerMetadata() const /Deprecated/;
|
||||
bool trustLayerMetadata() const /Deprecated="Since 3.40. Test whether the flags() method returns the Qgis.ProjectFlag.TrustStoredLayerStatistics flag instead."/;
|
||||
%Docstring
|
||||
Returns ``True`` if the trust option is activated, ``False`` otherwise. This
|
||||
option allows indicateing if the extent has to be read from the XML
|
||||
@ -1565,7 +1565,7 @@ Returns the color used to highlight selected features
|
||||
.. versionadded:: 3.10
|
||||
%End
|
||||
|
||||
void setMapScales( const QVector<double> &scales ) /Deprecated/;
|
||||
void setMapScales( const QVector<double> &scales ) /Deprecated="Since 3.40. Use viewSettings() instead."/;
|
||||
%Docstring
|
||||
Sets the list of custom project map ``scales``.
|
||||
|
||||
@ -1581,7 +1581,7 @@ The ``scales`` list consists of a list of scale denominator values, e.g.
|
||||
Use :py:func:`~QgsProject.viewSettings` instead.
|
||||
%End
|
||||
|
||||
QVector<double> mapScales() const /Deprecated/;
|
||||
QVector<double> mapScales() const /Deprecated="Since 3.40. Use viewSettings() instead."/;
|
||||
%Docstring
|
||||
Returns the list of custom project map scales.
|
||||
|
||||
@ -1597,7 +1597,7 @@ The scales list consists of a list of scale denominator values, e.g.
|
||||
Use :py:func:`~QgsProject.viewSettings` instead.
|
||||
%End
|
||||
|
||||
void setUseProjectScales( bool enabled ) /Deprecated/;
|
||||
void setUseProjectScales( bool enabled ) /Deprecated="Since 3.40. Use viewSettings() instead."/;
|
||||
%Docstring
|
||||
Sets whether project :py:func:`~QgsProject.mapScales` are ``enabled``.
|
||||
|
||||
@ -1610,7 +1610,7 @@ Sets whether project :py:func:`~QgsProject.mapScales` are ``enabled``.
|
||||
Use :py:func:`~QgsProject.viewSettings` instead.
|
||||
%End
|
||||
|
||||
bool useProjectScales() const /Deprecated/;
|
||||
bool useProjectScales() const /Deprecated="Since 3.40. Use viewSettings() instead."/;
|
||||
%Docstring
|
||||
Returns ``True`` if project :py:func:`~QgsProject.mapScales` are enabled.
|
||||
|
||||
@ -1729,7 +1729,7 @@ additional information to the layer.
|
||||
Emitted when the project file has been written and closed.
|
||||
%End
|
||||
|
||||
void oldProjectVersionWarning( const QString &warning ) /Deprecated/;
|
||||
void oldProjectVersionWarning( const QString &warning ) /Deprecated="Since 3.40. Use readVersionMismatchOccurred() instead."/;
|
||||
%Docstring
|
||||
Emitted when an old project file is read.
|
||||
|
||||
@ -2120,7 +2120,7 @@ Emitted when setDirty(true) is called.
|
||||
.. versionadded:: 3.20
|
||||
%End
|
||||
|
||||
void mapScalesChanged() /Deprecated/;
|
||||
void mapScalesChanged() /Deprecated="Since 3.40. Use viewSettings() instead."/;
|
||||
%Docstring
|
||||
Emitted when the list of custom project map scales changes.
|
||||
|
||||
|
@ -110,7 +110,7 @@ The default implementation returns an empty string.
|
||||
.. versionadded:: 3.8.1
|
||||
%End
|
||||
|
||||
virtual QString visibleName() /Deprecated/;
|
||||
virtual QString visibleName() /Deprecated="Since 3.10. Use QgsProjectStorageGuiProvider for GUI-related project storage functionality."/;
|
||||
%Docstring
|
||||
Returns human-readable name of the storage. Used as the menu item text in QGIS. Empty name
|
||||
indicates that the storage does not implement GUI support (:py:func:`~QgsProjectStorage.showLoadGui` and :py:func:`~QgsProjectStorage.showSaveGui`).
|
||||
@ -121,7 +121,7 @@ The name may be translatable and ideally unique as well.
|
||||
Use :py:class:`QgsProjectStorageGuiProvider` for GUI-related project storage functionality.
|
||||
%End
|
||||
|
||||
virtual QString showLoadGui() /Deprecated/;
|
||||
virtual QString showLoadGui() /Deprecated="Since 3.10. Use QgsProjectStorageGuiProvider for GUI-related project storage functionality."/;
|
||||
%Docstring
|
||||
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.
|
||||
@ -131,7 +131,7 @@ Returns project URI if user has picked a project or empty string if the GUI was
|
||||
Use :py:class:`QgsProjectStorageGuiProvider` for GUI-related project storage functionality.
|
||||
%End
|
||||
|
||||
virtual QString showSaveGui() /Deprecated/;
|
||||
virtual QString showSaveGui() /Deprecated="Since 3.10. Use QgsProjectStorageGuiProvider for GUI-related project storage functionality."/;
|
||||
%Docstring
|
||||
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.
|
||||
|
@ -45,7 +45,7 @@ If ``user`` is blank then the user associated with the current logon details wil
|
||||
.. versionadded:: 3.24
|
||||
%End
|
||||
|
||||
static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, const QString &urlPrefix = QString() ) /Deprecated/;
|
||||
static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, const QString &urlPrefix = QString() ) /Deprecated="Since 3.24. Use the version with QgsHttpHeaders instead."/;
|
||||
%Docstring
|
||||
Retrieves JSON user info for the specified user name. Only to avoid API break.
|
||||
|
||||
@ -87,7 +87,7 @@ If ``user`` is blank then the user associated with the current logon details wil
|
||||
.. versionadded:: 3.24
|
||||
%End
|
||||
|
||||
static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, const QString &urlPrefix = QString() ) /Deprecated/;
|
||||
static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, const QString &urlPrefix = QString() ) /Deprecated="Since 3.24. Use the version with QgsHttpHeaders instead."/;
|
||||
%Docstring
|
||||
Retrieves JSON definitions for all groups which the specified user name is a member of. Only to avoid API break.
|
||||
|
||||
@ -128,7 +128,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
|
||||
.. versionadded:: 3.24
|
||||
%End
|
||||
|
||||
static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() ) /Deprecated/;
|
||||
static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() ) /Deprecated="Since 3.24. Use the version with QgsHttpHeaders instead."/;
|
||||
%Docstring
|
||||
Retrieves JSON definitions for all items which belong the the specified ``groupId``. Only to avoid API break.
|
||||
|
||||
@ -173,7 +173,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
|
||||
|
||||
static QVariantList retrieveGroupItemsOfType( const QString &contentUrl, const QString &groupId, const QString &authcfg,
|
||||
const QList< int > &itemTypes,
|
||||
QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() ) /Deprecated/;
|
||||
QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() ) /Deprecated="Since 3.24. Use the version with QgsHttpHeaders instead."/;
|
||||
%Docstring
|
||||
Retrieves JSON definitions for all items which belong the the specified ``groupId``. Only to avoid API break.
|
||||
|
||||
|
@ -49,7 +49,7 @@ Constructs default metadata without any capabilities
|
||||
QgsMeshDriverMetadata( const QString &name,
|
||||
const QString &description,
|
||||
const MeshDriverCapabilities &capabilities,
|
||||
const QString &writeDatasetOnFileSuffix ) /Deprecated/;
|
||||
const QString &writeDatasetOnFileSuffix ) /Deprecated="Since 3.22. "/;
|
||||
%Docstring
|
||||
Constructs driver metadata with selected capabilities
|
||||
|
||||
@ -250,7 +250,7 @@ Returns a list of the map layer types supported by the provider.
|
||||
}
|
||||
%End
|
||||
|
||||
QString library() const /Deprecated/;
|
||||
QString library() const /Deprecated="Since 3.10. Providers may not need to be loaded from a library (empty string returned)."/;
|
||||
%Docstring
|
||||
This returns the library file name
|
||||
|
||||
|
@ -51,7 +51,7 @@ Means of accessing canonical single instance
|
||||
|
||||
~QgsProviderRegistry();
|
||||
|
||||
QString library( const QString &providerKey ) const /Deprecated/;
|
||||
QString library( const QString &providerKey ) const /Deprecated="Since 3.10. Providers may not need to be loaded from a library (empty string returned)."/;
|
||||
%Docstring
|
||||
Returns path for the library of the provider.
|
||||
|
||||
@ -96,7 +96,7 @@ Creates a new instance of a provider.
|
||||
.. seealso:: :py:func:`createRasterDataProvider`
|
||||
%End
|
||||
|
||||
Qgis::DataItemProviderCapabilities providerCapabilities( const QString &providerKey ) const /Deprecated/;
|
||||
Qgis::DataItemProviderCapabilities providerCapabilities( const QString &providerKey ) const /Deprecated="Since 3.10. Use instead capabilities() method of individual data item provider."/;
|
||||
%Docstring
|
||||
Returns the provider capabilities
|
||||
|
||||
@ -205,7 +205,7 @@ If a provider does not work with paths, unmodified URI will be returned.
|
||||
.. versionadded:: 3.30
|
||||
%End
|
||||
|
||||
QWidget *createSelectionWidget( const QString &providerKey, QWidget *parent = 0, Qt::WindowFlags fl = Qt::WindowFlags(), QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::Standalone ) /Deprecated/;
|
||||
QWidget *createSelectionWidget( const QString &providerKey, QWidget *parent = 0, Qt::WindowFlags fl = Qt::WindowFlags(), QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::Standalone ) /Deprecated="Since 3.10. Use QgsGui.sourceSelectProviderRegistry()->createDataSourceWidget() instead."/;
|
||||
%Docstring
|
||||
Returns a new widget for selecting layers from a provider.
|
||||
Either the ``parent`` widget must be set or the caller becomes
|
||||
@ -336,7 +336,7 @@ Returns new instance of transaction. Ownership is transferred to the caller
|
||||
.. versionadded:: 3.10
|
||||
%End
|
||||
|
||||
QFunctionPointer function( const QString &providerKey, const QString &functionName ) const /Deprecated/;
|
||||
QFunctionPointer function( const QString &providerKey, const QString &functionName ) const /Deprecated="Since 3.10. Any provider functionality should be accessed through QgsProviderMetadata."/;
|
||||
%Docstring
|
||||
Gets pointer to provider function
|
||||
|
||||
@ -351,7 +351,7 @@ Gets pointer to provider function
|
||||
Any provider functionality should be accessed through :py:class:`QgsProviderMetadata`.
|
||||
%End
|
||||
|
||||
QLibrary *createProviderLibrary( const QString &providerKey ) const /Factory,Deprecated/;
|
||||
QLibrary *createProviderLibrary( const QString &providerKey ) const /Factory,Deprecated="Since 3.10. Providers may not need to be loaded from a library."/;
|
||||
%Docstring
|
||||
Returns a new QLibrary for the specified ``providerKey``. Ownership of the returned
|
||||
object is transferred to the caller and the caller is responsible for deleting it.
|
||||
@ -749,7 +749,7 @@ Returns a string containing the available directory drivers
|
||||
Returns a string containing the available protocol drivers
|
||||
%End
|
||||
|
||||
void registerGuis( QWidget *widget ) /Deprecated/;
|
||||
void registerGuis( QWidget *widget ) /Deprecated="Since 3.10. Does nothing - use QgsGui.providerGuiRegistry()."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.10
|
||||
|
@ -265,7 +265,7 @@ Returns the path to the settings directory in user's home dir
|
||||
Returns the path to the user qgis.db file.
|
||||
%End
|
||||
|
||||
static QString qgisAuthDatabaseFilePath() /Deprecated/;
|
||||
static QString qgisAuthDatabaseFilePath() /Deprecated="Since 3.30. Use qgisAuthDatabaseUri() instead."/;
|
||||
%Docstring
|
||||
Returns the path to the user authentication database file: qgis-auth.db.
|
||||
|
||||
@ -698,7 +698,7 @@ Returns the application's task manager, used for managing application
|
||||
wide background task handling.
|
||||
%End
|
||||
|
||||
static QgsSettingsRegistryCore *settingsRegistryCore() /KeepReference,Deprecated/;
|
||||
static QgsSettingsRegistryCore *settingsRegistryCore() /KeepReference,Deprecated="Since 3.30. Use QgsSettings.treeRoot() instead."/;
|
||||
%Docstring
|
||||
Returns the application's settings registry, used for managing application settings.
|
||||
|
||||
|
@ -10,7 +10,7 @@
|
||||
|
||||
|
||||
|
||||
class QgsDatabaseFilterProxyModel : QSortFilterProxyModel /Deprecated/
|
||||
class QgsDatabaseFilterProxyModel : QSortFilterProxyModel /Deprecated="Since 3.24. "/
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
A class that implements a custom filter and can be used
|
||||
|
@ -864,7 +864,7 @@ Check if a feature is accepted by this requests filter
|
||||
:return: ``True``, if the filter accepts the feature
|
||||
%End
|
||||
|
||||
int connectionTimeout() const /Deprecated/;
|
||||
int connectionTimeout() const /Deprecated="Since 3.40. Use timeout() instead."/;
|
||||
%Docstring
|
||||
Returns the timeout (in milliseconds) for how long we should wait for a connection if none is available from the pool
|
||||
at this moment. A negative value (which is set by default) will wait forever.
|
||||
@ -878,7 +878,7 @@ at this moment. A negative value (which is set by default) will wait forever.
|
||||
Use :py:func:`~QgsFeatureRequest.timeout` instead.
|
||||
%End
|
||||
|
||||
QgsFeatureRequest &setConnectionTimeout( int connectionTimeout ) /Deprecated/;
|
||||
QgsFeatureRequest &setConnectionTimeout( int connectionTimeout ) /Deprecated="Since 3.40. Use setTimeout() instead."/;
|
||||
%Docstring
|
||||
Sets the timeout (in milliseconds) for how long we should wait for a connection if none is available from the pool
|
||||
at this moment. A negative value (which is set by default) will wait forever.
|
||||
|
@ -65,7 +65,7 @@ Constructor. Constructs a new QgsField object.
|
||||
int len = 0,
|
||||
int prec = 0,
|
||||
const QString &comment = QString(),
|
||||
QVariant::Type subType = QVariant::Invalid ) /HoldGIL,Deprecated/;
|
||||
QVariant::Type subType = QVariant::Invalid ) /HoldGIL,Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Constructor. Constructs a new QgsField object.
|
||||
|
||||
@ -262,7 +262,7 @@ Set the field name.
|
||||
Set variant ``type``.
|
||||
%End
|
||||
|
||||
void setType( QVariant::Type type ) /HoldGIL,Deprecated/;
|
||||
void setType( QVariant::Type type ) /HoldGIL,Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Set variant ``type``.
|
||||
|
||||
@ -278,7 +278,7 @@ When all the elements don't need to have the same type, set this to
|
||||
QVariant.Invalid.
|
||||
%End
|
||||
|
||||
void setSubType( QVariant::Type subType ) /HoldGIL,Deprecated/;
|
||||
void setSubType( QVariant::Type subType ) /HoldGIL,Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
If the field is a collection, set its element's type.
|
||||
When all the elements don't need to have the same type, set this to
|
||||
|
@ -377,7 +377,7 @@ Since QGIS 3.30, the optional ``typeString`` argument can be used to specify fie
|
||||
.. versionadded:: 3.16
|
||||
%End
|
||||
|
||||
static QIcon iconForFieldType( QVariant::Type type, QVariant::Type subType, const QString &typeString = QString() ) /Deprecated/;
|
||||
static QIcon iconForFieldType( QVariant::Type type, QVariant::Type subType, const QString &typeString = QString() ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Returns an icon corresponding to a field ``type``
|
||||
|
||||
|
@ -366,7 +366,7 @@ Parse a simple array (depth=1)
|
||||
the conversion is not possible.
|
||||
%End
|
||||
|
||||
static QVariantList parseArray( const QString &json, QVariant::Type type ) /Deprecated/;
|
||||
static QVariantList parseArray( const QString &json, QVariant::Type type ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Parse a simple array (depth=1)
|
||||
|
||||
|
@ -76,7 +76,7 @@ If the returned size is null, the legend will be drawn with the minimum possible
|
||||
.. seealso:: :py:func:`setLegendSize`
|
||||
%End
|
||||
|
||||
void drawLegend( QPainter *painter ) /Deprecated/;
|
||||
void drawLegend( QPainter *painter ) /Deprecated="Since 3.40. Use the variant which accepts a QgsRenderContext instead."/;
|
||||
%Docstring
|
||||
Draws the legend with given ``painter``. The legend will occupy the area reported in :py:func:`~QgsLegendRenderer.legendSize`.
|
||||
The ``painter`` should be scaled beforehand so that units correspond to millimeters.
|
||||
|
@ -171,7 +171,7 @@ If ``False``, then then columns will be individually resized to their minimum po
|
||||
.. seealso:: :py:func:`equalColumnWidth`
|
||||
%End
|
||||
|
||||
QColor fontColor() const /Deprecated/;
|
||||
QColor fontColor() const /Deprecated="Since 3.40. Use QgsLegendStyle.textFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the font color used for legend items.
|
||||
|
||||
@ -182,7 +182,7 @@ Returns the font color used for legend items.
|
||||
Use :py:func:`QgsLegendStyle.textFormat()` instead.
|
||||
%End
|
||||
|
||||
void setFontColor( const QColor &c ) /Deprecated/;
|
||||
void setFontColor( const QColor &c ) /Deprecated="Since 3.40. Use QgsLegendStyle.textFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the font color used for legend items.
|
||||
|
||||
@ -193,7 +193,7 @@ Sets the font color used for legend items.
|
||||
Use :py:func:`QgsLegendStyle.textFormat()` instead.
|
||||
%End
|
||||
|
||||
QColor layerFontColor() const /Deprecated/;
|
||||
QColor layerFontColor() const /Deprecated="Since 3.40. Use QgsLegendStyle.textFormat() instead."/;
|
||||
%Docstring
|
||||
Returns layer font color, defaults to :py:func:`~QgsLegendSettings.fontColor`
|
||||
|
||||
@ -206,7 +206,7 @@ Returns layer font color, defaults to :py:func:`~QgsLegendSettings.fontColor`
|
||||
Use :py:func:`QgsLegendStyle.textFormat()` instead.
|
||||
%End
|
||||
|
||||
void setLayerFontColor( const QColor &fontColor ) /Deprecated/;
|
||||
void setLayerFontColor( const QColor &fontColor ) /Deprecated="Since 3.40. Use QgsLegendStyle.textFormat() instead."/;
|
||||
%Docstring
|
||||
Sets layer font color to ``fontColor``
|
||||
Overrides :py:func:`~QgsLegendSettings.fontColor`
|
||||
@ -404,7 +404,7 @@ Returns whether to request legend graphics synchronously.
|
||||
.. versionadded:: 3.34
|
||||
%End
|
||||
|
||||
double lineSpacing() const /Deprecated/;
|
||||
double lineSpacing() const /Deprecated="Since 3.40. Use QgsLegendStyle.textFormat() from style() instead."/;
|
||||
%Docstring
|
||||
Returns the line spacing to use between lines of legend text.
|
||||
|
||||
@ -426,7 +426,7 @@ Sets the line spacing to use between lines of legend text.
|
||||
Use :py:func:`QgsLegendStyle.setTextFormat()` from :py:func:`~QgsLegendSettings.style` instead.
|
||||
%End
|
||||
|
||||
double mmPerMapUnit() const /Deprecated/;
|
||||
double mmPerMapUnit() const /Deprecated="Since 3.40. Use scale factor from render contexts instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
@ -434,7 +434,7 @@ Sets the line spacing to use between lines of legend text.
|
||||
Use scale factor from render contexts instead.
|
||||
%End
|
||||
|
||||
void setMmPerMapUnit( double mmPerMapUnit ) /Deprecated/;
|
||||
void setMmPerMapUnit( double mmPerMapUnit ) /Deprecated="Since 3.40. Set scale factor on render contexts instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
@ -442,7 +442,7 @@ Sets the line spacing to use between lines of legend text.
|
||||
Set scale factor on render contexts instead.
|
||||
%End
|
||||
|
||||
bool useAdvancedEffects() const /Deprecated/;
|
||||
bool useAdvancedEffects() const /Deprecated="Since 3.40. Use flags from render contexts instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
@ -450,7 +450,7 @@ Sets the line spacing to use between lines of legend text.
|
||||
Use flags from render contexts instead.
|
||||
%End
|
||||
|
||||
void setUseAdvancedEffects( bool use ) /Deprecated/;
|
||||
void setUseAdvancedEffects( bool use ) /Deprecated="Since 3.40. Set flag on render contexts instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
@ -458,7 +458,7 @@ Sets the line spacing to use between lines of legend text.
|
||||
Set flag on render contexts instead.
|
||||
%End
|
||||
|
||||
double mapScale() const /Deprecated/;
|
||||
double mapScale() const /Deprecated="Since 3.40. Take this property from the render context instead."/;
|
||||
%Docstring
|
||||
Returns the legend map scale.
|
||||
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
|
||||
@ -470,7 +470,7 @@ The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
|
||||
Take this property from the render context instead.
|
||||
%End
|
||||
|
||||
void setMapScale( double scale ) /Deprecated/;
|
||||
void setMapScale( double scale ) /Deprecated="Since 3.40. Set this property on the render context instead."/;
|
||||
%Docstring
|
||||
Sets the legend map ``scale``.
|
||||
The ``scale`` value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
|
||||
@ -482,7 +482,7 @@ The ``scale`` value indicates the scale denominator, e.g. 1000.0 for a 1:1000 ma
|
||||
Set this property on the render context instead.
|
||||
%End
|
||||
|
||||
double mapUnitsPerPixel() const /Deprecated/;
|
||||
double mapUnitsPerPixel() const /Deprecated="Since 3.40. Take these properties on render contexts instead."/;
|
||||
%Docstring
|
||||
Returns the factor of map units per pixel for symbols with size given in map units calculated by dpi and mmPerMapUnit
|
||||
|
||||
@ -493,7 +493,7 @@ Returns the factor of map units per pixel for symbols with size given in map uni
|
||||
Take these properties on render contexts instead.
|
||||
%End
|
||||
|
||||
void setMapUnitsPerPixel( double mapUnitsPerPixel ) /Deprecated/;
|
||||
void setMapUnitsPerPixel( double mapUnitsPerPixel ) /Deprecated="Since 3.40. Set these properties on render contexts instead."/;
|
||||
%Docstring
|
||||
Sets the mmPerMapUnit calculated by ``mapUnitsPerPixel`` mostly taken from the map settings.
|
||||
|
||||
@ -504,7 +504,7 @@ Sets the mmPerMapUnit calculated by ``mapUnitsPerPixel`` mostly taken from the m
|
||||
Set these properties on render contexts instead.
|
||||
%End
|
||||
|
||||
int dpi() const /Deprecated/;
|
||||
int dpi() const /Deprecated="Since 3.40. Take dpi from render contexts instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
@ -512,7 +512,7 @@ Sets the mmPerMapUnit calculated by ``mapUnitsPerPixel`` mostly taken from the m
|
||||
Take dpi from render contexts instead.
|
||||
%End
|
||||
|
||||
void setDpi( int dpi ) /Deprecated/;
|
||||
void setDpi( int dpi ) /Deprecated="Since 3.40. Set dpi on render contexts instead."/;
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: 3.40
|
||||
|
@ -43,7 +43,7 @@ Contains detailed styling information relating to how a layout legend should be
|
||||
|
||||
QgsLegendStyle();
|
||||
|
||||
QFont font() const /Deprecated/;
|
||||
QFont font() const /Deprecated="Since 3.40. Use textFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the font used for rendering this legend component.
|
||||
|
||||
@ -54,7 +54,7 @@ Returns the font used for rendering this legend component.
|
||||
Use :py:func:`~QgsLegendStyle.textFormat` instead.
|
||||
%End
|
||||
|
||||
void setFont( const QFont &font ) /Deprecated/;
|
||||
void setFont( const QFont &font ) /Deprecated="Since 3.40. Use setTextFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the ``font`` used for rendering this legend component.
|
||||
|
||||
|
@ -243,7 +243,7 @@ Returns the layer data provider's metadata, it may be ``None``.
|
||||
.. versionadded:: 3.40
|
||||
%End
|
||||
|
||||
void setShortName( const QString &shortName ) /Deprecated/;
|
||||
void setShortName( const QString &shortName ) /Deprecated="Since 3.38. Use serverProperties()->setShortName() instead."/;
|
||||
%Docstring
|
||||
Sets the short name of the layer used by QGIS Server to identify the layer.
|
||||
|
||||
@ -252,7 +252,7 @@ Sets the short name of the layer used by QGIS Server to identify the layer.
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.setShortName` instead.
|
||||
%End
|
||||
|
||||
QString shortName() const /Deprecated/;
|
||||
QString shortName() const /Deprecated="Since 3.38. Use serverProperties()->shortName() instead."/;
|
||||
%Docstring
|
||||
Returns the short name of the layer used by QGIS Server to identify the layer.
|
||||
|
||||
@ -261,7 +261,7 @@ Returns the short name of the layer used by QGIS Server to identify the layer.
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.shortName` instead.
|
||||
%End
|
||||
|
||||
void setTitle( const QString &title ) /Deprecated/;
|
||||
void setTitle( const QString &title ) /Deprecated="Since 3.38. Use serverProperties()->setTitle() instead."/;
|
||||
%Docstring
|
||||
Sets the title of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -270,7 +270,7 @@ Sets the title of the layer used by QGIS Server in GetCapabilities request.
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.setTitle` instead.
|
||||
%End
|
||||
|
||||
QString title() const /Deprecated/;
|
||||
QString title() const /Deprecated="Since 3.38. Use serverProperties()->title() instead."/;
|
||||
%Docstring
|
||||
Returns the title of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -279,7 +279,7 @@ Returns the title of the layer used by QGIS Server in GetCapabilities request.
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.title` instead.
|
||||
%End
|
||||
|
||||
void setAbstract( const QString &abstract ) /Deprecated/;
|
||||
void setAbstract( const QString &abstract ) /Deprecated="Since 3.38. Use serverProperties()->setAbstract() instead."/;
|
||||
%Docstring
|
||||
Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -288,7 +288,7 @@ Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.setAbstract` instead.
|
||||
%End
|
||||
|
||||
QString abstract() const /Deprecated/;
|
||||
QString abstract() const /Deprecated="Since 3.38. Use serverProperties()->abstract() instead."/;
|
||||
%Docstring
|
||||
Returns the abstract of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -297,7 +297,7 @@ Returns the abstract of the layer used by QGIS Server in GetCapabilities request
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.abstract` instead.
|
||||
%End
|
||||
|
||||
void setKeywordList( const QString &keywords ) /Deprecated/;
|
||||
void setKeywordList( const QString &keywords ) /Deprecated="Since 3.38. Use serverProperties()->setKeywordList() instead."/;
|
||||
%Docstring
|
||||
Sets the keyword list of the layerused by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -306,7 +306,7 @@ Sets the keyword list of the layerused by QGIS Server in GetCapabilities request
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.setKeywordList` instead.
|
||||
%End
|
||||
|
||||
QString keywordList() const /Deprecated/;
|
||||
QString keywordList() const /Deprecated="Since 3.38. Use serverProperties()->keywordList() instead."/;
|
||||
%Docstring
|
||||
Returns the keyword list of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -315,7 +315,7 @@ Returns the keyword list of the layer used by QGIS Server in GetCapabilities req
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.keywordList` instead.
|
||||
%End
|
||||
|
||||
void setDataUrl( const QString &dataUrl ) /Deprecated/;
|
||||
void setDataUrl( const QString &dataUrl ) /Deprecated="Since 3.38. Use serverProperties()->setDataUrl() instead."/;
|
||||
%Docstring
|
||||
Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -324,7 +324,7 @@ Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.setDataUrl` instead.
|
||||
%End
|
||||
|
||||
QString dataUrl() const /Deprecated/;
|
||||
QString dataUrl() const /Deprecated="Since 3.38. Use serverProperties()->dataUrl() instead."/;
|
||||
%Docstring
|
||||
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -333,7 +333,7 @@ Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.dataUrl` instead.
|
||||
%End
|
||||
|
||||
void setDataUrlFormat( const QString &dataUrlFormat ) /Deprecated/;
|
||||
void setDataUrlFormat( const QString &dataUrlFormat ) /Deprecated="Since 3.38. Use serverProperties()->setDataUrlFormat() instead."/;
|
||||
%Docstring
|
||||
Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -342,7 +342,7 @@ Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities requ
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.setDataUrlFormat` instead.
|
||||
%End
|
||||
|
||||
QString dataUrlFormat() const /Deprecated/;
|
||||
QString dataUrlFormat() const /Deprecated="Since 3.38. Use serverProperties()->dataUrlFormat() instead."/;
|
||||
%Docstring
|
||||
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -351,7 +351,7 @@ Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities r
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.dataUrlFormat` instead.
|
||||
%End
|
||||
|
||||
void setAttribution( const QString &attrib ) /Deprecated/;
|
||||
void setAttribution( const QString &attrib ) /Deprecated="Since 3.38. Use serverProperties()->setAttribution() instead."/;
|
||||
%Docstring
|
||||
Sets the attribution of the layerused by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -360,7 +360,7 @@ Sets the attribution of the layerused by QGIS Server in GetCapabilities request.
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.setAttribution` instead.
|
||||
%End
|
||||
|
||||
QString attribution() const /Deprecated/;
|
||||
QString attribution() const /Deprecated="Since 3.38. Use serverProperties()->attribution() instead."/;
|
||||
%Docstring
|
||||
Returns the attribution of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -369,7 +369,7 @@ Returns the attribution of the layer used by QGIS Server in GetCapabilities requ
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.attribution` instead.
|
||||
%End
|
||||
|
||||
void setAttributionUrl( const QString &attribUrl ) /Deprecated/;
|
||||
void setAttributionUrl( const QString &attribUrl ) /Deprecated="Since 3.38. Use serverProperties()->setAttributionUrl() instead."/;
|
||||
%Docstring
|
||||
Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -378,7 +378,7 @@ Sets the attribution URL of the layer used by QGIS Server in GetCapabilities req
|
||||
Use :py:func:`~QgsMapLayer.serverProperties`->:py:func:`~QgsMapLayer.setAttributionUrl` instead.
|
||||
%End
|
||||
|
||||
QString attributionUrl() const /Deprecated/;
|
||||
QString attributionUrl() const /Deprecated="Since 3.38. Use serverProperties()->attributionUrl() instead."/;
|
||||
%Docstring
|
||||
Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.
|
||||
|
||||
@ -394,7 +394,7 @@ Returns QGIS Server Properties for the map layer
|
||||
|
||||
.. versionadded:: 3.22
|
||||
%End
|
||||
void setMetadataUrl( const QString &metaUrl ) /Deprecated/;
|
||||
void setMetadataUrl( const QString &metaUrl ) /Deprecated="Since 3.22. "/;
|
||||
%Docstring
|
||||
Sets the metadata URL of the layer
|
||||
used by QGIS Server in GetCapabilities request.
|
||||
@ -406,7 +406,7 @@ Since QGIS 3.22, it edits the first metadata URL link.
|
||||
.. deprecated:: 3.22
|
||||
%End
|
||||
|
||||
QString metadataUrl() const /Deprecated/;
|
||||
QString metadataUrl() const /Deprecated="Since 3.22. "/;
|
||||
%Docstring
|
||||
Returns the metadata URL of the layer
|
||||
used by QGIS Server in GetCapabilities request.
|
||||
@ -420,7 +420,7 @@ Since QGIS 3.22, it returns the first metadata URL link.
|
||||
.. deprecated:: 3.22
|
||||
%End
|
||||
|
||||
void setMetadataUrlType( const QString &metaUrlType ) /Deprecated/;
|
||||
void setMetadataUrlType( const QString &metaUrlType ) /Deprecated="Since 3.22. "/;
|
||||
%Docstring
|
||||
Set the metadata type of the layer
|
||||
used by QGIS Server in GetCapabilities request
|
||||
@ -432,7 +432,7 @@ Since QGIS 3.22, it edits the first metadata URL type.
|
||||
.. deprecated:: 3.22
|
||||
%End
|
||||
|
||||
QString metadataUrlType() const /Deprecated/;
|
||||
QString metadataUrlType() const /Deprecated="Since 3.22. "/;
|
||||
%Docstring
|
||||
Returns the metadata type of the layer
|
||||
used by QGIS Server in GetCapabilities request.
|
||||
@ -446,7 +446,7 @@ Since QGIS 3.22, it returns the first metadata URL type.
|
||||
.. deprecated:: 3.22
|
||||
%End
|
||||
|
||||
void setMetadataUrlFormat( const QString &metaUrlFormat ) /Deprecated/;
|
||||
void setMetadataUrlFormat( const QString &metaUrlFormat ) /Deprecated="Since 3.22. "/;
|
||||
%Docstring
|
||||
Sets the metadata format of the layer
|
||||
used by QGIS Server in GetCapabilities request.
|
||||
@ -458,7 +458,7 @@ Since QGIS 3.22, it edits the first metadata URL format.
|
||||
.. deprecated:: 3.22
|
||||
%End
|
||||
|
||||
QString metadataUrlFormat() const /Deprecated/;
|
||||
QString metadataUrlFormat() const /Deprecated="Since 3.22. "/;
|
||||
%Docstring
|
||||
Returns the metadata format of the layer
|
||||
used by QGIS Server in GetCapabilities request.
|
||||
@ -1174,7 +1174,7 @@ record in the users style table in their personal qgis.db)
|
||||
.. seealso:: :py:func:`saveNamedStyle`
|
||||
%End
|
||||
|
||||
virtual QString saveDefaultStyle( bool &resultFlag /Out/ ) /Deprecated/;
|
||||
virtual QString saveDefaultStyle( bool &resultFlag /Out/ ) /Deprecated="Since 3.26. "/;
|
||||
%Docstring
|
||||
Save the properties of this layer as the default style
|
||||
(either as a .qml file on disk or as a
|
||||
@ -1559,7 +1559,7 @@ Returns whether scale based visibility is enabled for the layer.
|
||||
.. seealso:: :py:func:`isInScaleRange`
|
||||
%End
|
||||
|
||||
bool hasAutoRefreshEnabled() const /Deprecated/;
|
||||
bool hasAutoRefreshEnabled() const /Deprecated="Since 3.40. Use autoRefreshMode() instead."/;
|
||||
%Docstring
|
||||
Returns ``True`` if auto refresh is enabled for the layer.
|
||||
|
||||
@ -1607,7 +1607,7 @@ canvas must be refreshed separately in order to view the refreshed layer.
|
||||
.. seealso:: :py:func:`setAutoRefreshEnabled`
|
||||
%End
|
||||
|
||||
void setAutoRefreshEnabled( bool enabled ) /Deprecated/;
|
||||
void setAutoRefreshEnabled( bool enabled ) /Deprecated="Since 3.40. Use setAutoRefreshMode() instead."/;
|
||||
%Docstring
|
||||
Sets whether auto refresh is enabled for the layer.
|
||||
|
||||
|
@ -39,7 +39,7 @@ Sets ``filter`` flags which affect how layers are filtered within the model.
|
||||
.. seealso:: :py:func:`filters`
|
||||
%End
|
||||
|
||||
void setFilters( int filters ) /Deprecated/;
|
||||
void setFilters( int filters ) /Deprecated="Since 3.34. Use the flag signature instead."/;
|
||||
%Docstring
|
||||
Filters according to layer type and/or geometry type.
|
||||
|
||||
@ -77,7 +77,7 @@ Returns if the ``layer`` matches the given ``filters``
|
||||
.. versionadded:: 3.14
|
||||
%End
|
||||
|
||||
void setLayerWhitelist( const QList<QgsMapLayer *> &layers ) /Deprecated/;
|
||||
void setLayerWhitelist( const QList<QgsMapLayer *> &layers ) /Deprecated="Since 3.40. Use setLayerAllowList()."/;
|
||||
%Docstring
|
||||
Sets an allowlist of ``layers`` to include within the model. Only layers
|
||||
from this list will be shown.
|
||||
@ -107,7 +107,7 @@ An empty list indicates that no filter by allowlist should be performed.
|
||||
.. versionadded:: 3.14
|
||||
%End
|
||||
|
||||
QList<QgsMapLayer *> layerWhitelist() /Deprecated/;
|
||||
QList<QgsMapLayer *> layerWhitelist() /Deprecated="Since 3.40. Use layerAllowlist() instead."/;
|
||||
%Docstring
|
||||
Returns the list of layers which are excluded from the model.
|
||||
|
||||
|
@ -131,7 +131,7 @@ Transforms device coordinates to map (world) coordinates.
|
||||
:return: :py:class:`QgsPointXY` in map coorndiates
|
||||
%End
|
||||
|
||||
QgsPointXY toMapPoint( double x, double y ) const /Deprecated/;
|
||||
QgsPointXY toMapPoint( double x, double y ) const /Deprecated="Since 3.4. Use toMapCoordinates() instead."/;
|
||||
%Docstring
|
||||
Transforms device coordinates to map (world) coordinates.
|
||||
|
||||
|
@ -57,7 +57,7 @@ Returns a string representing the service type, e.g. "WMS".
|
||||
Returns the connection uri.
|
||||
%End
|
||||
|
||||
static QgsDataSourceUri &addWmsWcsConnectionSettings( QgsDataSourceUri &uri, const QString &settingsKey ) /Deprecated/;
|
||||
static QgsDataSourceUri &addWmsWcsConnectionSettings( QgsDataSourceUri &uri, const QString &settingsKey ) /Deprecated="Since 3.26. Use addWmsWcsConnectionSettings with service and connection name parameters."/;
|
||||
%Docstring
|
||||
Adds uri parameters relating to the settings for a WMS or WCS connection to a :py:class:`QgsDataSourceUri` ``uri``.
|
||||
Connection settings are taken from the specified QSettings ``settingsKey``.
|
||||
@ -75,7 +75,7 @@ Connection settings are taken from the specified ``servcie`` and ``connName``
|
||||
.. versionadded:: 3.26
|
||||
%End
|
||||
|
||||
static QgsDataSourceUri &addWfsConnectionSettings( QgsDataSourceUri &uri, const QString &settingsKey ) /Deprecated/;
|
||||
static QgsDataSourceUri &addWfsConnectionSettings( QgsDataSourceUri &uri, const QString &settingsKey ) /Deprecated="Since 3.26. Use addWfsConnectionSettings with service and connection name parameters."/;
|
||||
%Docstring
|
||||
Adds uri parameters relating to the settings for a WFS connection to a :py:class:`QgsDataSourceUri` ``uri``.
|
||||
Connection settings are taken from the specified QSettings ``settingsKey``.
|
||||
|
@ -231,7 +231,7 @@ Test using two arbitrary images at the specified paths for equality.
|
||||
.. versionadded:: 3.18
|
||||
%End
|
||||
|
||||
bool isKnownAnomaly( const QString &diffImageFile ) /Deprecated/;
|
||||
bool isKnownAnomaly( const QString &diffImageFile ) /Deprecated="Since 3.40. Use the test mask system instead."/;
|
||||
%Docstring
|
||||
Gets a list of all the anomalies. An anomaly is a rendered difference
|
||||
file where there is some red pixel content (indicating a render check
|
||||
|
@ -110,7 +110,7 @@ This is currently used to implement selective masking.
|
||||
%End
|
||||
|
||||
|
||||
void setDisabledSymbolLayers( const QSet<const QgsSymbolLayer *> &symbolLayers ) /Deprecated/;
|
||||
void setDisabledSymbolLayers( const QSet<const QgsSymbolLayer *> &symbolLayers ) /Deprecated="Since 3.30. And replaced with setDisabledSymbolLayersV2."/;
|
||||
%Docstring
|
||||
When rendering a map layer in a second pass (for selective masking),
|
||||
some symbol layers may be disabled.
|
||||
@ -142,7 +142,7 @@ Sets the list of disabled symbol layer ids.
|
||||
.. versionadded:: 3.30
|
||||
%End
|
||||
|
||||
QSet<const QgsSymbolLayer *> disabledSymbolLayers() const /Deprecated/;
|
||||
QSet<const QgsSymbolLayer *> disabledSymbolLayers() const /Deprecated="Since 3.30. And replaced with disabledSymbolLayersV2."/;
|
||||
%Docstring
|
||||
When rendering a map layer in a second pass (for selective masking),
|
||||
some symbol layers may be disabled.
|
||||
@ -873,7 +873,7 @@ in a mask painter, which is not meant to be visible, by definition.
|
||||
.. versionadded:: 3.12
|
||||
%End
|
||||
|
||||
QVariantMap customRenderingFlags() const /Deprecated/;
|
||||
QVariantMap customRenderingFlags() const /Deprecated="Since 3.40. Use customProperties() instead."/;
|
||||
%Docstring
|
||||
Gets custom rendering flags. Layers might honour these to alter their rendering.
|
||||
|
||||
@ -897,7 +897,7 @@ Objects might honour these to alter their rendering.
|
||||
.. versionadded:: 3.40
|
||||
%End
|
||||
|
||||
void setCustomRenderingFlag( const QString &flag, const QVariant &value ) /Deprecated/;
|
||||
void setCustomRenderingFlag( const QString &flag, const QVariant &value ) /Deprecated="Since 3.40. Use setCustomProperty() instead."/;
|
||||
%Docstring
|
||||
Sets a custom rendering flag. Layers might honour these to alter their rendering.
|
||||
|
||||
@ -922,7 +922,7 @@ Objects might honour these to alter their rendering.
|
||||
.. versionadded:: 3.40
|
||||
%End
|
||||
|
||||
void clearCustomRenderingFlag( const QString &flag ) /Deprecated/;
|
||||
void clearCustomRenderingFlag( const QString &flag ) /Deprecated="Since 3.40. Use clearCustomProperty() instead."/;
|
||||
%Docstring
|
||||
Clears the specified custom rendering flag.
|
||||
|
||||
@ -1026,7 +1026,7 @@ are drawn and behave during render operations.
|
||||
.. versionadded:: 3.38
|
||||
%End
|
||||
|
||||
void addSymbolLayerClipPath( const QString &symbolLayerId, QPainterPath path ) /Deprecated/;
|
||||
void addSymbolLayerClipPath( const QString &symbolLayerId, QPainterPath path ) /Deprecated="Since 3.38. Use addSymbolLayerClipGeometry() instead."/;
|
||||
%Docstring
|
||||
Add a clip ``path`` to be applied to the ``symbolLayer`` before rendering
|
||||
|
||||
@ -1037,7 +1037,7 @@ Add a clip ``path`` to be applied to the ``symbolLayer`` before rendering
|
||||
Use :py:func:`~QgsRenderContext.addSymbolLayerClipGeometry` instead.
|
||||
%End
|
||||
|
||||
QList<QPainterPath> symbolLayerClipPaths( const QString &symbolLayerId ) const /Deprecated/;
|
||||
QList<QPainterPath> symbolLayerClipPaths( const QString &symbolLayerId ) const /Deprecated="Since 3.38. Use symbolLayerClipGeometries() instead."/;
|
||||
%Docstring
|
||||
Returns clip paths to be applied to the ``symbolLayer`` before rendering
|
||||
|
||||
|
@ -38,7 +38,7 @@ Constructor to create a new runtime profiler.
|
||||
%End
|
||||
~QgsRuntimeProfiler();
|
||||
|
||||
void beginGroup( const QString &name ) /Deprecated/;
|
||||
void beginGroup( const QString &name ) /Deprecated="Since 3.40. Use start() instead."/;
|
||||
%Docstring
|
||||
Begin the group for the profiler. Groups will append {GroupName}/ to the
|
||||
front of the profile tag set using start.
|
||||
@ -50,7 +50,7 @@ front of the profile tag set using start.
|
||||
Use :py:func:`~QgsRuntimeProfiler.start` instead.
|
||||
%End
|
||||
|
||||
void endGroup() /Deprecated/;
|
||||
void endGroup() /Deprecated="Since 3.40. Use end() instead."/;
|
||||
%Docstring
|
||||
End the current active group.
|
||||
|
||||
|
@ -47,7 +47,7 @@ Convenient method to returns the translated name of the enum type
|
||||
.. versionadded:: 3.26
|
||||
%End
|
||||
|
||||
static QString snappingTypeFlagToString( Qgis::SnappingType type ) /Deprecated/;
|
||||
static QString snappingTypeFlagToString( Qgis::SnappingType type ) /Deprecated="Since 3.26. Use snappingTypeToString() instead."/;
|
||||
%Docstring
|
||||
Convenient method to return the translated name of the enum type
|
||||
:py:class:`Qgis`.SnappingTypes.
|
||||
@ -68,7 +68,7 @@ Convenient method to return an icon corresponding to the enum type
|
||||
.. versionadded:: 3.20
|
||||
%End
|
||||
|
||||
static QIcon snappingTypeFlagToIcon( Qgis::SnappingType type ) /Deprecated/;
|
||||
static QIcon snappingTypeFlagToIcon( Qgis::SnappingType type ) /Deprecated="Since 3.26. Use snappingTypeToIcon() instead."/;
|
||||
%Docstring
|
||||
Convenient method to return an icon corresponding to the enum type
|
||||
:py:class:`Qgis`.SnappingTypes.
|
||||
@ -90,7 +90,7 @@ This is a container of advanced configuration (per layer) of the snapping of the
|
||||
%End
|
||||
public:
|
||||
|
||||
IndividualLayerSettings( bool enabled, SnappingType type, double tolerance, Qgis::MapToolUnit units ) /Deprecated/;
|
||||
IndividualLayerSettings( bool enabled, SnappingType type, double tolerance, Qgis::MapToolUnit units ) /Deprecated="Since 3.12. Use the method with Qgis.SnappingTypes instead."/;
|
||||
%Docstring
|
||||
IndividualLayerSettings
|
||||
|
||||
@ -145,7 +145,7 @@ Returns the flags type (vertices | segments | area | centroid | middle)
|
||||
.. versionadded:: 3.12
|
||||
%End
|
||||
|
||||
QgsSnappingConfig::SnappingType type() const /Deprecated/;
|
||||
QgsSnappingConfig::SnappingType type() const /Deprecated="Since 3.12. Use typeFlag() instead."/;
|
||||
%Docstring
|
||||
Returns the flags type (vertices | segments | area | centroid | middle)
|
||||
|
||||
@ -154,7 +154,7 @@ Returns the flags type (vertices | segments | area | centroid | middle)
|
||||
Use :py:func:`~IndividualLayerSettings.typeFlag` instead.
|
||||
%End
|
||||
|
||||
void setType( SnappingType type ) /Deprecated/;
|
||||
void setType( SnappingType type ) /Deprecated="Since 3.12. Use setTypeFlag() instead."/;
|
||||
%Docstring
|
||||
define the type of snapping
|
||||
|
||||
@ -263,7 +263,7 @@ Returns the flags type (vertices | segments | area | centroid | middle)
|
||||
.. versionadded:: 3.12
|
||||
%End
|
||||
|
||||
QgsSnappingConfig::SnappingType type() const /Deprecated/;
|
||||
QgsSnappingConfig::SnappingType type() const /Deprecated="Since 3.12. Use typeFlag() instead."/;
|
||||
%Docstring
|
||||
Returns the flags type (vertices | segments | area | centroid | middle)
|
||||
|
||||
|
@ -78,7 +78,7 @@ that of the spatial index construction.
|
||||
|
||||
|
||||
|
||||
bool insertFeature( const QgsFeature &feature ) /Deprecated/;
|
||||
bool insertFeature( const QgsFeature &feature ) /Deprecated="Since 3.40. Use addFeature() instead."/;
|
||||
%Docstring
|
||||
Adds a ``feature`` to the index.
|
||||
|
||||
@ -107,7 +107,7 @@ The ``flags`` argument is ignored.
|
||||
.. seealso:: :py:func:`addFeature`
|
||||
%End
|
||||
|
||||
bool insertFeature( QgsFeatureId id, const QgsRectangle &bounds ) /Deprecated/;
|
||||
bool insertFeature( QgsFeatureId id, const QgsRectangle &bounds ) /Deprecated="Since 3.40. Use addFeature() instead."/;
|
||||
%Docstring
|
||||
Add a feature ``id`` to the index with a specified bounding box.
|
||||
|
||||
|
@ -29,7 +29,7 @@ Returns a user-friendly translated string representing a QVariant ``type``.
|
||||
The optional ``subType`` can be used to specify the type of variant list or map values.
|
||||
%End
|
||||
|
||||
static QString typeToDisplayString( QVariant::Type type, QVariant::Type subType = QVariant::Type::Invalid ) /Deprecated/;
|
||||
static QString typeToDisplayString( QVariant::Type type, QVariant::Type subType = QVariant::Type::Invalid ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Returns a user-friendly translated string representing a QVariant ``type``.
|
||||
|
||||
|
@ -245,7 +245,7 @@ Creates a clone of the FieldValueConverter.
|
||||
bool includeZ = false,
|
||||
const QgsAttributeList &attributes = QgsAttributeList(),
|
||||
QgsVectorFileWriter::FieldValueConverter *fieldValueConverter = 0
|
||||
) /Deprecated/;
|
||||
) /Deprecated="Since 3.40. Use writeAsVectorFormatV2() instead."/;
|
||||
%Docstring
|
||||
Write contents of vector layer to an (OGR supported) vector format
|
||||
|
||||
@ -296,7 +296,7 @@ Write contents of vector layer to an (OGR supported) vector format
|
||||
bool includeZ = false,
|
||||
const QgsAttributeList &attributes = QgsAttributeList(),
|
||||
QgsVectorFileWriter::FieldValueConverter *fieldValueConverter = 0
|
||||
) /Deprecated/;
|
||||
) /Deprecated="Since 3.40. Use writeAsVectorFormatV2() instead."/;
|
||||
%Docstring
|
||||
Writes a layer out to a vector file.
|
||||
|
||||
@ -400,7 +400,7 @@ Options to pass to :py:func:`~QgsVectorFileWriter.writeAsVectorFormat`
|
||||
const QgsVectorFileWriter::SaveVectorOptions &options,
|
||||
QString *newFilename = 0,
|
||||
QString *errorMessage /Out/ = 0
|
||||
) /Deprecated/;
|
||||
) /Deprecated="Since 3.40. Use writeAsVectorFormatV2() instead."/;
|
||||
%Docstring
|
||||
Writes a layer out to a vector file.
|
||||
|
||||
@ -427,7 +427,7 @@ Writes a layer out to a vector file.
|
||||
QString *newFilename = 0,
|
||||
Qgis::FeatureSymbologyExport symbologyExport = Qgis::FeatureSymbologyExport::NoSymbology,
|
||||
QgsFeatureSink::SinkFlags sinkFlags = QgsFeatureSink::SinkFlags()
|
||||
) /Deprecated/;
|
||||
) /Deprecated="Since 3.40. Use create() instead."/;
|
||||
%Docstring
|
||||
Create a new vector file writer
|
||||
|
||||
@ -469,7 +469,7 @@ Create a new vector file writer.
|
||||
const QgsVectorFileWriter::SaveVectorOptions &options,
|
||||
QString *newFilename = 0,
|
||||
QString *newLayer = 0,
|
||||
QString *errorMessage /Out/ = 0 ) /Deprecated/;
|
||||
QString *errorMessage /Out/ = 0 ) /Deprecated="Since 3.20. Use writeAsVectorFormatV3() instead."/;
|
||||
%Docstring
|
||||
Writes a layer out to a vector file.
|
||||
|
||||
|
@ -24,7 +24,7 @@ Bilinear Raster Resampler
|
||||
|
||||
QgsBilinearRasterResampler();
|
||||
|
||||
virtual void resample( const QImage &srcImage, QImage &dstImage ) /Deprecated/;
|
||||
virtual void resample( const QImage &srcImage, QImage &dstImage ) /Deprecated="Since 3.12. Use resampleV2() instead."/;
|
||||
|
||||
%Docstring
|
||||
|
||||
|
@ -28,7 +28,7 @@ Cubic Raster Resampler.
|
||||
virtual QImage resampleV2( const QImage &source, const QSize &size );
|
||||
|
||||
|
||||
virtual void resample( const QImage &srcImage, QImage &dstImage ) /Deprecated/;
|
||||
virtual void resample( const QImage &srcImage, QImage &dstImage ) /Deprecated="Since 3.12. Use resampleV2() instead."/;
|
||||
|
||||
%Docstring
|
||||
|
||||
|
@ -62,7 +62,7 @@ Factory method to create a new renderer
|
||||
virtual void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const;
|
||||
|
||||
|
||||
int band() const /Deprecated/;
|
||||
int band() const /Deprecated="Since 3.38. Use inputBand() instead."/;
|
||||
%Docstring
|
||||
Returns the band used by the renderer
|
||||
|
||||
@ -71,7 +71,7 @@ Returns the band used by the renderer
|
||||
Use :py:func:`~QgsHillshadeRenderer.inputBand` instead.
|
||||
%End
|
||||
|
||||
void setBand( int bandNo ) /Deprecated/;
|
||||
void setBand( int bandNo ) /Deprecated="Since 3.38. Use setInputBand() instead."/;
|
||||
%Docstring
|
||||
Sets the band used by the renderer.
|
||||
|
||||
|
@ -122,7 +122,7 @@ Returns optional category label
|
||||
Set category label
|
||||
%End
|
||||
|
||||
int band() const /Deprecated/;
|
||||
int band() const /Deprecated="Since 3.38. Use inputBand() instead."/;
|
||||
%Docstring
|
||||
Returns the raster band used for rendering the raster.
|
||||
|
||||
|
@ -73,7 +73,7 @@ The Field class represents a Raster Attribute Table field, including its name, u
|
||||
Creates a new Field with ``name``, ``type`` and ``usage``.
|
||||
%End
|
||||
|
||||
Field( const QString &name, const Qgis::RasterAttributeTableFieldUsage &usage, const QVariant::Type type ) /Deprecated/;
|
||||
Field( const QString &name, const Qgis::RasterAttributeTableFieldUsage &usage, const QVariant::Type type ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Creates a new Field with ``name``, ``type`` and ``usage``.
|
||||
|
||||
@ -264,7 +264,7 @@ Inserts a new ``field`` at ``position``, optionally reporting any error in ``err
|
||||
Creates a new field from ``name``, ``usage`` and ``type`` and inserts it at ``position``, optionally reporting any error in ``errorMessage``, returns ``True`` on success.
|
||||
%End
|
||||
|
||||
bool insertField( int position, const QString &name, const Qgis::RasterAttributeTableFieldUsage usage, const QVariant::Type type, QString *errorMessage /Out/ = 0 ) /Deprecated/;
|
||||
bool insertField( int position, const QString &name, const Qgis::RasterAttributeTableFieldUsage usage, const QVariant::Type type, QString *errorMessage /Out/ = 0 ) /Deprecated="Since 3.38. Use the method with a QMetaType.Type argument instead."/;
|
||||
%Docstring
|
||||
Creates a new field from ``name``, ``usage`` and ``type`` and inserts it at ``position``, optionally reporting any error in ``errorMessage``, returns ``True`` on success.
|
||||
|
||||
|
@ -21,7 +21,7 @@ The drawing pipe for raster layers.
|
||||
%End
|
||||
public:
|
||||
|
||||
QgsRasterDrawer( QgsRasterIterator *iterator, double dpiTarget ) /Deprecated/;
|
||||
QgsRasterDrawer( QgsRasterIterator *iterator, double dpiTarget ) /Deprecated="Since 3.28. Use the constructor without the ``dpiTarget`` argument instead, as DPI is now handled by the draw() method which accepts a QgsRenderContext."/;
|
||||
%Docstring
|
||||
The QgsRasterDrawer constructor.
|
||||
|
||||
|
@ -69,7 +69,7 @@ Ownership of the returned provider is passed to the caller.
|
||||
|
||||
|
||||
Qgis::RasterFileWriterResult writeRaster( const QgsRasterPipe *pipe, int nCols, int nRows, const QgsRectangle &outputExtent,
|
||||
const QgsCoordinateReferenceSystem &crs, QgsRasterBlockFeedback *feedback = 0 ) /Deprecated/;
|
||||
const QgsCoordinateReferenceSystem &crs, QgsRasterBlockFeedback *feedback = 0 ) /Deprecated="Since 3.8. Use version with transformContext instead."/;
|
||||
%Docstring
|
||||
Write raster file
|
||||
|
||||
|
@ -30,7 +30,7 @@ QGIS interface.
|
||||
QgsRasterFileWriterTask( const QgsRasterFileWriter &writer, QgsRasterPipe *pipe /Transfer/,
|
||||
int columns, int rows,
|
||||
const QgsRectangle &outputExtent,
|
||||
const QgsCoordinateReferenceSystem &crs ) /Deprecated/;
|
||||
const QgsCoordinateReferenceSystem &crs ) /Deprecated="Since 3.8. Use version with transformContext instead."/;
|
||||
%Docstring
|
||||
Constructor for QgsRasterFileWriterTask. Takes a source ``writer``,
|
||||
``columns``, ``rows``, ``outputExtent`` and destination ``crs``.
|
||||
|
@ -184,7 +184,7 @@ Clone itself, create deep copy
|
||||
Returns the capabilities supported by the interface.
|
||||
%End
|
||||
|
||||
QString capabilitiesString() const /Deprecated/;
|
||||
QString capabilitiesString() const /Deprecated="Since 3.40. Will be removed in QGIS 4.0."/;
|
||||
%Docstring
|
||||
Returns the raster interface capabilities in friendly format.
|
||||
|
||||
@ -295,7 +295,7 @@ It may be used to get info about original data, e.g. resolution to decide
|
||||
resampling etc.
|
||||
%End
|
||||
|
||||
QgsRasterBandStats bandStatistics( int bandNo, int stats, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0, QgsRasterBlockFeedback *feedback = 0 ) /Deprecated/;
|
||||
QgsRasterBandStats bandStatistics( int bandNo, int stats, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0, QgsRasterBlockFeedback *feedback = 0 ) /Deprecated="Since 3.40. Use Qgis.RasterBandStatistic instead of int for ``stats`` argument."/;
|
||||
%Docstring
|
||||
Returns the band statistics.
|
||||
|
||||
@ -324,7 +324,7 @@ Returns the band statistics.
|
||||
:param feedback: optional feedback object
|
||||
%End
|
||||
|
||||
bool hasStatistics( int bandNo, int stats, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0 ) /Deprecated/;
|
||||
bool hasStatistics( int bandNo, int stats, const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0 ) /Deprecated="Since 3.40. Use Qgis.RasterBandStatistic instead of int for ``stats`` argument."/;
|
||||
%Docstring
|
||||
Returns ``True`` if histogram is available (cached, already calculated).
|
||||
The parameters are the same as in :py:func:`~QgsRasterInterface.bandStatistics`
|
||||
@ -538,7 +538,7 @@ Fill in histogram defaults if not specified
|
||||
#endif
|
||||
%End
|
||||
|
||||
void initStatistics( QgsRasterBandStats &statistics, int bandNo, int stats, const QgsRectangle &boundingBox = QgsRectangle(), int binCount = 0 ) const /Deprecated/;
|
||||
void initStatistics( QgsRasterBandStats &statistics, int bandNo, int stats, const QgsRectangle &boundingBox = QgsRectangle(), int binCount = 0 ) const /Deprecated="Since 3.40. Use Qgis.RasterBandStatistic instead of int for ``stats`` argument."/;
|
||||
%Docstring
|
||||
Fill in statistics defaults if not specified
|
||||
|
||||
|
@ -124,7 +124,7 @@ returned in ``retError``.
|
||||
Returns time stamp for given file name
|
||||
%End
|
||||
|
||||
void setDataProvider( const QString &provider ) /Deprecated/;
|
||||
void setDataProvider( const QString &provider ) /Deprecated="Since 3.40. Use the version with ProviderOptions instead."/;
|
||||
%Docstring
|
||||
Set the data provider.
|
||||
|
||||
@ -286,7 +286,7 @@ This will be ``None`` if the layer is invalid.
|
||||
This is an overloaded version of the :py:func:`~QgsRasterLayer.draw` function that is called by both :py:func:`~QgsRasterLayer.draw` and thumbnailAsPixmap
|
||||
%End
|
||||
|
||||
QgsLegendColorList legendSymbologyItems() const /Deprecated/;
|
||||
QgsLegendColorList legendSymbologyItems() const /Deprecated="Since 3.40. Use QgsRasterRenderer.createLegendNodes() instead."/;
|
||||
%Docstring
|
||||
Returns a list with classification items (Text and color).
|
||||
|
||||
|
@ -49,7 +49,7 @@ PROJ transformations for optimised bulk reprojection of points.
|
||||
|
||||
|
||||
void setCrs( const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destCRS,
|
||||
int srcDatumTransform = -1, int destDatumTransform = -1 ) /Deprecated/;
|
||||
int srcDatumTransform = -1, int destDatumTransform = -1 ) /Deprecated="Since 3.8. Use transformContext version instead."/;
|
||||
%Docstring
|
||||
Sets the source and destination CRS
|
||||
|
||||
|
@ -32,7 +32,7 @@ Interface for resampling rasters (e.g. to have a smoother appearance)
|
||||
public:
|
||||
virtual ~QgsRasterResampler();
|
||||
|
||||
virtual void resample( const QImage &srcImage, QImage &dstImage ) = 0 /Deprecated/;
|
||||
virtual void resample( const QImage &srcImage, QImage &dstImage ) = 0 /Deprecated="Since 3.10.1. Use the more efficient QgsRasterResamplerV2 interface instead."/;
|
||||
%Docstring
|
||||
Resamples a source image to a destination image.
|
||||
|
||||
|
@ -142,7 +142,7 @@ Sets the transparent three value pixel list, replacing the whole existing list.
|
||||
.. seealso:: :py:func:`transparentThreeValuePixelList`
|
||||
%End
|
||||
|
||||
int alphaValue( double value, int globalTransparency = 255 ) const /Deprecated/;
|
||||
int alphaValue( double value, int globalTransparency = 255 ) const /Deprecated="Since 3.40. Use opacityForValue() instead."/;
|
||||
%Docstring
|
||||
Returns the transparency value for a single ``value`` pixel.
|
||||
|
||||
@ -167,7 +167,7 @@ the opacity corresponding to the value. Returns 1 if no matches are found.
|
||||
.. versionadded:: 3.38
|
||||
%End
|
||||
|
||||
int alphaValue( double redValue, double greenValue, double blueValue, int globalTransparency = 255 ) const /Deprecated/;
|
||||
int alphaValue( double redValue, double greenValue, double blueValue, int globalTransparency = 255 ) const /Deprecated="Since 3.40. Use opacityForRgbValues() instead."/;
|
||||
%Docstring
|
||||
Returns the transparency value for a RGB pixel.
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user