mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-22 00:14:55 -05:00
Header files: remove all mentions of '\since QGIS 3.0'
This commit is contained in:
Even Rouault
parent
02caeb9db7
commit
15ea5c46bc
@ -81,8 +81,6 @@ Abstract base class for material settings.
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -20,8 +20,6 @@ with three color components: ambient, diffuse and specular.
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class Qgs3DAlgorithms: QgsProcessingProvider
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
QGIS 3D processing algorithm provider.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -22,8 +22,6 @@ Entity that encapsulates our 3D scene - contains all other entities (such as ter
|
||||
.. note::
|
||||
|
||||
Not available in Python bindings
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -16,8 +16,6 @@ class Qgs3DMapSettings : QObject, QgsTemporalRangeObject
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Definition of the world.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -125,8 +123,6 @@ Returns the path resolver for conversion between relative and absolute paths
|
||||
during rendering operations, e.g. for resolving relative symbol paths.
|
||||
|
||||
.. seealso:: :py:func:`setPathResolver`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setPathResolver( const QgsPathResolver &resolver );
|
||||
@ -135,8 +131,6 @@ Sets the path ``resolver`` for conversion between relative and absolute paths
|
||||
during rendering operations, e.g. for resolving relative symbol paths.
|
||||
|
||||
.. seealso:: :py:func:`pathResolver`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsMapThemeCollection *mapThemeCollection() const;
|
||||
|
||||
@ -21,8 +21,6 @@ Object that controls camera movement based on user input
|
||||
.. note::
|
||||
|
||||
Not available in Python bindings
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -22,8 +22,6 @@ Metadata for vector layer 3D renderer to allow creation of its instances from XM
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -45,8 +43,6 @@ class QgsVectorLayer3DRenderer : QgsAbstractVectorLayer3DRenderer
|
||||
%Docstring(signature="appended")
|
||||
3D renderer that renders all features of a vector layer with the same 3D symbol.
|
||||
The appearance is completely defined by the symbol.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -19,8 +19,6 @@ class QgsLine3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -20,8 +20,6 @@ class QgsPoint3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -20,8 +20,6 @@ class QgsPolygon3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -81,8 +81,6 @@ Abstract base class for material settings.
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -20,8 +20,6 @@ with three color components: ambient, diffuse and specular.
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class Qgs3DAlgorithms: QgsProcessingProvider
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
QGIS 3D processing algorithm provider.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -22,8 +22,6 @@ Entity that encapsulates our 3D scene - contains all other entities (such as ter
|
||||
.. note::
|
||||
|
||||
Not available in Python bindings
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -16,8 +16,6 @@ class Qgs3DMapSettings : QObject, QgsTemporalRangeObject
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Definition of the world.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -125,8 +123,6 @@ Returns the path resolver for conversion between relative and absolute paths
|
||||
during rendering operations, e.g. for resolving relative symbol paths.
|
||||
|
||||
.. seealso:: :py:func:`setPathResolver`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setPathResolver( const QgsPathResolver &resolver );
|
||||
@ -135,8 +131,6 @@ Sets the path ``resolver`` for conversion between relative and absolute paths
|
||||
during rendering operations, e.g. for resolving relative symbol paths.
|
||||
|
||||
.. seealso:: :py:func:`pathResolver`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsMapThemeCollection *mapThemeCollection() const;
|
||||
|
||||
@ -21,8 +21,6 @@ Object that controls camera movement based on user input
|
||||
.. note::
|
||||
|
||||
Not available in Python bindings
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -22,8 +22,6 @@ Metadata for vector layer 3D renderer to allow creation of its instances from XM
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -45,8 +43,6 @@ class QgsVectorLayer3DRenderer : QgsAbstractVectorLayer3DRenderer
|
||||
%Docstring(signature="appended")
|
||||
3D renderer that renders all features of a vector layer with the same 3D symbol.
|
||||
The appearance is completely defined by the symbol.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -19,8 +19,6 @@ class QgsLine3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -20,8 +20,6 @@ class QgsPoint3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -20,8 +20,6 @@ class QgsPolygon3DSymbol : QgsAbstract3DSymbol /NoDefaultCtors/
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings as a tech preview only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -36,8 +36,6 @@ weighted with distance. Smaller values mean sharper peaks at the data points.
|
||||
Point values are weighted by 1 / ( distance ^ coefficient ).
|
||||
|
||||
.. seealso:: :py:func:`distanceCoefficient`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double distanceCoefficient() const;
|
||||
@ -49,8 +47,6 @@ The default is a coefficient of 2.
|
||||
Point values are weighted by 1 / ( distance ^ coefficient ).
|
||||
|
||||
.. seealso:: :py:func:`setDistanceCoefficient`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
||||
@ -14,8 +14,6 @@ class QgsTinInterpolator: QgsInterpolator
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Interpolation in a triangular irregular network
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -47,8 +45,6 @@ These fields should be used when creating
|
||||
a suitable feature sink for :py:func:`~QgsTinInterpolator.setTriangulationSink`
|
||||
|
||||
.. seealso:: :py:func:`setTriangulationSink`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setTriangulationSink( QgsFeatureSink *sink );
|
||||
@ -59,8 +55,6 @@ The sink must be setup to accept LineString features, with fields matching
|
||||
those returned by :py:func:`~QgsTinInterpolator.triangulationFields`.
|
||||
|
||||
.. seealso:: :py:func:`triangulationFields`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
||||
@ -16,8 +16,6 @@ class QgsGraphEdge
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
This class implements a graph edge
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -65,8 +63,6 @@ class QgsGraphVertex
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
This class implements a graph vertex
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -111,8 +107,6 @@ class QgsGraph
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Mathematical graph representation
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsNetworkDistanceStrategy : QgsNetworkStrategy
|
||||
%Docstring(signature="appended")
|
||||
Strategy for calculating edge cost based on its length. Should be
|
||||
used for finding shortest path between two points.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsNetworkSpeedStrategy : QgsNetworkStrategy
|
||||
%Docstring(signature="appended")
|
||||
Strategy for calculating edge cost based on travel time. Should be
|
||||
used for finding fastest path between two points.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -22,8 +22,6 @@ class QgsNetworkStrategy
|
||||
take into account travel distance, amount of time or money. Currently there are two strategies
|
||||
implemented in the analysis library: :py:class:`QgsNetworkDistanceStrategy` and :py:class:`QgsNetworkSpeedStrategy`.
|
||||
:py:class:`QgsNetworkStrategy` implemented using "strategy" design pattern.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -14,8 +14,6 @@ class QgsVectorLayerDirector : QgsGraphDirector
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Determine making the graph from vector line layer
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsNativeAlgorithms: QgsProcessingProvider
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Native c++ processing algorithm provider.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -15,8 +15,6 @@ class QgsKernelDensityEstimation
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Performs Kernel Density Estimation ("heatmap") calculations on a vector layer.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -17,8 +17,6 @@ class QgsGeometrySnapper : QObject
|
||||
:py:class:`QgsGeometrySnapper` allows a geometry to be snapped to the geometries within a
|
||||
different reference layer. Vertices in the geometries will be modified to
|
||||
match the reference layer features within a specified snap tolerance.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -85,8 +83,6 @@ features are fed to to the snapper one-by-one by calling :py:func:`~QgsGeometryS
|
||||
After processing all desired features, the results can be fetched by calling :py:func:`~QgsGeometrySnapper.snappedGeometries`.
|
||||
The returned :py:class:`QgsGeometryMap` can be passed to :py:func:`QgsVectorDataProvider.changeGeometryValues()` to save
|
||||
the snapped geometries back to the source layer.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -47,7 +47,7 @@ QgsDiagramLayerSettings.AlwaysShow.__doc__ = "Whether the diagram should always
|
||||
QgsDiagramLayerSettings.StartAngle = QgsDiagramLayerSettings.Property.StartAngle
|
||||
QgsDiagramLayerSettings.StartAngle.is_monkey_patched = True
|
||||
QgsDiagramLayerSettings.StartAngle.__doc__ = "Angle offset for pie diagram"
|
||||
QgsDiagramLayerSettings.Property.__doc__ = "Data definable properties.\n\n.. versionadded:: 3.0\n\n" + '* ``BackgroundColor``: ' + QgsDiagramLayerSettings.Property.BackgroundColor.__doc__ + '\n' + '* ``StrokeColor``: ' + QgsDiagramLayerSettings.Property.StrokeColor.__doc__ + '\n' + '* ``StrokeWidth``: ' + QgsDiagramLayerSettings.Property.StrokeWidth.__doc__ + '\n' + '* ``PositionX``: ' + QgsDiagramLayerSettings.Property.PositionX.__doc__ + '\n' + '* ``PositionY``: ' + QgsDiagramLayerSettings.Property.PositionY.__doc__ + '\n' + '* ``Distance``: ' + QgsDiagramLayerSettings.Property.Distance.__doc__ + '\n' + '* ``Priority``: ' + QgsDiagramLayerSettings.Property.Priority.__doc__ + '\n' + '* ``ZIndex``: ' + QgsDiagramLayerSettings.Property.ZIndex.__doc__ + '\n' + '* ``IsObstacle``: ' + QgsDiagramLayerSettings.Property.IsObstacle.__doc__ + '\n' + '* ``Show``: ' + QgsDiagramLayerSettings.Property.Show.__doc__ + '\n' + '* ``AlwaysShow``: ' + QgsDiagramLayerSettings.Property.AlwaysShow.__doc__ + '\n' + '* ``StartAngle``: ' + QgsDiagramLayerSettings.Property.StartAngle.__doc__
|
||||
QgsDiagramLayerSettings.Property.__doc__ = "Data definable properties.\n\n" + '* ``BackgroundColor``: ' + QgsDiagramLayerSettings.Property.BackgroundColor.__doc__ + '\n' + '* ``StrokeColor``: ' + QgsDiagramLayerSettings.Property.StrokeColor.__doc__ + '\n' + '* ``StrokeWidth``: ' + QgsDiagramLayerSettings.Property.StrokeWidth.__doc__ + '\n' + '* ``PositionX``: ' + QgsDiagramLayerSettings.Property.PositionX.__doc__ + '\n' + '* ``PositionY``: ' + QgsDiagramLayerSettings.Property.PositionY.__doc__ + '\n' + '* ``Distance``: ' + QgsDiagramLayerSettings.Property.Distance.__doc__ + '\n' + '* ``Priority``: ' + QgsDiagramLayerSettings.Property.Priority.__doc__ + '\n' + '* ``ZIndex``: ' + QgsDiagramLayerSettings.Property.ZIndex.__doc__ + '\n' + '* ``IsObstacle``: ' + QgsDiagramLayerSettings.Property.IsObstacle.__doc__ + '\n' + '* ``Show``: ' + QgsDiagramLayerSettings.Property.Show.__doc__ + '\n' + '* ``AlwaysShow``: ' + QgsDiagramLayerSettings.Property.AlwaysShow.__doc__ + '\n' + '* ``StartAngle``: ' + QgsDiagramLayerSettings.Property.StartAngle.__doc__
|
||||
# --
|
||||
QgsDiagramSettings.Height = QgsDiagramSettings.LabelPlacementMethod.Height
|
||||
QgsDiagramSettings.XHeight = QgsDiagramSettings.LabelPlacementMethod.XHeight
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -15,8 +15,6 @@ class Qgs3DRendererAbstractMetadata
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Base metadata class for 3D renderers. Instances of derived classes may be registered in Qgs3DRendererRegistry.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -52,8 +50,6 @@ class Qgs3DRendererRegistry
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Keeps track of available 3D renderers. Should be accessed through :py:func:`QgsApplication.renderer3DRegistry()` singleton.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -21,8 +21,6 @@ will be added to the 3D scene to represent data in renderer's display style.
|
||||
|
||||
Renderers may store some custom properties (e.g. materials, sizes) that are written to and read from
|
||||
XML. It is therefore not recommended to store large amount of data within a renderer (e.g. arrays of vertices).
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -28,9 +28,6 @@ Abstract base class for 3D symbols that are used by VectorLayer3DRenderer object
|
||||
.. note::
|
||||
|
||||
Prior to QGIS 3.16 this was available through the QGIS 3D library.
|
||||
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -79,15 +79,11 @@ The short title is used to label user interface elements like buttons
|
||||
QUuid id() const;
|
||||
%Docstring
|
||||
Returns a unique id for this action.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool isValid() const;
|
||||
%Docstring
|
||||
Returns ``True`` if this action was a default constructed one.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QString iconPath() const;
|
||||
@ -105,15 +101,11 @@ The icon
|
||||
Returns the command that is executed by this action.
|
||||
How the content is interpreted depends on the :py:func:`~QgsAction.type` and
|
||||
the :py:func:`~QgsAction.actionScope`.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QString notificationMessage() const;
|
||||
%Docstring
|
||||
Returns the notification message that triggers the action
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
Qgis::AttributeActionType type() const;
|
||||
@ -147,15 +139,11 @@ Checks if the action is runable on the current platform
|
||||
void run( QgsVectorLayer *layer, const QgsFeature &feature, const QgsExpressionContext &expressionContext ) const;
|
||||
%Docstring
|
||||
Run this action.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void run( const QgsExpressionContext &expressionContext ) const;
|
||||
%Docstring
|
||||
Run this action.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QSet<QString> actionScopes() const;
|
||||
@ -165,8 +153,6 @@ Action scopes may offer additional variables like the clicked
|
||||
coordinate.
|
||||
|
||||
.. seealso:: :py:class:`QgsActionScope`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setActionScopes( const QSet<QString> &actionScopes );
|
||||
@ -174,38 +160,28 @@ coordinate.
|
||||
The action scopes define where an action will be available.
|
||||
Action scopes may offer additional variables like the clicked
|
||||
coordinate.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void readXml( const QDomNode &actionNode );
|
||||
%Docstring
|
||||
Reads an XML definition from actionNode
|
||||
into this object.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void writeXml( QDomNode &actionsNode ) const;
|
||||
%Docstring
|
||||
Appends an XML definition for this action as a new
|
||||
child node to actionsNode.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setExpressionContextScope( const QgsExpressionContextScope &scope );
|
||||
%Docstring
|
||||
Sets an expression context scope to use for running the action.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsExpressionContextScope expressionContextScope() const;
|
||||
%Docstring
|
||||
Returns an expression context scope used for running the action.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QString html( ) const;
|
||||
|
||||
@ -56,8 +56,6 @@ Add a new action to this list.
|
||||
void removeAction( QUuid actionId );
|
||||
%Docstring
|
||||
Remove an action by its id.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void doAction( QUuid actionId, const QgsFeature &feature, int defaultValueIndex = 0, const QgsExpressionContextScope &scope = QgsExpressionContextScope() ) /PyName=doActionFeature/;
|
||||
@ -93,8 +91,6 @@ Removes all actions
|
||||
%Docstring
|
||||
Returns a list of actions that are available in the given action scope.
|
||||
If no action scope is provided, all actions will be returned.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsVectorLayer *layer() const;
|
||||
@ -115,8 +111,6 @@ Reads the actions in in XML format
|
||||
QgsAction action( QUuid id ) const;
|
||||
%Docstring
|
||||
Gets an action by its ``id``.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsAction action( const QString &id ) const;
|
||||
@ -130,16 +124,12 @@ Gets an action by its ``id``.
|
||||
%Docstring
|
||||
Each scope can have a default action. This will be saved in the project
|
||||
file.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsAction defaultAction( const QString &actionScope );
|
||||
%Docstring
|
||||
Each scope can have a default action. This will be saved in the project
|
||||
file.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
||||
@ -29,8 +29,6 @@ form.</dd>
|
||||
<dt>Layer</dt>
|
||||
<dd>Show in attribute table and work on the layer or selection.</dd>
|
||||
</dl>
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -44,8 +42,6 @@ form.</dd>
|
||||
explicit QgsActionScope();
|
||||
%Docstring
|
||||
Creates a new invalid action scope.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
explicit QgsActionScope( const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope = QgsExpressionContextScope() );
|
||||
@ -62,8 +58,6 @@ of the corresponding properties.
|
||||
An expression scope may offer additional variables for an action scope.
|
||||
This can be an `field_name` for the attribute which was clicked or
|
||||
`click_x` and `click_y` for actions which are available as map canvas clicks.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
|
||||
@ -74,8 +68,6 @@ This can be an `field_name` for the attribute which was clicked or
|
||||
QString id() const;
|
||||
%Docstring
|
||||
A unique identifier for this action scope.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setId( const QString &id );
|
||||
@ -87,8 +79,6 @@ A unique identifier for this action scope.
|
||||
%Docstring
|
||||
The title is a human readable and translated string that will be
|
||||
presented to the user in the properties dialog.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
void setTitle( const QString &title );
|
||||
%Docstring
|
||||
@ -100,8 +90,6 @@ presented to the user in the properties dialog.
|
||||
The description should be a longer description of where actions in this scope
|
||||
are available. It is not necessary to list the available expression variables
|
||||
in here, they are extracted automatically from the :py:func:`~QgsActionScope.expressionContextScope`.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
void setDescription( const QString &description );
|
||||
%Docstring
|
||||
@ -111,8 +99,6 @@ in here, they are extracted automatically from the :py:func:`~QgsActionScope.exp
|
||||
bool isValid() const;
|
||||
%Docstring
|
||||
Returns if this scope is valid.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
Py_hash_t __hash__();
|
||||
%MethodCode
|
||||
|
||||
@ -21,8 +21,6 @@ To get access use the :py:class:`QgsApplication`:
|
||||
.. code-block:: python
|
||||
|
||||
QgsApplication.actionScopeRegistry()
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -36,36 +34,26 @@ Create a new QgsActionScopeRegistry.
|
||||
QGIS already creates a central registry. You will normally
|
||||
want to use :py:func:`QgsApplication.actionScopeRegistry()` to get access
|
||||
to that one instead.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QSet<QgsActionScope> actionScopes() const;
|
||||
%Docstring
|
||||
Gets all registered action scopes.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void registerActionScope( const QgsActionScope &actionScope );
|
||||
%Docstring
|
||||
Register an additional action scope.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void unregisterActionScope( const QgsActionScope &actionScope );
|
||||
%Docstring
|
||||
Unregister an additional action scope.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsActionScope actionScope( const QString &id );
|
||||
%Docstring
|
||||
Gets an action scope by its id.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
signals:
|
||||
@ -74,8 +62,6 @@ Gets an action scope by its id.
|
||||
%Docstring
|
||||
Emitted whenever a new action scope is registered or an action scope
|
||||
is unregistered.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
||||
@ -26,8 +26,6 @@ Annotations with a fixed map position also have a corresponding
|
||||
|
||||
Derived classes should implement their custom painting routines within
|
||||
a :py:func:`~renderAnnotation` override.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -21,8 +21,6 @@ rather accessed through a :py:class:`QgsProject` via :py:func:`QgsProject.annota
|
||||
|
||||
:py:class:`QgsAnnotationManager` retains ownership of all the annotations contained
|
||||
in the manager.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -16,8 +16,6 @@ class QgsHtmlAnnotation: QgsAnnotation
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
An annotation item that embeds HTML content.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsSvgAnnotation: QgsAnnotation
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
An annotation which renders the contents of an SVG file.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsTextAnnotation: QgsAnnotation
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
An annotation item that displays formatted text from a QTextDocument document.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -430,8 +430,6 @@ authSetting get an authentication setting (retrieved as string and returned as Q
|
||||
:param decrypt: if the value needs decrypted
|
||||
|
||||
:return: QVariant( QString ) authentication setting
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool existsAuthSetting( const QString &key );
|
||||
@ -462,8 +460,6 @@ certIdentity get a certificate identity by ``id`` (sha hash)
|
||||
:param id: sha hash of the cert
|
||||
|
||||
:return: the certificate
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
@ -474,8 +470,6 @@ certIdentityBundleToPem get a certificate identity bundle by ``id`` (sha hash) r
|
||||
:param id: sha hash
|
||||
|
||||
:return: a list of strings
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QList<QSslCertificate> certIdentities();
|
||||
@ -483,8 +477,6 @@ certIdentityBundleToPem get a certificate identity bundle by ``id`` (sha hash) r
|
||||
certIdentities get certificate identities
|
||||
|
||||
:return: list of certificates
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
@ -493,8 +485,6 @@ certIdentities get certificate identities
|
||||
certIdentityIds get list of certificate identity ids from database
|
||||
|
||||
:return: list of certificate ids
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool existsCertIdentity( const QString &id );
|
||||
@ -521,8 +511,6 @@ sslCertCustomConfig get an SSL certificate custom config by ``id`` (sha hash) an
|
||||
:param hostport: string host:port
|
||||
|
||||
:return: a SSL certificate custom config
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QgsAuthConfigSslServer sslCertCustomConfigByHost( const QString &hostport );
|
||||
@ -532,8 +520,6 @@ sslCertCustomConfigByHost get an SSL certificate custom config by ``hostport`` (
|
||||
:param hostport: host:port
|
||||
|
||||
:return: a SSL certificate custom config
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QList<QgsAuthConfigSslServer> sslCertCustomConfigs();
|
||||
@ -541,8 +527,6 @@ sslCertCustomConfigByHost get an SSL certificate custom config by ``hostport`` (
|
||||
sslCertCustomConfigs get SSL certificate custom configs
|
||||
|
||||
:return: list of SSL certificate custom config
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool existsSslCertCustomConfig( const QString &id, const QString &hostport );
|
||||
@ -595,8 +579,6 @@ certAuthority get a certificate authority by ``id`` (sha hash)
|
||||
:param id: sha hash
|
||||
|
||||
:return: a certificate
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool existsCertAuthority( const QSslCertificate &cert );
|
||||
@ -614,8 +596,6 @@ Remove a certificate authority
|
||||
systemRootCAs get root system certificate authorities
|
||||
|
||||
:return: list of certificate authorities
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QList<QSslCertificate> extraFileCAs();
|
||||
@ -623,8 +603,6 @@ systemRootCAs get root system certificate authorities
|
||||
extraFileCAs extra file-based certificate authorities
|
||||
|
||||
:return: list of certificate authorities
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QList<QSslCertificate> databaseCAs();
|
||||
@ -632,8 +610,6 @@ extraFileCAs extra file-based certificate authorities
|
||||
databaseCAs get database-stored certificate authorities
|
||||
|
||||
:return: list of certificate authorities
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QMap<QString, QSslCertificate> mappedDatabaseCAs();
|
||||
@ -641,8 +617,6 @@ databaseCAs get database-stored certificate authorities
|
||||
mappedDatabaseCAs get sha1-mapped database-stored certificate authorities
|
||||
|
||||
:return: sha1-mapped certificate authorities
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
@ -663,8 +637,6 @@ certTrustPolicy get whether certificate ``cert`` is trusted by user
|
||||
:param cert:
|
||||
|
||||
:return: DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool removeCertTrustPolicies( const QList<QSslCertificate> &certs );
|
||||
@ -684,8 +656,6 @@ certificateTrustPolicy get trust policy for a particular certificate ``cert``
|
||||
:param cert:
|
||||
|
||||
:return: DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool setDefaultCertTrustPolicy( QgsAuthCertUtils::CertTrustPolicy policy );
|
||||
@ -703,8 +673,6 @@ Gets the default certificate trust policy preferred by user
|
||||
certTrustCache get cache of certificate sha1s, per trust policy
|
||||
|
||||
:return: trust-policy-mapped certificate sha1s
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool rebuildCertTrustCache();
|
||||
@ -719,8 +687,6 @@ trustedCaCerts get list of all trusted CA certificates
|
||||
:param includeinvalid: whether invalid certs needs to be returned
|
||||
|
||||
:return: list of certificates
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QList<QSslCertificate> untrustedCaCerts( QList<QSslCertificate> trustedCAs = QList<QSslCertificate>() );
|
||||
@ -728,8 +694,6 @@ trustedCaCerts get list of all trusted CA certificates
|
||||
untrustedCaCerts get list of untrusted certificate authorities
|
||||
|
||||
:return: list of certificates
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool rebuildTrustedCaCertsCache();
|
||||
@ -742,8 +706,6 @@ Rebuild trusted certificate authorities cache
|
||||
trustedCaCertsCache cache of trusted certificate authorities, ready for network connections
|
||||
|
||||
:return: list of certificates
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QByteArray trustedCaCertsPemText();
|
||||
@ -751,8 +713,6 @@ trustedCaCertsCache cache of trusted certificate authorities, ready for network
|
||||
trustedCaCertsPemText get concatenated string of all trusted CA certificates
|
||||
|
||||
:return: bye array with all PEM encoded trusted CAs
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
|
||||
@ -220,8 +220,6 @@ If ``name`` is specified, it will be used as the favorite's name. Otherwise
|
||||
the name will be set to match ``directory``.
|
||||
|
||||
.. seealso:: :py:func:`removeFavorite`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void removeFavorite( const QModelIndex &index );
|
||||
@ -229,8 +227,6 @@ the name will be set to match ``directory``.
|
||||
Removes a favorite directory from its corresponding model index.
|
||||
|
||||
.. seealso:: :py:func:`addFavoriteDirectory`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
|
||||
@ -182,8 +182,6 @@ created menus is correctly handled by parenting them to the specified parent wid
|
||||
:param parent: a parent widget of the menu
|
||||
|
||||
:return: list of menus
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool acceptDrop() /Deprecated/;
|
||||
@ -218,8 +216,6 @@ accept dropped layers.
|
||||
Called when a user double clicks on the item. Subclasses should return ``True``
|
||||
if they have implemented a double-click handler and do not want the default
|
||||
double-click behavior for items.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool hasDragEnabled() const;
|
||||
@ -229,8 +225,6 @@ Default implementation returns ``False``.
|
||||
A draggable item has to implement :py:func:`~QgsDataItem.mimeUris` that will be used to pass data.
|
||||
|
||||
.. seealso:: :py:func:`mimeUris`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsMimeDataUtils::Uri mimeUri() const /Deprecated/;
|
||||
@ -242,8 +236,6 @@ Items that return valid URI will be returned in mime data when dragging a select
|
||||
|
||||
.. deprecated:: QGIS 3.18
|
||||
use :py:func:`~QgsDataItem.mimeUris` instead
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsMimeDataUtils::UriList mimeUris() const;
|
||||
@ -375,8 +367,6 @@ Alternatively subclasses can override this method to return a custom
|
||||
sort key.
|
||||
|
||||
.. seealso:: :py:func:`setSortKey`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setSortKey( const QVariant &key );
|
||||
@ -384,8 +374,6 @@ sort key.
|
||||
Sets a custom sorting ``key`` for the item.
|
||||
|
||||
.. seealso:: :py:func:`sortKey`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
@ -491,8 +479,6 @@ open browsers.
|
||||
void updateIcon();
|
||||
%Docstring
|
||||
Will request a repaint of this icon.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
||||
@ -69,8 +69,6 @@ population of directory items for the path will be avoided and it is left to the
|
||||
provider to correctly populate relevant entries for the path.
|
||||
|
||||
The default implementation returns ``False`` for all paths.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
};
|
||||
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsFavoritesItem : QgsDataCollectionItem
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Contains various Favorites directories
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -122,8 +122,6 @@ Set map settings and assign layer name attributes
|
||||
Sets the export flags.
|
||||
|
||||
.. seealso:: :py:func:`flags`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsDxfExport::Flags flags() const;
|
||||
@ -131,8 +129,6 @@ Sets the export flags.
|
||||
Returns the export flags.
|
||||
|
||||
.. seealso:: :py:func:`setFlags`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void addLayers( const QList< QgsDxfExport::DxfLayer > &layers );
|
||||
@ -159,8 +155,6 @@ Set reference ``scale`` for output.
|
||||
The ``scale`` value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
|
||||
|
||||
.. seealso:: :py:func:`symbologyScale`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double symbologyScale() const;
|
||||
@ -169,8 +163,6 @@ Returns the reference scale for output.
|
||||
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
|
||||
|
||||
.. seealso:: :py:func:`setSymbologyScale`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
Qgis::DistanceUnit mapUnits() const;
|
||||
@ -185,8 +177,6 @@ Retrieve map units
|
||||
Set destination CRS
|
||||
|
||||
.. seealso:: :py:func:`destinationCrs`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsCoordinateReferenceSystem destinationCrs() const;
|
||||
@ -194,8 +184,6 @@ Set destination CRS
|
||||
Returns the destination CRS, or an invalid CRS if no reprojection will be done.
|
||||
|
||||
.. seealso:: :py:func:`setDestinationCrs`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setSymbologyExport( Qgis::FeatureSymbologyExport e );
|
||||
|
||||
@ -141,8 +141,6 @@ Set the number of columns in this group.
|
||||
|
||||
%Docstring
|
||||
Creates a deep copy of this element. To be implemented by subclasses.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsOptionalExpression visibilityExpression() const;
|
||||
@ -150,8 +148,6 @@ Creates a deep copy of this element. To be implemented by subclasses.
|
||||
The visibility expression is used in the attribute form to
|
||||
show or hide this container based on an expression incorporating
|
||||
the field value controlled by editor widgets.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setVisibilityExpression( const QgsOptionalExpression &visibilityExpression );
|
||||
@ -159,8 +155,6 @@ the field value controlled by editor widgets.
|
||||
The visibility expression is used in the attribute form to
|
||||
show or hide this container based on an expression incorporating
|
||||
the field value controlled by editor widgets.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
|
||||
@ -96,8 +96,6 @@ The type of this element
|
||||
QgsAttributeEditorElement *parent() const;
|
||||
%Docstring
|
||||
Gets the parent of this element.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QDomElement toDomElement( QDomDocument &doc ) const;
|
||||
@ -112,8 +110,6 @@ Gets the XML Dom element to save this element.
|
||||
virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const = 0 /Factory/;
|
||||
%Docstring
|
||||
Returns a clone of this element. To be implemented by subclasses.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool showLabel() const;
|
||||
|
||||
@ -38,18 +38,8 @@ This element will load a relation editor onto the form.
|
||||
|
||||
|
||||
QgsAttributeEditorRelation( const QString &name, const QString &relationId, QgsAttributeEditorElement *parent );
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: QGIS 3.0.2.
|
||||
The name parameter is not used for anything and overwritten by the relationId internally.
|
||||
%End
|
||||
|
||||
QgsAttributeEditorRelation( const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent );
|
||||
%Docstring
|
||||
|
||||
.. deprecated:: QGIS 3.0.2.
|
||||
The name parameter is not used for anything and overwritten by the relationId internally.
|
||||
%End
|
||||
|
||||
QgsAttributeEditorRelation( const QString &relationId, QgsAttributeEditorElement *parent );
|
||||
%Docstring
|
||||
|
||||
@ -60,8 +60,6 @@ Constructor for TabData
|
||||
QgsEditFormConfig( const QgsEditFormConfig &o );
|
||||
%Docstring
|
||||
Copy constructor
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
~QgsEditFormConfig();
|
||||
|
||||
|
||||
@ -406,8 +406,6 @@ class QgsEffectPainter
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
A class to manager painter saving and restoring required for effect drawing
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -420,8 +418,6 @@ A class to manager painter saving and restoring required for effect drawing
|
||||
QgsEffectPainter constructor
|
||||
|
||||
:param renderContext: the :py:class:`QgsRenderContext` object
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsEffectPainter( QgsRenderContext &renderContext, QgsPaintEffect *effect );
|
||||
@ -430,8 +426,6 @@ QgsEffectPainter constructor alternative if no painter translation is needed
|
||||
|
||||
:param renderContext: the :py:class:`QgsRenderContext` object
|
||||
:param effect: the :py:class:`QgsPaintEffect` object
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
~QgsEffectPainter();
|
||||
|
||||
|
||||
@ -123,8 +123,6 @@ it does not need to be re-parsed.
|
||||
QgsExpression();
|
||||
%Docstring
|
||||
Create an empty expression.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
~QgsExpression();
|
||||
@ -135,8 +133,6 @@ Create an empty expression.
|
||||
%Docstring
|
||||
Checks if this expression is valid.
|
||||
A valid expression could be parsed but does not necessarily evaluate properly.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool hasParserError() const;
|
||||
@ -151,8 +147,6 @@ Returns parser error
|
||||
QList<QgsExpression::ParserError> parserErrors() const;
|
||||
%Docstring
|
||||
Returns parser error details including location of error.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QgsExpressionNode *rootNode() const;
|
||||
@ -204,8 +198,6 @@ which is determined at runtime.
|
||||
In contrast to the :py:func:`~QgsExpression.referencedColumns` function this method
|
||||
is not affected by any previous calls to :py:func:`QgsExpression.prepare()`,
|
||||
or :py:func:`QgsExpressionNode.prepare()`.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QSet<QString> referencedFunctions() const;
|
||||
@ -235,8 +227,6 @@ Returns a list of field name indexes obtained from the provided fields.
|
||||
pre-calculated nodes, regardless of their actual referenced columns.
|
||||
If you are seeking to use these functions to introspect an expression you must
|
||||
take care to do this with an unprepared expression.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool needsGeometry() const;
|
||||
@ -329,8 +319,6 @@ Tests whether a string is a valid expression.
|
||||
void setExpression( const QString &expression );
|
||||
%Docstring
|
||||
Set the expression string, will reset the whole internal structure.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QString expression() const;
|
||||
@ -636,8 +624,6 @@ Returns formatted help text for a variable.
|
||||
.. seealso:: :py:func:`helpText`
|
||||
|
||||
.. seealso:: :py:func:`variableHelpText`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QString group( const QString &group );
|
||||
@ -669,8 +655,6 @@ value. The value may be null.
|
||||
:param fieldType: the type of the field on the left side used to quote the value. If not given, the value type is used instead
|
||||
|
||||
:return: the expression to evaluate field equality
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static bool isFieldEqualityExpression( const QString &expression, QString &field /Out/, QVariant &value /Out/ );
|
||||
|
||||
@ -154,8 +154,6 @@ For instance, layer name, id and fields.
|
||||
static QList<QgsExpressionContextScope *> globalProjectLayerScopes( const QgsMapLayer *layer ) /Factory/;
|
||||
%Docstring
|
||||
Creates a list of three scopes: global, layer's project and layer.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static void setLayerVariable( QgsMapLayer *layer, const QString &name, const QVariant &value );
|
||||
@ -195,8 +193,6 @@ For instance, map scale and rotation.
|
||||
%Docstring
|
||||
Sets the expression context variables which are available for expressions triggered by
|
||||
a map tool capture like add feature.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QgsExpressionContextScope *mapLayerPositionScope( const QgsPointXY &position ) /Factory/;
|
||||
@ -221,8 +217,6 @@ Updates a symbol scope related to a :py:class:`QgsSymbol` to an expression conte
|
||||
%Docstring
|
||||
Creates a new scope which contains variables and functions relating to a :py:class:`QgsLayout` ``layout``.
|
||||
For instance, number of pages and page sizes.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static void setLayoutVariable( QgsLayout *layout, const QString &name, const QVariant &value );
|
||||
@ -237,8 +231,6 @@ Sets a layout context variable. This variable will be contained within scopes re
|
||||
.. seealso:: :py:func:`setLayoutVariables`
|
||||
|
||||
.. seealso:: :py:func:`layoutScope`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static void setLayoutVariables( QgsLayout *layout, const QVariantMap &variables );
|
||||
@ -252,8 +244,6 @@ with the variables specified.
|
||||
.. seealso:: :py:func:`setLayoutVariable`
|
||||
|
||||
.. seealso:: :py:func:`layoutScope`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QgsExpressionContextScope *atlasScope( const QgsLayoutAtlas *atlas ) /Factory/;
|
||||
@ -272,8 +262,6 @@ For instance, item size and position.
|
||||
.. seealso:: :py:func:`setLayoutItemVariable`
|
||||
|
||||
.. seealso:: :py:func:`setLayoutItemVariables`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static void setLayoutItemVariable( QgsLayoutItem *item, const QString &name, const QVariant &value );
|
||||
@ -285,8 +273,6 @@ This variable will be contained within scopes retrieved via
|
||||
.. seealso:: :py:func:`setLayoutItemVariables`
|
||||
|
||||
.. seealso:: :py:func:`layoutItemScope`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static void setLayoutItemVariables( QgsLayoutItem *item, const QVariantMap &variables );
|
||||
@ -297,8 +283,6 @@ with the ``variables`` specified.
|
||||
.. seealso:: :py:func:`setLayoutItemVariable`
|
||||
|
||||
.. seealso:: :py:func:`layoutItemScope`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QgsExpressionContextScope *multiFrameScope( const QgsLayoutMultiFrame *frame ) /Factory/;
|
||||
|
||||
@ -96,8 +96,6 @@ Constructor for function which uses unnamed parameters
|
||||
bool isContextual = false );
|
||||
%Docstring
|
||||
Constructor for function which uses unnamed parameters and group list
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsExpressionFunction( const QString &fnname,
|
||||
@ -120,8 +118,6 @@ Constructor for function which uses named parameter list.
|
||||
bool isContextual = false );
|
||||
%Docstring
|
||||
Constructor for function which uses named parameter list and group list.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual ~QgsExpressionFunction();
|
||||
@ -174,8 +170,6 @@ attributes and/or geometry.
|
||||
|
||||
By default this will return ``True``, if all arguments that have been passed to the function
|
||||
are also static.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool prepare( const QgsExpressionNodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context ) const;
|
||||
@ -184,8 +178,6 @@ This will be called during the prepare :py:func:`~QgsExpressionFunction.step` of
|
||||
|
||||
This can be used by functions to do any preparation steps that might help to speedup the upcoming
|
||||
evaluation.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QSet<QString> referencedColumns( const QgsExpressionNodeFunction *node ) const;
|
||||
@ -194,8 +186,6 @@ Returns a set of field names which are required for this function.
|
||||
May contain :py:class:`QgsFeatureRequest`.AllAttributes to signal that all
|
||||
attributes are required.
|
||||
If in doubt this will return more fields than strictly required.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool isContextual() const;
|
||||
@ -207,8 +197,6 @@ Returns whether the function is only available if provided by a :py:class:`QgsEx
|
||||
%Docstring
|
||||
Returns ``True`` if the function is deprecated and should not be presented as a valid option
|
||||
to users in expression builders.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QString group() const;
|
||||
@ -225,8 +213,6 @@ Returns the first group which the function belongs to.
|
||||
Returns a list of the groups the function belongs to.
|
||||
|
||||
.. seealso:: :py:func:`group`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QString helpText() const;
|
||||
@ -269,8 +255,6 @@ constraints imposed by the ``context`` within the given ``parent``.
|
||||
|
||||
This can be used as callback for custom implementations of subclasses. It is the default for implementation
|
||||
for StaticFunction.isStatic.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
||||
@ -132,8 +132,6 @@ Gets a list of all the nodes.
|
||||
QgsExpressionNode *at( int i );
|
||||
%Docstring
|
||||
Gets the node at position i in the list.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QStringList names() const;
|
||||
@ -243,8 +241,6 @@ Returns ``True`` if this node can be evaluated for a static value. This is used
|
||||
the :py:func:`~QgsExpressionNode.prepare` step and in case it returns ``True``, the value of this node will already
|
||||
be evaluated and the result cached (and therefore not re-evaluated in subsequent calls
|
||||
to :py:func:`~QgsExpressionNode.eval`). In case this returns ``True``, :py:func:`~QgsExpressionNode.prepareNode` will never be called.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool prepare( QgsExpression *parent, const QgsExpressionContext *context );
|
||||
|
||||
@ -14,8 +14,6 @@ Field formatter for a date time field.
|
||||
|
||||
This represents a date, time or datetime value based on
|
||||
the field configuration.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsFallbackFieldFormatter : QgsFieldFormatter
|
||||
A default fallback field formatter in case no specialized field formatter is defined.
|
||||
|
||||
The values will be returned unmodified.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -17,8 +17,6 @@ Values will be represented as a colon-delimited and
|
||||
comma-separated list.
|
||||
|
||||
E.g. "color: yellow, amount: 5"
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -14,8 +14,6 @@ Field formatter for a list field.
|
||||
|
||||
This represents a list type value.
|
||||
Values will be represented as a comma-separated list.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -11,8 +11,6 @@ class QgsRangeFieldFormatter : QgsFieldFormatter
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Field formatter for a range (double) field with precision and locale.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -14,8 +14,6 @@ Field formatter for a relation reference field.
|
||||
|
||||
A value relation field formatter looks up the values from
|
||||
features on another layer.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -23,8 +23,6 @@ configuration:
|
||||
|
||||
- 3 => "three"
|
||||
- 5 => "(5)"
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -16,8 +16,6 @@ Field formatter for a value relation field.
|
||||
|
||||
A value relation field formatter looks up the values from
|
||||
features on another layer.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -77,8 +75,6 @@ if doing multiple lookups in a loop.
|
||||
:param parentFormFeature: For embedded forms only, the feature currently being edited in the parent form with current attribute values
|
||||
|
||||
:return: A kvp list of values for the widget
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static bool expressionRequiresFormScope( const QString &expression );
|
||||
|
||||
@ -209,8 +209,6 @@ Returns the closure of the combinatorial boundary of the geometry (ie the topolo
|
||||
For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
|
||||
|
||||
:return: boundary for geometry. May be ``None`` for some geometry types.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void normalize() = 0;
|
||||
@ -271,8 +269,6 @@ The optional ``flags`` argument specifies flags controlling WKB export behavior
|
||||
.. seealso:: :py:func:`asGml3`
|
||||
|
||||
.. seealso:: :py:func:`asJson`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QString asWkt( int precision = 17 ) const = 0;
|
||||
@ -402,8 +398,6 @@ The vertex numbers start at 0, so a return value of 0 corresponds
|
||||
to the first vertex.
|
||||
|
||||
Returns -1 if a corresponding vertex could not be found.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool nextVertex( QgsVertexId &id, QgsPoint &vertex /Out/ ) const = 0;
|
||||
@ -420,8 +414,6 @@ Returns next vertex id and coordinates
|
||||
virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex /Out/, QgsVertexId &nextVertex /Out/ ) const = 0;
|
||||
%Docstring
|
||||
Returns the vertices adjacent to a specified ``vertex`` within a geometry.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsCoordinateSequence coordinateSequence() const = 0;
|
||||
@ -557,8 +549,6 @@ Returns the length of the segment of the geometry which begins at ``startVertex`
|
||||
|
||||
QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the lengths
|
||||
returned by this method are calculated using strictly Cartesian mathematics.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsPoint centroid() const;
|
||||
@ -658,8 +648,6 @@ a multipoint geometry with overlapping points will not be changed by this method
|
||||
|
||||
The function will return ``True`` if nodes were removed, or ``False`` if no duplicate nodes
|
||||
were found.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual double vertexAngle( QgsVertexId vertex ) const = 0;
|
||||
@ -870,8 +858,6 @@ Example
|
||||
|
||||
|
||||
.. seealso:: :py:func:`parts`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsAbstractGeometry *createEmptyWithSameType() const = 0 /Factory/;
|
||||
@ -915,8 +901,6 @@ Returns whether the geometry has any child geometries (``False`` for point / cur
|
||||
.. note::
|
||||
|
||||
used for vertex_iterator implementation
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual int childCount() const;
|
||||
@ -926,8 +910,6 @@ Returns number of child geometries (for geometries with child geometries) or chi
|
||||
.. note::
|
||||
|
||||
used for vertex_iterator implementation
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsAbstractGeometry *childGeometry( int index ) const;
|
||||
@ -937,8 +919,6 @@ Returns pointer to child geometry (for geometries with child geometries - i.e. g
|
||||
.. note::
|
||||
|
||||
used for vertex_iterator implementation
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsPoint childPoint( int index ) const;
|
||||
@ -948,8 +928,6 @@ Returns point at index (for geometries without child geometries - i.e. curve / p
|
||||
.. note::
|
||||
|
||||
used for vertex_iterator implementation
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
protected:
|
||||
@ -988,8 +966,6 @@ class QgsVertexIterator
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Java-style iterator for traversal of vertices of a geometry
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -26,8 +26,6 @@ extent of a geometry or collection of geometries.
|
||||
remains available in PyQGIS for compatibility.
|
||||
|
||||
.. seealso:: :py:class:`QgsRectangle`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -21,8 +21,6 @@ Circle geometry type.
|
||||
|
||||
A circle is defined by a center point with a radius and an azimuth.
|
||||
The azimuth is the north angle to the semi-major axis, in degrees. By default, the semi-major axis is oriented to the north (0 degrees).
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -29,8 +29,6 @@ Constructor for QgsCurve.
|
||||
virtual bool equals( const QgsCurve &other ) const = 0;
|
||||
%Docstring
|
||||
Checks whether this curve exactly equals another curve.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool operator==( const QgsAbstractGeometry &other ) const;
|
||||
|
||||
@ -183,8 +183,6 @@ parameter is specified then only rings smaller than this minimum
|
||||
area will be removed.
|
||||
|
||||
.. seealso:: :py:func:`removeInteriorRing`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void removeInvalidRings();
|
||||
@ -192,8 +190,6 @@ area will be removed.
|
||||
Removes any interior rings which are not valid from the polygon.
|
||||
|
||||
For example, this removes unclosed rings and rings with less than 4 vertices.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void forceRHR();
|
||||
|
||||
@ -18,8 +18,6 @@ Ellipse geometry type.
|
||||
An ellipse is defined by a center point with a semi-major axis, a semi-minor axis and an azimuth.
|
||||
The azimuth is the north angle to the first quadrant (always oriented on the semi-major axis), in degrees. By default, the semi-major axis is oriented to the east (90 degrees).
|
||||
The semi-minor axis is always smaller than the semi-major axis. If it is set larger, it will be swapped and the azimuth will increase by 90 degrees.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -93,8 +93,6 @@ Calculate the intersection of this and ``geom``.
|
||||
:param geom: geometry to perform the operation
|
||||
:param errorMsg: Error message returned by GEOS
|
||||
:param parameters: can be used to specify parameters which control the intersection results (since QGIS 3.28)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsAbstractGeometry *difference( const QgsAbstractGeometry *geom, QString *errorMsg = 0, const QgsGeometryParameters ¶meters = QgsGeometryParameters() ) const = 0 /Factory/;
|
||||
@ -104,8 +102,6 @@ Calculate the difference of this and ``geom``.
|
||||
:param geom: geometry to perform the operation
|
||||
:param errorMsg: Error message returned by GEOS
|
||||
:param parameters: can be used to specify parameters which control the difference results (since QGIS 3.28)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsAbstractGeometry *combine( const QgsAbstractGeometry *geom, QString *errorMsg = 0, const QgsGeometryParameters ¶meters = QgsGeometryParameters() ) const = 0 /Factory/;
|
||||
@ -115,8 +111,6 @@ Calculate the combination of this and ``geom``.
|
||||
:param geom: geometry to perform the operation
|
||||
:param errorMsg: Error message returned by GEOS
|
||||
:param parameters: can be used to specify parameters which control the union results (since QGIS 3.28)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsAbstractGeometry *combine( const QVector<QgsAbstractGeometry *> &geomList, QString *errorMsg, const QgsGeometryParameters ¶meters = QgsGeometryParameters() ) const = 0 /Factory/;
|
||||
@ -126,8 +120,6 @@ Calculate the combination of this and ``geometries``.
|
||||
:param geomList: list of geometries to perform the operation
|
||||
:param errorMsg: Error message returned by GEOS
|
||||
:param parameters: can be used to specify parameters which control the combination results (since QGIS 3.28)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsAbstractGeometry *combine( const QVector< QgsGeometry > &geometries, QString *errorMsg = 0, const QgsGeometryParameters ¶meters = QgsGeometryParameters() ) const = 0 /Factory/;
|
||||
@ -137,8 +129,6 @@ Calculate the combination of this and ``geometries``.
|
||||
:param geometries: list of geometries to perform the operation
|
||||
:param errorMsg: Error message returned by GEOS
|
||||
:param parameters: can be used to specify parameters which control the combination results (since QGIS 3.28)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsAbstractGeometry *symDifference( const QgsAbstractGeometry *geom, QString *errorMsg = 0, const QgsGeometryParameters ¶meters = QgsGeometryParameters() ) const = 0 /Factory/;
|
||||
@ -148,8 +138,6 @@ Calculate the symmetric difference of this and ``geom``.
|
||||
:param geom: geometry to perform the operation
|
||||
:param errorMsg: Error message returned by GEOS
|
||||
:param parameters: can be used to specify parameters which control the difference results (since QGIS 3.28)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
virtual QgsAbstractGeometry *buffer( double distance, int segments, QString *errorMsg = 0 ) const = 0 /Factory/;
|
||||
|
||||
@ -165,16 +153,12 @@ Buffers a geometry.
|
||||
%Docstring
|
||||
Calculates the centroid of this.
|
||||
May return a ```None```.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsPoint *pointOnSurface( QString *errorMsg = 0 ) const = 0 /Factory/;
|
||||
%Docstring
|
||||
Calculate a point that is guaranteed to be on the surface of this.
|
||||
May return a ```None```.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsAbstractGeometry *convexHull( QString *errorMsg = 0 ) const = 0 /Factory/;
|
||||
@ -185,8 +169,6 @@ Calculate the convex hull of this.
|
||||
virtual double distance( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Calculates the distance between this and ``geom``.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool distanceWithin( const QgsAbstractGeometry *geom, double maxdistance, QString *errorMsg = 0 ) const = 0;
|
||||
@ -199,50 +181,36 @@ Checks if ``geom`` is within ``maxdistance`` distance from this geometry
|
||||
virtual bool intersects( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Checks if ``geom`` intersects this.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool touches( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Checks if ``geom`` touches this.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool crosses( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Checks if ``geom`` crosses this.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool within( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Checks if ``geom`` is within this.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool overlaps( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Checks if ``geom`` overlaps this.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool contains( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Checks if ``geom`` contains this.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool disjoint( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Checks if ``geom`` is disjoint from this.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QString relate( const QgsAbstractGeometry *geom, QString *errorMsg = 0 ) const = 0;
|
||||
@ -288,16 +256,12 @@ If ``errorLoc`` is specified, it will be set to the geometry of the error locati
|
||||
%Docstring
|
||||
Checks if this is equal to ``geom``.
|
||||
If both are Null geometries, ```False``` is returned.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
virtual bool isEmpty( QString *errorMsg ) const = 0;
|
||||
|
||||
virtual bool isSimple( QString *errorMsg = 0 ) const = 0;
|
||||
%Docstring
|
||||
Determines whether the geometry is simple (according to OGC definition).
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual QgsGeometryEngine::EngineOperationResult splitGeometry( const QgsLineString &splitLine,
|
||||
|
||||
@ -69,8 +69,6 @@ Retrieves the vertices which are before and after the interpolated point at a sp
|
||||
.. note::
|
||||
|
||||
if the distance coincides exactly with a vertex, then both previousVertex and nextVertex will be set to this vertex
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static double distToInfiniteLine( const QgsPoint &point, const QgsPoint &linePoint1, const QgsPoint &linePoint2, double epsilon = 1e-7 );
|
||||
@ -311,8 +309,6 @@ Example
|
||||
# pr is a 3D point: 'PointM (3 4 1)'
|
||||
pr = midpoint ( p, QgsPoint( QgsWkbTypes.PointZM, 2, 2, 2, 2 ) )
|
||||
# pr is a 3D point: 'PointZM (3 4 1 1)'
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QgsPointXY interpolatePointOnLine( double x1, double y1, double x2, double y2, double fraction ) /HoldGIL/;
|
||||
@ -327,8 +323,6 @@ use a ``fraction`` < 0 or > 1, in which case the returned point
|
||||
is extrapolated from the supplied line.
|
||||
|
||||
.. seealso:: :py:func:`interpolatePointOnLineByValue`
|
||||
|
||||
.. versionadded:: 3.0.2
|
||||
%End
|
||||
|
||||
static QgsPoint interpolatePointOnLine( const QgsPoint &p1, const QgsPoint &p2, double fraction ) /HoldGIL/;
|
||||
@ -346,8 +340,6 @@ Any Z or M values present in the input points will also be interpolated
|
||||
and present in the returned point.
|
||||
|
||||
.. seealso:: :py:func:`interpolatePointOnLineByValue`
|
||||
|
||||
.. versionadded:: 3.0.2
|
||||
%End
|
||||
|
||||
static QgsPointXY interpolatePointOnLineByValue( double x1, double y1, double v1, double x2, double y2, double v2, double value ) /HoldGIL/;
|
||||
@ -361,8 +353,6 @@ point will be linearly interpolated to match position corresponding to
|
||||
the target ``value``.
|
||||
|
||||
.. seealso:: :py:func:`interpolatePointOnLine`
|
||||
|
||||
.. versionadded:: 3.0.2
|
||||
%End
|
||||
|
||||
static double gradient( const QgsPoint &pt1, const QgsPoint &pt2 ) /HoldGIL/;
|
||||
@ -373,8 +363,6 @@ Returns the gradient of a line defined by points ``pt1`` and ``pt2``.
|
||||
:param pt2: second point.
|
||||
|
||||
:return: The gradient of this linear entity, or infinity if vertical
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static void coefficients( const QgsPoint &pt1, const QgsPoint &pt2,
|
||||
@ -384,12 +372,6 @@ Returns the coefficients (a, b, c for equation "ax + by + c = 0") of a line defi
|
||||
|
||||
:param pt1: first point.
|
||||
:param pt2: second point.
|
||||
|
||||
:return: - a: Output parameter, a coefficient of the equation.
|
||||
- b: Output parameter, b coefficient of the equation.
|
||||
- c: Output parameter, c coefficient of the equation.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QgsLineString perpendicularSegment( const QgsPoint &p, const QgsPoint &s1, const QgsPoint &s2 ) /HoldGIL/;
|
||||
@ -421,8 +403,6 @@ already contains a Z value.
|
||||
points whose z value is closest to the original x/y point, but only the first one found.
|
||||
|
||||
|
||||
.. versionadded:: 3.0
|
||||
|
||||
.. deprecated:: QGIS 3.20
|
||||
use transferFirstZValueToPoint( const :py:class:`QgsPointSequence` &points, :py:class:`QgsPoint` &point ) instead
|
||||
%End
|
||||
|
||||
@ -236,8 +236,6 @@ LineString will be LineStringZ (or LineStringZM) type.
|
||||
|
||||
If the sizes of ``x`` and ``y`` are non-equal then the resultant linestring
|
||||
will be created using the minimum size of these arrays.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsLineString( const QgsPoint &p1, const QgsPoint &p2 ) /HoldGIL/;
|
||||
@ -580,8 +578,6 @@ Returns the geometry converted to the more generic curve type :py:class:`QgsComp
|
||||
Extends the line geometry by extrapolating out the start or end of the line
|
||||
by a specified distance. Lines are extended using the bearing of the first or last
|
||||
segment in the line.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
|
||||
@ -224,8 +224,6 @@ cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distance
|
||||
when comparing distances.
|
||||
|
||||
.. seealso:: :py:func:`distanceSquared`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double distance( const QgsPoint &other ) const /HoldGIL/;
|
||||
@ -235,8 +233,6 @@ cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distance
|
||||
when comparing distances.
|
||||
|
||||
.. seealso:: :py:func:`distanceSquared`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double distanceSquared( double x, double y ) const /HoldGIL/;
|
||||
@ -246,8 +242,6 @@ this is faster than calling :py:func:`~QgsPoint.distance`, and may be useful in
|
||||
distances where the extra expense of calling :py:func:`~QgsPoint.distance` is not required.
|
||||
|
||||
.. seealso:: :py:func:`distance`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double distanceSquared( const QgsPoint &other ) const /HoldGIL/;
|
||||
@ -257,8 +251,6 @@ this is faster than calling :py:func:`~QgsPoint.distance`, and may be useful in
|
||||
distances where the extra expense of calling :py:func:`~QgsPoint.distance` is not required.
|
||||
|
||||
.. seealso:: :py:func:`distance`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double distance3D( double x, double y, double z ) const /HoldGIL/;
|
||||
@ -268,8 +260,6 @@ cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distance
|
||||
when comparing distances.
|
||||
|
||||
.. seealso:: :py:func:`distanceSquared3D`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double distance3D( const QgsPoint &other ) const /HoldGIL/;
|
||||
@ -279,8 +269,6 @@ cases it may be more appropriate to call the faster :py:func:`~QgsPoint.distance
|
||||
when comparing distances.
|
||||
|
||||
.. seealso:: :py:func:`distanceSquared3D`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double distanceSquared3D( double x, double y, double z ) const /HoldGIL/;
|
||||
@ -290,8 +278,6 @@ this is faster than calling :py:func:`~QgsPoint.distance3D`, and may be useful i
|
||||
distances where the extra expense of calling :py:func:`~QgsPoint.distance3D` is not required.
|
||||
|
||||
.. seealso:: :py:func:`distance3D`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double distanceSquared3D( const QgsPoint &other ) const /HoldGIL/;
|
||||
@ -301,23 +287,17 @@ this is faster than calling :py:func:`~QgsPoint.distance3D`, and may be useful i
|
||||
distances where the extra expense of calling :py:func:`~QgsPoint.distance3D` is not required.
|
||||
|
||||
.. seealso:: :py:func:`distance3D`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double azimuth( const QgsPoint &other ) const /HoldGIL/;
|
||||
%Docstring
|
||||
Calculates Cartesian azimuth between this point and other one (clockwise in degree, starting from north)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double inclination( const QgsPoint &other ) const /HoldGIL/;
|
||||
%Docstring
|
||||
Calculates Cartesian inclination between this point and other one (starting from zenith = 0 to nadir = 180. Horizon = 90)
|
||||
Returns 90.0 if the distance between this point and other one is equal to 0 (same point).
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsPoint project( double distance, double azimuth, double inclination = 90.0 ) const /HoldGIL/;
|
||||
@ -352,8 +332,6 @@ Example
|
||||
# pr is a 3D point: 'PointZ (1 3 2)'
|
||||
pr = p.project (1, 0, 0 )
|
||||
# pr is a 3D point: 'PointZ (1 2 3)'
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsVector operator-( const QgsPoint &p ) const /HoldGIL/;
|
||||
|
||||
@ -74,8 +74,6 @@ Returns the geometry converted to the more generic curve type :py:class:`QgsCurv
|
||||
Returns the distance from a point to the boundary of the polygon (either the
|
||||
exterior ring or any closer interior rings). The returned distance will be
|
||||
negative if the point lies outside the polygon.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
|
||||
@ -63,16 +63,12 @@ Copy constructor
|
||||
%Docstring
|
||||
Creates a new rectangle from a ``wkt`` string.
|
||||
The WKT must contain only 5 vertices, representing a rectangle aligned with X and Y axes.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QgsRectangle fromCenterAndSize( const QgsPointXY ¢er, double width, double height );
|
||||
%Docstring
|
||||
Creates a new rectangle, given the specified ``center`` point
|
||||
and ``width`` and ``height``.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void set( const QgsPointXY &p1, const QgsPointXY &p2, bool normalize = true );
|
||||
@ -185,8 +181,6 @@ Returns the area of the rectangle.
|
||||
.. seealso:: :py:func:`height`
|
||||
|
||||
.. seealso:: :py:func:`perimeter`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double perimeter() const /HoldGIL/;
|
||||
@ -194,8 +188,6 @@ Returns the area of the rectangle.
|
||||
Returns the perimeter of the rectangle.
|
||||
|
||||
.. seealso:: :py:func:`area`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsPointXY center() const /HoldGIL/;
|
||||
@ -241,8 +233,6 @@ Gets rectangle enlarged by buffer.
|
||||
In earlier QGIS releases this method was named :py:func:`~QgsRectangle.buffer`.
|
||||
|
||||
.. seealso:: :py:func:`grow`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsRectangle intersect( const QgsRectangle &rect ) const;
|
||||
@ -371,8 +361,6 @@ Swap x/y coordinates in the rectangle.
|
||||
%Docstring
|
||||
Converts the rectangle to a 3D box, with the specified
|
||||
``zMin`` and ``zMax`` z values.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
operator QVariant() const;
|
||||
|
||||
@ -19,8 +19,6 @@ A base class for geometry primitives which are stored with an associated referen
|
||||
associated with them.
|
||||
|
||||
.. seealso:: :py:class:`QgsReferencedRectangle`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -55,8 +53,6 @@ class QgsReferencedRectangle : QgsRectangle, QgsReferencedGeometryBase
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
A :py:class:`QgsRectangle` with associated coordinate reference system.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -93,8 +89,6 @@ class QgsReferencedPointXY : QgsPointXY, QgsReferencedGeometryBase
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
A :py:class:`QgsPointXY` with associated coordinate reference system.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -18,8 +18,6 @@ Regular Polygon geometry type.
|
||||
|
||||
A regular polygon is a polygon that is equiangular (all angles are equal in measure) and equilateral (all sides have the same length).
|
||||
The regular polygon is defined by a center point with a number of sides/vertices, a radius and the first vertex.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsTriangle : QgsPolygon
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Triangle geometry type.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -212,8 +212,6 @@ This will return one of the following strings:
|
||||
- Unknown Geometry
|
||||
- No Geometry
|
||||
- Invalid Geometry
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static bool hasZ( Qgis::WkbType type ) /HoldGIL/;
|
||||
|
||||
@ -12,8 +12,6 @@ class QgsLabelingEngineSettings
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Stores global configuration for labeling engine
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -217,8 +217,6 @@ such as blend modes, which require output in raster formats to be fully respecte
|
||||
static const QgsPropertiesDefinition &propertyDefinitions();
|
||||
%Docstring
|
||||
Returns the labeling property definitions.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool drawLabels;
|
||||
@ -412,8 +410,6 @@ Write settings into a DOM element
|
||||
Returns a reference to the label's property collection, used for data defined overrides.
|
||||
|
||||
.. seealso:: :py:func:`setDataDefinedProperties`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
@ -426,8 +422,6 @@ Sets the label's property collection, used for data defined overrides.
|
||||
.. seealso:: :py:func:`dataDefinedProperties`
|
||||
|
||||
.. seealso:: Property
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
const QgsTextFormat &format() const;
|
||||
@ -435,8 +429,6 @@ Sets the label's property collection, used for data defined overrides.
|
||||
Returns the label text formatting settings, e.g., font settings, buffer settings, etc.
|
||||
|
||||
.. seealso:: :py:func:`setFormat`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setFormat( const QgsTextFormat &format );
|
||||
@ -446,8 +438,6 @@ Sets the label text formatting settings, e.g., font settings, buffer settings, e
|
||||
:param format: label text format
|
||||
|
||||
.. seealso:: :py:func:`format`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsCallout *callout() const;
|
||||
|
||||
@ -14,8 +14,6 @@ class QgsRuleBasedLabeling : QgsAbstractVectorLayerLabeling
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Rule based labeling for a vector layer.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -29,8 +27,6 @@ Rule based labeling for a vector layer.
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
A child rule for QgsRuleBasedLabeling.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -72,8 +68,6 @@ A scale of 0 indicates no maximum scale visibility.
|
||||
.. seealso:: :py:func:`minimumScale`
|
||||
|
||||
.. seealso:: :py:func:`setMaximumScale`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
double minimumScale() const;
|
||||
@ -85,8 +79,6 @@ A scale of 0 indicates no minimum scale visibility.
|
||||
.. seealso:: :py:func:`maximumScale`
|
||||
|
||||
.. seealso:: :py:func:`setMinimumScale`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QString filterExpression() const;
|
||||
@ -310,8 +302,6 @@ Set pal settings for a specific provider (takes ownership).
|
||||
|
||||
:param settings: Pal layer settings
|
||||
:param providerId: The id of the provider
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
virtual bool requiresAdvancedEffects() const;
|
||||
|
||||
|
||||
@ -15,8 +15,6 @@ class QgsAbstractVectorLayerLabeling
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Abstract base class - its implementations define different approaches to the labeling of a vector layer.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -71,8 +69,6 @@ Set pal settings for a specific provider (takes ownership).
|
||||
|
||||
:param settings: Pal layer settings
|
||||
:param providerId: The id of the provider
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool requiresAdvancedEffects() const = 0;
|
||||
@ -80,8 +76,6 @@ Set pal settings for a specific provider (takes ownership).
|
||||
Returns ``True`` if drawing labels requires advanced effects like composition
|
||||
modes, which could prevent it being used as an isolated cached image
|
||||
or exported to a vector format.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void multiplyOpacity( double opacityFactor );
|
||||
@ -144,8 +138,6 @@ class QgsVectorLayerSimpleLabeling : QgsAbstractVectorLayerLabeling
|
||||
Basic implementation of the labeling interface.
|
||||
|
||||
The configuration is kept in layer's custom properties for backward compatibility.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -175,8 +167,6 @@ Set pal settings (takes ownership).
|
||||
|
||||
:param settings: Pal layer settings
|
||||
:param providerId: Unused parameter
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual bool requiresAdvancedEffects() const;
|
||||
|
||||
@ -15,8 +15,6 @@ Namespace with helper functions for layer tree operations.
|
||||
|
||||
Only generally useful routines should be here. Miscellaneous utility functions for work
|
||||
with the layer tree are in :py:class:`QgsLayerTreeUtils` class.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -60,8 +58,6 @@ If you need the current layer order that is active, prefer using :py:func:`~QgsL
|
||||
.. seealso:: :py:func:`layerOrder`
|
||||
|
||||
.. seealso:: :py:func:`hasCustomLayerOrder`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setCustomLayerOrder( const QList<QgsMapLayer *> &customLayerOrder );
|
||||
@ -75,8 +71,6 @@ If you need the current layer order that is active, prefer using :py:func:`~QgsL
|
||||
.. seealso:: :py:func:`layerOrder`
|
||||
|
||||
.. seealso:: :py:func:`hasCustomLayerOrder`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setCustomLayerOrder( const QStringList &customLayerOrder ) /PyName=setCustomLayerOrderByIds/;
|
||||
@ -90,8 +84,6 @@ If you need the current layer order that is active, prefer using :py:func:`~QgsL
|
||||
.. seealso:: :py:func:`layerOrder`
|
||||
|
||||
.. seealso:: :py:func:`hasCustomLayerOrder`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QList<QgsMapLayer *> layerOrder() const;
|
||||
@ -102,8 +94,6 @@ customLayerOrder or the layer order derived from the tree.
|
||||
This property is read only.
|
||||
|
||||
.. seealso:: :py:func:`customLayerOrder`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool hasCustomLayerOrder() const;
|
||||
@ -112,8 +102,6 @@ Determines if the layer order should be derived from the layer tree
|
||||
or if a custom override order shall be used instead.
|
||||
|
||||
.. seealso:: :py:func:`customLayerOrder`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setHasCustomLayerOrder( bool hasCustomLayerOrder );
|
||||
@ -122,8 +110,6 @@ Determines if the layer order should be derived from the layer tree
|
||||
or if a custom override order shall be used instead.
|
||||
|
||||
.. seealso:: :py:func:`setCustomLayerOrder`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QgsLayerTree *readXml( QDomElement &element, const QgsReadWriteContext &context );
|
||||
@ -132,16 +118,12 @@ Load the layer tree from an XML element.
|
||||
It is not required that layers are loaded at this point.
|
||||
:py:func:`~QgsLayerTree.resolveReferences` needs to be called after loading the layers and
|
||||
before using the tree.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void readLayerOrderFromXml( const QDomElement &doc );
|
||||
%Docstring
|
||||
Load the layer order from an XML element.
|
||||
Make sure that this is only called after the layers are loaded.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context );
|
||||
@ -153,8 +135,6 @@ Make sure that this is only called after the layers are loaded.
|
||||
void clear();
|
||||
%Docstring
|
||||
Clear any information from this layer tree.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
signals:
|
||||
@ -162,15 +142,11 @@ Clear any information from this layer tree.
|
||||
void customLayerOrderChanged();
|
||||
%Docstring
|
||||
Emitted when the custom layer order has changed.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void layerOrderChanged();
|
||||
%Docstring
|
||||
Emitted when the layer order has changed.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void hasCustomLayerOrderChanged( bool hasCustomLayerOrder );
|
||||
@ -178,8 +154,6 @@ Emitted when the layer order has changed.
|
||||
Emitted when the hasCustomLayerOrder flag changes.
|
||||
|
||||
.. seealso:: :py:func:`hasCustomLayerOrder`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
||||
@ -112,8 +112,6 @@ Remove all child nodes. The nodes will be deleted.
|
||||
QgsLayerTreeLayer *findLayer( QgsMapLayer *layer ) const;
|
||||
%Docstring
|
||||
Find layer node representing the map layer. Searches recursively the whole sub-tree.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsLayerTreeLayer *findLayer( const QString &layerId ) const;
|
||||
@ -171,8 +169,6 @@ Does not resolve textual references to layers. Call :py:func:`~QgsLayerTreeGroup
|
||||
%Docstring
|
||||
Read group (tree) from XML element <layer-tree-group> and return the newly created group (or ``None`` on error).
|
||||
Also resolves textual references to layers from the project (calls :py:func:`~QgsLayerTreeGroup.resolveReferences` internally).
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context );
|
||||
@ -203,8 +199,6 @@ Returns a clone of the group. The children are cloned too.
|
||||
|
||||
%Docstring
|
||||
Calls :py:func:`~QgsLayerTreeGroup.resolveReferences` on child tree nodes
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void setItemVisibilityCheckedRecursive( bool checked );
|
||||
|
||||
@ -68,8 +68,6 @@ Returns the map layer associated with this node.
|
||||
Returns the layer's name.
|
||||
|
||||
.. seealso:: :py:func:`setName`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void setName( const QString &n );
|
||||
@ -78,8 +76,6 @@ Returns the layer's name.
|
||||
Sets the layer's name.
|
||||
|
||||
.. seealso:: :py:func:`name`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setUseLayerName( bool use = true );
|
||||
@ -107,8 +103,6 @@ Does not resolve textual references to layers. Call :py:func:`~QgsLayerTreeLayer
|
||||
%Docstring
|
||||
Read layer node from XML. Returns new instance.
|
||||
Also resolves textual references to layers from the project (calls :py:func:`~QgsLayerTreeLayer.resolveReferences` internally).
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context );
|
||||
@ -124,8 +118,6 @@ Also resolves textual references to layers from the project (calls :py:func:`~Qg
|
||||
|
||||
%Docstring
|
||||
Resolves reference to layer from stored layer ID (if it has not been resolved already)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setLabelExpression( const QString &expression );
|
||||
|
||||
@ -398,8 +398,6 @@ Emitted when a hit test for visible legend items completes.
|
||||
void nodeNameChanged( QgsLayerTreeNode *node, const QString &name );
|
||||
%Docstring
|
||||
Updates model when node's name has changed
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void nodeCustomPropertyChanged( QgsLayerTreeNode *node, const QString &key );
|
||||
|
||||
@ -664,8 +664,6 @@ class QgsDataDefinedSizeLegendNode : QgsLayerTreeModelLegendNode
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Produces legend node with a marker symbol
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -111,15 +111,11 @@ Gets list of children of the node. Children are owned by the parent
|
||||
virtual QString name() const = 0;
|
||||
%Docstring
|
||||
Returns name of the node
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void setName( const QString &name ) = 0;
|
||||
%Docstring
|
||||
Set name of the node. Emits nameChanged signal.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
static QgsLayerTreeNode *readXml( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
|
||||
@ -132,8 +128,6 @@ Does not resolve textual references to layers. Call :py:func:`~QgsLayerTreeNode.
|
||||
%Docstring
|
||||
Read layer tree from XML. Returns new instance.
|
||||
Also resolves textual references to layers from the project (calls :py:func:`~QgsLayerTreeNode.resolveReferences` internally).
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) = 0;
|
||||
@ -159,22 +153,16 @@ If ``looseMatching`` is ``True`` then a looser match will be used, where a layer
|
||||
will match if the name, public source, and data provider match. This can be
|
||||
used to match legend customization from different projects where layers
|
||||
will have different layer IDs.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool isVisible() const;
|
||||
%Docstring
|
||||
Returns whether a node is really visible (ie checked and all its ancestors checked as well)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool itemVisibilityChecked() const;
|
||||
%Docstring
|
||||
Returns whether a node is checked (independently of its ancestors or children)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setItemVisibilityChecked( bool checked );
|
||||
@ -182,44 +170,32 @@ Returns whether a node is checked (independently of its ancestors or children)
|
||||
Check or uncheck a node (independently of its ancestors or children)
|
||||
|
||||
.. seealso:: :py:func:`QgsLayerTreeView.setLayerVisible`
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
virtual void setItemVisibilityCheckedRecursive( bool checked );
|
||||
%Docstring
|
||||
Check or uncheck a node and all its children (taking into account exclusion rules)
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setItemVisibilityCheckedParentRecursive( bool checked );
|
||||
%Docstring
|
||||
Check or uncheck a node and all its parents
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool isItemVisibilityCheckedRecursive() const;
|
||||
%Docstring
|
||||
Returns whether this node is checked and all its children.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool isItemVisibilityUncheckedRecursive() const;
|
||||
%Docstring
|
||||
Returns whether this node is unchecked and all its children.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QList< QgsMapLayer * > checkedLayers() const;
|
||||
%Docstring
|
||||
Returns a list of any checked layers which belong to this node or its
|
||||
children.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
int depth() const;
|
||||
@ -293,8 +269,6 @@ Emitted when the collapsed/expanded state of a node within the tree has been cha
|
||||
void nameChanged( QgsLayerTreeNode *node, QString name );
|
||||
%Docstring
|
||||
Emitted when the name of the node is changed
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
protected:
|
||||
|
||||
@ -12,8 +12,6 @@ class QgsAbstractLayoutIterator
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
An abstract base class for :py:class:`QgsLayout` based classes which can be exported by :py:class:`QgsLayoutExporter`.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -19,8 +19,6 @@ Current context for a report section.
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings for unit testing purposes only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -44,8 +42,6 @@ An abstract base class for :py:class:`QgsReport` subsections.
|
||||
|
||||
This is not considered stable API, and may change in future QGIS releases. It is
|
||||
exposed to the Python bindings for unit testing purposes only.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -18,8 +18,6 @@ to a QPainter, it is recommended to instead use a :py:class:`QgsLayoutExporter`
|
||||
layouts instead. :py:class:`QgsLayoutExporter` automatically takes care of the intracacies of
|
||||
preparing the layout and paint devices for correct exports, respecting various
|
||||
user settings such as the layout context DPI.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -15,8 +15,6 @@ Handles aligning and distributing sets of layout items.
|
||||
|
||||
:py:class:`QgsLayoutAligner` contains methods for automatically aligning and distributing
|
||||
sets of layout items, e.g. aligning a group of items to top or left sides.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -19,8 +19,6 @@ directly with :py:class:`QgsLayoutExporter` to automatically output all pages fr
|
||||
For :py:class:`QgsPrintLayout` layouts, it is not necessary to manually construct a
|
||||
:py:class:`QgsLayoutAtlas` object. Instead, the atlas attached to the print layout
|
||||
should be used. This can be retrieved by calling :py:func:`QgsPrintLayout.atlas()`.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -14,8 +14,6 @@ class QgsLayoutExporter
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Handles rendering and exports of layouts to various formats.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
@ -13,8 +13,6 @@ class QgsLayoutFrame: QgsLayoutItem
|
||||
{
|
||||
%Docstring(signature="appended")
|
||||
Base class for frame items, which form a layout multiframe item.
|
||||
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
||||
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