File: qgsxmlutils.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 (116 lines) | stat: -rw-r--r-- 3,154 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsxmlutils.h                                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/







class QgsXmlUtils
{
%Docstring(signature="appended")
Assorted helper methods for reading and writing chunks of XML
%End

%TypeHeaderCode
#include "qgsxmlutils.h"
%End
  public:


    static Qgis::DistanceUnit readMapUnits( const QDomElement &element );
%Docstring
Decodes a distance unit from a DOM element.

:param element: DOM element to decode

:return: distance units

.. seealso:: :py:func:`writeMapUnits`
%End

    static QgsRectangle readRectangle( const QDomElement &element );

    static QgsBox3D readBox3D( const QDomElement &element );
%Docstring
Decodes a DOM element to a 3D box.

:param element: DOM document

:return: decoded 3D box

.. versionadded:: 3.36
%End


    static QDomElement writeMapUnits( Qgis::DistanceUnit units, QDomDocument &doc );
%Docstring
Encodes a distance unit to a DOM element.

:param units: units to encode
:param doc: DOM document

:return: element containing encoded units

.. seealso:: :py:func:`readMapUnits`
%End

    static QDomElement writeBox3D( const QgsBox3D &box, QDomDocument &doc, const QString &elementName = QStringLiteral( "extent3D" ) );
%Docstring
Encodes a 3D box to a DOM element.

:param box: 3D box to encode
:param doc: DOM document
:param elementName: name of the DOM element

:return: element containing encoded 3D box

.. versionadded:: 3.36
%End

    static QDomElement writeRectangle( const QgsRectangle &rect, QDomDocument &doc, const QString &elementName = QStringLiteral( "extent" ) );
%Docstring
Encodes a rectangle to a DOM element.

:param rect: rectangle to encode
:param doc: DOM document
:param elementName: name of the DOM element

:return: element containing encoded rectangle
%End

    static QDomElement writeVariant( const QVariant &value, QDomDocument &doc );
%Docstring
Write a QVariant to a QDomElement.

Supported types are

- QVariant.Map
- QVariant.Int
- QVariant.Double
- QVariant.String
- :py:class:`QgsProperty` (since QGIS 3.4)
- :py:class:`QgsCoordinateReferenceSystem` (since QGIS 3.4)
%End

    static QVariant readVariant( const QDomElement &element );
%Docstring
Read a QVariant from a QDomElement.
%End

};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsxmlutils.h                                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/