QGIS/python/core/auto_generated/raster/qgsexiftools.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

118 lines
3.2 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsexiftools.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsExifTools
{
%Docstring(signature="appended")
Contains utilities for working with EXIF tags in images.
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgsexiftools.h"
%End
public:
static const QMetaObject staticMetaObject;
public:
static QVariantMap readTags( const QString &imagePath );
%Docstring
Returns a map object containing all exif tags stored in the image at
``imagePath``.
.. versionadded:: 3.22
%End
static QVariant readTag( const QString &imagePath, const QString &key );
%Docstring
Returns the value of of an exif tag ``key`` stored in the image at
``imagePath``.
.. versionadded:: 3.22
%End
static QgsPoint getGeoTag( const QString &imagePath, bool &ok /Out/ );
%Docstring
Returns the geotagged coordinate stored in the image at ``imagePath``.
If a geotag was found, ``ok`` will be set to ``True``.
If the image contains an elevation tag then the returned point will
contain the elevation as a z value.
.. seealso:: :py:func:`geoTagImage`
%End
static bool hasGeoTag( const QString &imagePath );
%Docstring
Returns ``True`` if the image at ``imagePath`` contains a valid geotag.
.. seealso:: :py:func:`getGeoTag`
%End
class GeoTagDetails
{
%Docstring(signature="appended")
Extended image geotag details.
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgsexiftools.h"
%End
public:
GeoTagDetails();
double elevation;
};
static bool geoTagImage( const QString &imagePath, const QgsPointXY &location, const GeoTagDetails &details = QgsExifTools::GeoTagDetails() );
%Docstring
Writes geotags to the image at ``imagePath``.
The ``location`` argument indicates the GPS location to write to the
image, as a WGS84 latitude/longitude coordinate.
If desired, extended GPS tags (such as elevation) can be specified via
the ``details`` argument.
Returns ``True`` if writing was successful.
.. seealso:: :py:func:`getGeoTag`
%End
static bool tagImage( const QString &imagePath, const QString &tag, const QVariant &value );
%Docstring
Writes a tag to the image at imagePath.
:param imagePath: the image path
:param tag: the exif tag name
:param value: the exif tag value
:return: ``True`` if writing was successful.
.. versionadded:: 3.30
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsexiftools.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/