Class: QgsXmlUtils

class qgis.core.QgsXmlUtils

Bases: sip.wrapper

Assorted helper methods for reading and writing chunks of XML

Methods

readBox3D

Decodes a DOM element to a 3D box.

readMapUnits

Decodes a distance unit from a DOM element.

readRectangle

param element:

readVariant

Read a QVariant from a QDomElement.

writeBox3D

Encodes a 3D box to a DOM element.

writeMapUnits

Encodes a distance unit to a DOM element.

writeRectangle

Encodes a rectangle to a DOM element.

writeVariant

Write a QVariant to a QDomElement.

readBox3D(element: QDomElement) QgsBox3D

Decodes a DOM element to a 3D box.

Parameters:

element (QDomElement) – DOM document

Return type:

QgsBox3D

Returns:

decoded 3D box

New in version 3.36.

readMapUnits(element: QDomElement) Qgis.DistanceUnit

Decodes a distance unit from a DOM element.

Parameters:

element (QDomElement) – DOM element to decode

Return type:

Qgis.DistanceUnit

Returns:

distance units

See also

writeMapUnits()

readRectangle(element: QDomElement) QgsRectangle
Parameters:

element (QDomElement) –

Return type:

QgsRectangle

readVariant(element: QDomElement) Any

Read a QVariant from a QDomElement.

Parameters:

element (QDomElement) –

Return type:

Any

writeBox3D(box: QgsBox3D, doc: QDomDocument, elementName: str = '') QDomElement

Encodes a 3D box to a DOM element.

Parameters:
  • box (QgsBox3D) – 3D box to encode

  • doc (QDomDocument) – DOM document

  • elementName (str = '') – name of the DOM element

Return type:

QDomElement

Returns:

element containing encoded 3D box

New in version 3.36.

writeMapUnits(units: Qgis.DistanceUnit, doc: QDomDocument) QDomElement

Encodes a distance unit to a DOM element.

Parameters:
Return type:

QDomElement

Returns:

element containing encoded units

See also

readMapUnits()

writeRectangle(rect: QgsRectangle, doc: QDomDocument, elementName: str = '') QDomElement

Encodes a rectangle to a DOM element.

Parameters:
  • rect (QgsRectangle) – rectangle to encode

  • doc (QDomDocument) – DOM document

  • elementName (str = '') – name of the DOM element

Return type:

QDomElement

Returns:

element containing encoded rectangle

writeVariant(value: Any, doc: QDomDocument) QDomElement

Write a QVariant to a QDomElement.

Supported types are

Parameters:
  • value (Any) –

  • doc (QDomDocument) –

Return type:

QDomElement