:param x: x-coordinate (in map units)

:param y: y-coordinate (in map units)

:param feedback: optional feedback object for progress and cancelation support

:return: 0 in case of success*

%End

:param text: string to test

:param context: optional expression context

:return: true if string is a valid expression

.. versionadded:: 2.12

%End

:param id: initial value should be the starting vertex id. The next vertex id will be stored

in this variable if found.

:return: false if at end

%End

virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex /Out/, QgsVertexId &nextVertex /Out/ ) const = 0;

:param pt: specifies the point to find closest segment to

:param segmentPt: storage for the closest point within the geometry

:param vertexAfter: storage for the ID of the vertex at the end of the closest segment

of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not

be determined, e.g. point exactly on a line)

false if point is to right of segment)

:param epsilon: epsilon for segment snapping

:return: squared distance to closest segment or negative value on error

%End

Returns the point and vertex id of a point within the curve.

:param node: node number, where the first node is 0

:param type: will be set to the vertex type of the node

:return: true if node exists within the curve

%End

virtual QgsCurve *reversed() const = 0 /Factory/;

Searches for the closest vertex in this geometry to the given point.

:param point: Specifiest the point for search

:return: The squared Cartesian distance is also returned in sqrDist, negative number on error

%End

double closestSegmentWithContext( const QgsPointXY &point, QgsPointXY &minDistPoint /Out/, int &afterVertex /Out/, int *leftOf /Out/ = 0, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;

%Docstring

Searches for the closest segment of geometry to the given point

:param point: Specifies the point for search

:param afterVertex: Receives index of the vertex after the closest segment. The vertex

before the closest segment is always afterVertex - 1

:param leftOf: Out: Returns if the point lies on the left of left side of the geometry ( < 0 means left, > 0 means right, 0 indicates

that the test was unsuccessful, e.g. for a point exactly on the line)

:param epsilon: epsilon for segment snapping

:return: The squared Cartesian distance is also returned in sqrDist, negative number on error

%End

OperationResult addRing( const QVector<QgsPointXY> &ring );

%Docstring

Returns the minimal enclosing circle for the geometry.

:param radius: Radius of the minimal enclosing circle returned

:param segments: Number of segments used to segment geometry. :py:func:`QgsEllipse.toPolygon`

3 other error during intersection removal

:param avoidIntersectionsLayers: list of layers to check for intersections

.. versionadded:: 1.5

%End

:param geometry: line or polygon geometry

:param distance: distance to traverse along geometry

:param previousVertex: will be set to previous vertex ID

:return: true if vertices were successfully retrieved

.. note::

:param v1: Direction vector of the first line

:param p2: Point on the second line

:param v2: Direction vector of the second line

:return: Whether the lines intersect

%End

static bool segmentIntersection( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &q1, const QgsPoint &q2, QgsPoint &intersectionPoint /Out/, bool &isIntersection /Out/, double tolerance = 1e-8, bool acceptImproperIntersection = false );

:param p2: First segment end point

:param q1: Second segment start point

:param q2: Second segment end point

:param isIntersection: Output parameter, return true if an intersection is found

:param tolerance: The tolerance to use

:param acceptImproperIntersection: By default, this method returns true only if segments have proper intersection. If set true, returns also true if segments have improper intersection (end of one segment on other segment ; continuous segments).

:return: Whether the segments intersect

* Example:

.. code-block:: python

:param pt1: first point.

:param pt2: second point.

:param b: Output parameter, b coefficient of the equation.

:param c: Output parameter, c coefficient of the equation.

:param La2: is the second point on the first line,

:param Lb1: is the first point on the second line,

:param Lb2: is the second point on the second line,

:return: true if the intersection can be found, false - otherwise.

example:

.. code-block:: python

:param p1: start point [can be Cartesian or Geographic]

:param distance: must be in meters

:param azimuth: - azimuth in radians, clockwise from North

:return: distance in mapUnits

.. seealso:: :py:func:`sourceCrs`

(either as a .qmd file on disk or as a

record in the users style table in their personal qgis.db)

we did not manage to save the default metadata.

:return: a QString with any status messages

.. versionadded:: 3.0

%End

is a file and load that, if that fails the qgis.db metadata

table will be consulted to see if there is a metadata who's

key matches the URI.

we did not manage to load the default metadata.

:return: a QString with any status messages

.. versionadded:: 3.0

%End

exists (either as a .qml file on disk or as a

record in the users style table in their personal qgis.db)

we did not manage to load the default style.

:return: a QString with any status messages

.. seealso:: :py:func:`also`

%End

is a file and load that, if that fails the qgis.db styles

table will be consulted to see if there is a style who's

key matches the URI.

we did not manage to load the default style.

:param categories: the style categories to be loaded.

:return: a QString with any status messages

.. seealso:: :py:func:`also`

%End

:param db: path to sqlite database

:param uri: uri for table

:return: true if style was successfully loaded

%End

virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg /Out/,

(either as a .qml file on disk or as a

record in the users style table in their personal qgis.db)

we did not manage to save the default style.

:return: a QString with any status messages

.. seealso:: :py:func:`loadNamedStyle`

%End

is a file and save to that, if that fails the qgis.db styles

table will be used to create a style entry who's

key matches the URI.

we did not manage to save the default style.

:param categories: the style categories to be saved.

:return: a QString with any status messages

.. seealso:: :py:func:`saveDefaultStyle`

%End

The layersAdded() and layerWasAdded() signals will always be emitted.

:param layers: A list of layer which should be added to the store.

If you specify false here you have take care of deleting

the layers yourself. Not available in Python.

addMapLayers() instead.

:param layer: A layer to add to the store

If you specify false here you have take care of deleting

the layers yourself. Not available in Python.

must have already had the feature and fields sets prior to calling this method.

:param labelFeature: if using :py:class:`QgsLabelingEngine`, this will receive the label feature. Not available

in Python bindings.

should be used as an obstacle for labels (e.g., if the feature has been rendered with an offset point

symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set,

the feature's original geometry will be used as an obstacle for labels. Not available

:param addToLegend: If true (by default), the layers will be added to the

legend and to the main canvas. If you have a private

layer you can set this parameter to false to hide it.

If you specify false here you have take care of deleting

the layers yourself. Not available in Python.

:param addToLegend: If true (by default), the layer will be added to the

legend and to the main canvas. If you have a private

layer you can set this parameter to false to hide it.

If you specify false here you have take care of deleting

the layer yourself. Not available in Python.

in the expression context can be used to alter the calculated value for the property, so that a property

is able to respond to the current environment, layers and features within QGIS.

:param defaultValue: default value to return if the property is not active or cannot be calculated

:return: calculated value for property

.. seealso:: :py:func:`valueAsString`

:param context: QgsExpressionContext to evaluate the property for.

:param defaultString: default string to return if the property cannot be calculated as a string

:return: value parsed to string

.. seealso:: :py:func:`value`

:param context: QgsExpressionContext to evaluate the property for.

:param defaultColor: default color to return if the property cannot be calculated as a color

:return: value parsed to color

.. seealso:: :py:func:`value`

:param context: QgsExpressionContext to evaluate the property for.

:param defaultValue: default double to return if the property cannot be calculated as a double

:return: value parsed to double

.. seealso:: :py:func:`value`

:param context: QgsExpressionContext to evaluate the property for.

:param defaultValue: default integer to return if the property cannot be calculated as an integer

:return: value parsed to integer

.. seealso:: :py:func:`value`

:param context: QgsExpressionContext to evaluate the property for.

:param defaultValue: default boolean to return if the property cannot be calculated as an boolean

:return: value parsed to boolean

.. seealso:: :py:func:`value`

int and used for the key value.

:param context: QgsExpressionContext to evaluate the property for.

:param defaultString: default string to return if the property cannot be calculated as a string

:return: value parsed to string

.. seealso:: :py:func:`value`

int and used for the key value.

:param context: QgsExpressionContext to evaluate the property for.

:param defaultColor: default color to return if the property cannot be calculated as a color

:return: value parsed to color

.. seealso:: :py:func:`value`

int and used for the key value.

:param context: QgsExpressionContext to evaluate the property for.

:param defaultValue: default double to return if the property cannot be calculated as a double

:return: value parsed to double

.. seealso:: :py:func:`value`

int and used for the key value.

:param context: QgsExpressionContext to evaluate the property for.

:param defaultValue: default integer to return if the property cannot be calculated as a integer

:return: value parsed to integer

.. seealso:: :py:func:`value`

int and used for the key value.

:param context: QgsExpressionContext to evaluate the property for.

:param defaultValue: default boolean to return if the property cannot be calculated as a boolean

:return: value parsed to bool

.. seealso:: :py:func:`value`

Attempts to parse an expression into a corresponding property transformer.

:param expression: expression to parse

is used to calculate the input to the property transformer. This will be set to an

empty string if a field reference is the transformer input.

:param fieldName: will be set to a field name which is used to calculate the input

to the property transformer. This will be set to an

empty string if an expression is the transformer input.

:return: corresponding property transformer, or None if expression could not

be parsed to a transformer.

%End

Attempts to parse an expression into a corresponding :py:class:`QgsSizeScaleTransformer`.

:param expression: expression to parse

is used to calculate the input to the property transformer. This will be set to an

empty string if a field reference is the transformer input.

:param fieldName: will be set to a field name which is used to calculate the input

to the property transformer. This will be set to an

empty string if an expression is the transformer input.

:return: corresponding :py:class:`QgsSizeScaleTransformer`, or None if expression could not

be parsed to a size scale transformer.

%End

Attempts to parse an expression into a corresponding QgsSizeScaleTransformer.

:param expression: expression to parse

is used to calculate the input to the property transformer. This will be set to an

empty string if a field reference is the transformer input.

:param fieldName: will be set to a field name which is used to calculate the input

to the property transformer. This will be set to an

empty string if an expression is the transformer input.

:return: corresponding QgsSizeScaleTransformer, or None if expression could not

be parsed to a size scale transformer.

%End

Execute the ``sql`` string.

:param sql: The sql query to execute

:param isDirty: Flag to indicate if the underlying data will be modified

:param name: Name of the transaction ( only used if `isDirty` is true)

:return: true if everything is OK, false otherwise

%End

static bool supportsTransaction( const QgsVectorLayer *layer );

Decodes a distance unit from a string.

:param string: string to decode

:return: decoded units

.. seealso:: :py:func:`encodeUnit`

%End

Converts a translated string to a distance unit.

:param string: string representing a distance unit

.. seealso:: :py:func:`toString`

%End

Decodes an areal unit from a string.

:param string: string to decode

:return: decoded units

.. seealso:: :py:func:`encodeUnit`

%End

Converts a translated string to an areal unit.

:param string: string representing an areal unit

.. seealso:: :py:func:`toString`

%End

Decodes an angular unit from a string.

:param string: string to decode

:return: decoded units

.. seealso:: :py:func:`encodeUnit`

%End

Decodes a render unit from a string.

:param string: string to decode

:return: decoded units

.. seealso:: :py:func:`encodeUnit`

%End

Decodes a layout unit from a string.

:param string: string to decode

:return: decoded units

.. seealso:: :py:func:`encodeUnit`

or if the given attribute is not an enum type.

:param index: the index of the attribute

%End

virtual bool addFeatures( QgsFeatureList &flist /In,Out/, QgsFeatureSink::Flags flags = 0 );

:param description:

:param useAsDefault:

:param uiFileContent:

%End

virtual int listStylesInDatabase( QStringList &ids /Out/, QStringList &names /Out/,

:param ids: the list in which will be stored the style db ids

:param names: the list in which will be stored the style names

:param msgError:

:return: the number of styles related to current layer

.. note::

Delete a style from the database

:param styleId: the provider's layer_styles table id of the style to delete

:return: true in case of success

.. versionadded:: 3.0

%End

:param index: this layers attribute index

:param fields: fields of the vector layer (including joined fields)

%End

int joinedFieldsOffset( const QgsVectorLayerJoinInfo *info, const QgsFields &fields );

:param layer: The layer to which the feature should be added

:param defaultValues: Default values for the feature to add

:param defaultGeometry: A default geometry to add to the feature

:return: True in case of success, False if the operation failed/was aborted

TODO QGIS 3: remove const qualifier

%End

:param request: The request for the features to be moved. It will be assigned to a new feature request with the newly copied features.

:param dx: The translation on x

:param dy: The translation on y

:return: True if all features could be copied.

TODO QGIS 3: remove const qualifier

%End

:param zip: The zip filename

:param dir: The output directory

.. versionadded:: 3.0

%End

:param returnRedValue: The red component of the new RGBA value

:param returnGreenValue: The green component of the new RGBA value

:param returnBlueValue: The blue component of the new RGBA value

:return: True if the return values are valid otherwise false

%End

bool shade( double redValue,

:param returnRedValue: The red component of the new RGBA value

:param returnGreenValue: The green component of the new RGBA value

:param returnBlueValue: The blue component of the new RGBA value

:return: True if the return values are valid otherwise false

%End

void setRasterShaderFunction( QgsRasterShaderFunction *function /Transfer/ );

:param returnRedValue: The red component of the new RGBA value

:param returnGreenValue: The green component of the new RGBA value

:param returnBlueValue: The blue component of the new RGBA value

:return: True if the return values are valid otherwise false

%End

virtual bool shade( double redValue,

:param returnRedValue: The red component of the new RGBA value

:param returnGreenValue: The green component of the new RGBA value

:param returnBlueValue: The blue component of the new RGBA value

:return: True if the return values are valid otherwise false

%End

double minimumMaximumRange() const;

:param vl: The vector layer for which this widget will be created

:param fieldName: The field name on the specified layer for which this widget will be created

:return: and integer value rating how good is the setup provided by this plugin.

%End

};

:param config: A configuration which should be used for the widget creation

:param editor: An editor widget which will be used instead of an autocreated widget

:param parent: The parent which will be used for the created wrapper and the created widget

:return: A new widget wrapper

%End