mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
239 lines
6.4 KiB
Plaintext
239 lines
6.4 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/project/qgsprojectdisplaysettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py 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
|
|
|
|
Qgis::CoordinateDisplayType coordinateType() const;
|
|
%Docstring
|
|
Returns default coordinate type for the project.
|
|
|
|
.. seealso:: :py:func:`setCoordinateType`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
void setCoordinateType( Qgis::CoordinateDisplayType type );
|
|
%Docstring
|
|
Sets the default coordinate ``type`` for the project.
|
|
|
|
.. seealso:: :py:func:`coordinateType`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
Qgis::CoordinateOrder coordinateAxisOrder() const;
|
|
%Docstring
|
|
Returns default coordinate axis order to use when displaying coordinates for the project.
|
|
|
|
.. seealso:: :py:func:`setCoordinateAxisOrder`
|
|
|
|
.. seealso:: :py:func:`coordinateAxisOrderChanged`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
void setCoordinateAxisOrder( Qgis::CoordinateOrder order );
|
|
%Docstring
|
|
Sets the default coordinate axis ``order`` to use when displaying coordinates for the project.
|
|
|
|
.. seealso:: :py:func:`coordinateAxisOrder`
|
|
|
|
.. seealso:: :py:func:`coordinateAxisOrderChanged`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
QgsCoordinateReferenceSystem coordinateCustomCrs() const;
|
|
%Docstring
|
|
Returns the coordinate custom CRS used when the project coordinate type is set to :py:class:`Qgis`.CoordinateDisplayType.CustomCrs.
|
|
|
|
.. seealso:: :py:func:`setCoordinateCustomCrs`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
void setCoordinateCustomCrs( const QgsCoordinateReferenceSystem &crs );
|
|
%Docstring
|
|
Sets the coordinate custom CRS used when the project coordinate type is set to :py:class:`Qgis`.CoordinateDisplayType.CustomCrs.
|
|
|
|
.. seealso:: :py:func:`setCoordinateCustomCrs`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
QgsCoordinateReferenceSystem coordinateCrs() const;
|
|
%Docstring
|
|
Returns the coordinate display CRS used derived from the coordinate type.
|
|
|
|
.. seealso:: :py:func:`coordinateType`
|
|
|
|
.. note::
|
|
|
|
if not parented to a project object, an invalid CRS will be returned.
|
|
|
|
.. versionadded:: 3.28
|
|
%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
|
|
|
|
void coordinateTypeChanged();
|
|
%Docstring
|
|
Emitted when the default coordinate format changes.
|
|
|
|
.. seealso:: :py:func:`setCoordinateType`
|
|
|
|
.. seealso:: :py:func:`coordinateType`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
void coordinateAxisOrderChanged();
|
|
%Docstring
|
|
Emitted when the default coordinate axis order changes.
|
|
|
|
.. seealso:: :py:func:`setCoordinateAxisOrder`
|
|
|
|
.. seealso:: :py:func:`coordinateAxisOrder`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
void coordinateCustomCrsChanged();
|
|
%Docstring
|
|
Emitted when the coordinate custom CRS changes.
|
|
|
|
.. seealso:: :py:func:`setCoordinateCustomCrs`
|
|
|
|
.. seealso:: :py:func:`coordinateCustomCrs`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
void coordinateCrsChanged();
|
|
%Docstring
|
|
Emitted when the coordinate CRS changes.
|
|
|
|
.. seealso:: :py:func:`coordinateCrs`
|
|
|
|
.. seealso:: :py:func:`coordinateType`
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/project/qgsprojectdisplaysettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|