Class: QgsXmlUtils¶
Assorted helper methods for reading and writing chunks of XML.
Static Methods
Decodes a DOM element to a 3D box. |
|
Decodes a distance unit from a DOM element. |
|
Read a QVariant from a QDomElement. |
|
Encodes a 3D box to a DOM element. |
|
Encodes a distance unit to a DOM element. |
|
Encodes a rectangle to a DOM element. |
|
Write a QVariant to a QDomElement. |
- class qgis.core.QgsXmlUtils[source]¶
Bases:
object
- static readBox3D(element: QDomElement) QgsBox3D [source]¶
Decodes a DOM element to a 3D box.
- Parameters:
element (QDomElement) – DOM document
- Return type:
- Returns:
decoded 3D box
Added in version 3.36.
- static readMapUnits(element: QDomElement) Qgis.DistanceUnit [source]¶
Decodes a distance unit from a DOM element.
- Parameters:
element (QDomElement) – DOM element to decode
- Return type:
- Returns:
distance units
See also
- static readRectangle(element: QDomElement) QgsRectangle [source]¶
- Parameters:
element (QDomElement)
- Return type:
- static readVariant(element: QDomElement) Any [source]¶
Read a QVariant from a QDomElement.
- Parameters:
element (QDomElement)
- Return type:
Any
- static writeBox3D(box: QgsBox3D, doc: QDomDocument, elementName: str | None = '') QDomElement [source]¶
Encodes a 3D box to a DOM element.
- Parameters:
box (QgsBox3D) – 3D box to encode
doc (QDomDocument) – DOM document
elementName (Optional[str] = '') – name of the DOM element
- Return type:
QDomElement
- Returns:
element containing encoded 3D box
Added in version 3.36.
- static writeMapUnits(units: Qgis.DistanceUnit, doc: QDomDocument) QDomElement [source]¶
Encodes a distance unit to a DOM element.
- Parameters:
units (Qgis.DistanceUnit) – units to encode
doc (QDomDocument) – DOM document
- Return type:
QDomElement
- Returns:
element containing encoded units
See also
- static writeRectangle(rect: QgsRectangle, doc: QDomDocument, elementName: str | None = '') QDomElement [source]¶
Encodes a rectangle to a DOM element.
- Parameters:
rect (QgsRectangle) – rectangle to encode
doc (QDomDocument) – DOM document
elementName (Optional[str] = '') – name of the DOM element
- Return type:
QDomElement
- Returns:
element containing encoded rectangle
- static writeVariant(value: Any, doc: QDomDocument) QDomElement [source]¶
Write a QVariant to a QDomElement.
Supported types are
QVariant.Map
QVariant.Int
QVariant.Double
QVariant.String
QgsProperty
(since QGIS 3.4)QgsCoordinateReferenceSystem
(since QGIS 3.4)
- Parameters:
value (Any)
doc (QDomDocument)
- Return type:
QDomElement