QGIS/python/core/auto_generated/project/qgsprojectdisplaysettings.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

122 lines
3.7 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/project/qgsprojectdisplaysettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProjectDisplaySettings : QObject
{
%Docstring(signature="appended")
Contains settings and properties relating to how a :py:class:`QgsProject` should display
values such as map coordinates and bearings.
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgsprojectdisplaysettings.h"
%End
public:
QgsProjectDisplaySettings( QObject *parent = 0 );
%Docstring
Constructor for QgsProjectDisplaySettings with the specified ``parent`` object.
%End
~QgsProjectDisplaySettings();
void reset();
%Docstring
Resets the settings to a default state.
%End
void setBearingFormat( QgsBearingNumericFormat *format /Transfer/ );
%Docstring
Sets the project bearing ``format``, which controls how bearings associated with the project are displayed.
Ownership of ``format`` is transferred to the settings.
.. seealso:: :py:func:`bearingFormat`
.. seealso:: :py:func:`bearingFormatChanged`
%End
const QgsBearingNumericFormat *bearingFormat() const;
%Docstring
Returns the project bearing's format, which controls how bearings associated with the project are displayed.
.. seealso:: :py:func:`setBearingFormat`
.. seealso:: :py:func:`bearingFormatChanged`
%End
void setGeographicCoordinateFormat( QgsGeographicCoordinateNumericFormat *format /Transfer/ );
%Docstring
Sets the project geographic coordinate ``format``, which controls how geographic coordinates associated with the project are displayed.
Ownership of ``format`` is transferred to the settings.
.. seealso:: :py:func:`geographicCoordinateFormat`
.. seealso:: :py:func:`geographicCoordinateFormatChanged`
.. versionadded:: 3.26
%End
const QgsGeographicCoordinateNumericFormat *geographicCoordinateFormat() const;
%Docstring
Returns the project's geographic coordinate format, which controls how geographic coordinates associated with the project are displayed.
.. seealso:: :py:func:`setGeographicCoordinateFormat`
.. seealso:: :py:func:`geographicCoordinateFormatChanged`
%End
bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
%Docstring
Reads the settings's state from a DOM element.
.. seealso:: :py:func:`writeXml`
%End
QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
%Docstring
Returns a DOM element representing the settings.
.. seealso:: :py:func:`readXml`
%End
signals:
void bearingFormatChanged();
%Docstring
Emitted when the bearing format changes.
.. seealso:: :py:func:`setBearingFormat`
.. seealso:: :py:func:`bearingFormat`
%End
void geographicCoordinateFormatChanged();
%Docstring
Emitted when the geographic coordinate format changes.
.. seealso:: :py:func:`setGeographicCoordinateFormat`
.. seealso:: :py:func:`geographicCoordinateFormat`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/project/qgsprojectdisplaysettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/