QGIS/python/core/auto_generated/qgslocaldefaultsettings.sip.in
Nyall Dawson 0ee1cee1d5 Rework project coordinate format handling to use numeric format instead
This now follows the approach used for bearing formats, where a user
can defined a default coordinate format for newly created projects
in the Settings - Options - Map Tools section.

New projects will inherit that setting, but the format can then
be changed through the Project Properties - Coordinate Format button.

This ultimately exposes more control to users for how coordinates
are formatted for a project, eg allowing them to control whether
direction suffixes are shown, and whether leading or trailing zeros
should be included.
2022-04-21 19:05:38 +10:00

79 lines
2.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgslocaldefaultsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLocalDefaultSettings
{
%Docstring(signature="appended")
Contains local default settings which should be respected when creating new objects
such as :py:class:`QgsProjects`.
This class contains a variety of default setting values. These values are local, profile
specific settings which may have been configured or tweaked by the user (as opposed to
global, fixed default settings).
The values encapsulated here should be inherited when creating new objects such as new
QGIS projects.
Typically, the :py:class:`QgsSettings` backend is used to store and retrieve these local settings.
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgslocaldefaultsettings.h"
%End
public:
static void setBearingFormat( const QgsBearingNumericFormat *format );
%Docstring
Sets the default bearing ``format``, which controls how angular bearings are displayed.
.. seealso:: :py:func:`bearingFormat`
%End
static QgsBearingNumericFormat *bearingFormat() /Factory/;
%Docstring
Returns the default bearing format, which controls how angular bearings are displayed.
This method returns a new object and the caller takes ownership of the returned value.
.. seealso:: :py:func:`setBearingFormat`
%End
static void setGeographicCoordinateFormat( const QgsGeographicCoordinateNumericFormat *format );
%Docstring
Sets the default geographic coordinate ``format``, which controls how geographic coordinates are displayed.
.. seealso:: :py:func:`geographicCoordinateFormat`
.. versionadded:: 3.26
%End
static QgsGeographicCoordinateNumericFormat *geographicCoordinateFormat() /Factory/;
%Docstring
Returns the default geographic coordinate format, which controls how geographic coordinates are displayed.
This method returns a new object and the caller takes ownership of the returned value.
.. seealso:: :py:func:`setGeographicCoordinateFormat`
.. versionadded:: 3.26
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgslocaldefaultsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/