File: qgsexiftools.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (117 lines) | stat: -rw-r--r-- 3,297 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/************************************************************************
 * 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   *
 ************************************************************************/