%Docstring

Exports the geometry to WKT

.. note::

precision parameter added in QGIS 2.4

%End

QString asJson( int precision = 17 ) const;

:param previousVertex: will be set to previous vertex ID

:param nextVertex: will be set to next vertex ID

.. note::

if the distance coincides exactly with a vertex, then both previousVertex and nextVertex will be set to this vertex

.. versionadded:: 3.0

%End

All themes found in ~/.qgis3/themes folder.

The path is to the root folder for the theme

.. note::

Valid theme folders must contain a style.qss file.

%End

static QString authorsFilePath();

%Docstring

Sets this CRS by lookup of the given ID in the CRS database.

.. note::

We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code

wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile.

/ // TODO QGIS 3: remove type and always use EPSG code, rename to createFromEpsg

%End

It also recognizes "QGIS", "USER", "CUSTOM" authorities, which all have the same meaning

and refer to QGIS internal CRS IDs.

.. note::

this method uses an internal cache. Call invalidateCache() to clear the cache.

.. seealso:: :py:func:`fromOgcWmsCrs()`

/ // TODO QGIS 3: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid())

%End

Otherwise the WKT will be converted to a proj4 string and createFromProj4()

set up the object.

.. note::

Some members may be left blank if no match can be found in CRS database.

this method uses an internal cache. Call invalidateCache() to clear the cache.

.. seealso:: :py:func:`fromWkt()`

%End

If the srsid is < USER_CRS_START_ID, system CRS database is used, otherwise

user's local CRS database from home directory is used.

:param srsId: The internal QGIS CRS ID for the desired spatial reference system.

:return: True on success else false

.. seealso:: :py:func:`fromSrsId()`

%End

a match where the parameters are in a different order

- if none of the above match, use findMatchingProj()

.. note::

Some members may be left blank if no match can be found in CRS database.

this method uses an internal cache. Call invalidateCache() to clear the cache.

.. seealso:: :py:func:`fromProj4()`

%End

For more details on supported formats see OGRSpatialReference.SetFromUserInput()

( http://www.gdal.org/ogr/classOGRSpatialReference.html#aec3c6a49533fe457ddc763d699ff8796 )

.. note::

this function generates a WKT string using OSRSetFromUserInput() and

passes it to createFromWkt() function.

/ // TODO QGIS3: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend

%End

Calculates the distance from one point with distance in meters and azimuth (direction)

When the sourceCrs() is geographic, computeSpheroidProject() will be called

otherwise QgsPoint.project() will be called after QgsUnitTypes.fromUnitToUnitFactor() has been applied to the distance

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

:param distance: must be in meters

.. seealso:: :py:func:`sourceCrs()`

.. seealso:: :py:func:`computeSpheroidProject()`

%End

QgsUnitTypes::DistanceUnit lengthUnits() const;

%Docstring

Returns the units of distance for length calculations made by this object.

.. seealso:: :py:func:`areaUnits()`

%End

QgsUnitTypes::AreaUnit areaUnits() const;

for the geodetic direct problem as described in "Geocentric

Datum of Australia Technical Manual", Chapter 4.

.. note::

code (and documentation) taken from rttopo project

--> latitudes outside these bounds cause the calculations to become unstable and can return invalid results

.. versionadded:: 3.0

%End

};

:param filename: destination file

.. note::

calling this implicitly sets the project's filename (see setFileName() )

isDirty() will be set to false if project is successfully written

.. versionadded:: 3.0

%End

bool write();

%Docstring

Writes the project to its current associated file (see fileName() ).

.. note::

isDirty() will be set to false if project is successfully written

%End

bool writeEntry( const QString &scope, const QString &key, bool value ) /PyName=writeEntryBool/;

By default will create the profile folder if not found.

By default will init the user settings.

:param defaultProfile: The profile name to find. Empty profile name will return "default" for the name.

:param createNew: Create the profile folder if it doesn't exist.

:param initSettings: if the settings should be initialized

:return: The user profile

%End

void setRootLocation( const QString &rootProfileLocation );

Then checks defaultProfile in global settings

Finally returns "default" if all else fails

.. note::

Setting overrideLocalProfile in global settings will always ignore profiles.ini

%End

void setDefaultProfileName( const QString &name );

%Docstring

Deletes a profile from the root profiles folder.

:param name: The name of the profile to delete.

:return: A QgsError with a message if the profile failed to be deleted.

%End

QgsUserProfile *userProfile();

if it is possible that both feature source and provider may need reading/writing to some shared data at the

same time, some synchronization mechanisms must be used (e.g. mutexes) to prevent data corruption.

:return: new instance of QgsAbstractFeatureSource (caller is responsible for deleting it)

%End

virtual QString storageType() const;

%Docstring

Delete a style from the database

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

:param msgError: reference to string that will be updated with any error messages

:return: true in case of success

%End

virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag /Out/, bool loadFromLocalDb );

:param geom: the geometry where each vertex is added to segments of other features

.. note::

geom is not going to be modified by the function

%End

int addTopologicalPoints( const QgsPointXY &p );

:param geom: the geometry where each vertex is added to segments of other features

.. note::

geom is not going to be modified by the function

%End

int addTopologicalPoints( const QgsPointXY &p );

virtual QString lastErrorTitle() = 0;

%Docstring

If an operation returns 0 (e.g. draw()), this function

returns the text of the error associated with the failure.

Turns on/off editing mode of the provider. When in editing mode, it is possible

to overwrite data of the provider using writeBlock() calls.

.. note::

Only some providers support editing mode and even those may fail to turn

the underlying data source into editing mode, so it is necessary to check the return

value whether the operation was successful.

.. seealso:: :py:func:`isEditable()`

.. versionadded:: 3.0

Returned provider may be used to initialize the raster using writeBlock() calls.

Ownership of the returned provider is passed to the caller.

.. note::

Does not work with tiled mode enabled.

.. versionadded:: 3.0

%End

Returned provider may be used to initialize the raster using writeBlock() calls.

Ownership of the returned provider is passed to the caller.

.. note::

Does not work with tiled mode enabled.

.. versionadded:: 3.0

%End

%Docstring

creates a QgsCategorizedSymbolRenderer from an existing renderer.

:return: a new renderer if the conversion was possible, otherwise 0.

%End

void setDataDefinedSizeLegend( QgsDataDefinedSizeLegend *settings /Transfer/ );

%Docstring

creates a QgsGraduatedSymbolRenderer from an existing renderer.

:return: a new renderer if the conversion was possible, otherwise 0.

%End

void setDataDefinedSizeLegend( QgsDataDefinedSizeLegend *settings /Transfer/ );

%Docstring

Creates a QgsInvertedPolygonRenderer by a conversion from an existing renderer.

:return: a new renderer if the conversion was possible, otherwise 0.

%End

};

%Docstring

Creates a QgsPointDisplacementRenderer from an existing renderer.

:return: a new renderer if the conversion was possible, otherwise None.

%End

private:

%Docstring

creates a QgsRuleBasedRenderer from an existing renderer.

:return: a new renderer if the conversion was possible, otherwise 0.

%End

static void convertToDataDefinedSymbology( QgsSymbol *symbol, const QString &sizeScaleField, const QString &rotationField = QString() );

%Docstring

creates a QgsSingleSymbolRenderer from an existing renderer.

:return: a new renderer if the conversion was possible, otherwise 0.

%End

void setDataDefinedSizeLegend( QgsDataDefinedSizeLegend *settings /Transfer/ );

%Docstring

The title of the panel.

.. note::

This may or may not be shown to the user.

%End

void setTitle( const QString &title );

%Docstring

Factory function to create the widget on demand as needed by the dock.

:param layer: The active layer in the dock.

:param canvas: The map canvas.

:param dockWidget: True of the widget will be shown a dock style widget.

:param parent: The parent of the widget.

:return: A new QgsMapStylePanel which is shown in the map style dock.

%End

};