QgsXmlUtils class
Assorted helper methods for reading and writing chunks of XML.
Contents
- Reference
Public static functions
-
template<class T>static auto readFlagAttribute(const QDomElement& element, const QString& attributeName, T defaultValue) -> T
- Read a flag value from an attribute of the element.
-
static auto readMapUnits(const QDomElement& element) -> QgsUnitTypes::
DistanceUnit - Decodes a distance unit from a DOM element.
- static auto readVariant(const QDomElement& element) -> QVariant
- Read a QVariant from a QDomElement.
-
static auto writeMapUnits(QgsUnitTypes::
DistanceUnit units, QDomDocument& doc) -> QDomElement - Encodes a distance unit to a DOM element.
- static auto writeVariant(const QVariant& value, QDomDocument& doc) -> QDomElement
- Write a QVariant to a QDomElement.
Function documentation
template<class T>
static T QgsXmlUtils:: readFlagAttribute(const QDomElement& element,
const QString& attributeName,
T defaultValue)
Read a flag value from an attribute of the element.
| Parameters | |
|---|---|
| element | the element to read the attribute from |
| attributeName | the attribute name |
| defaultValue | the default value as a flag |
static QgsUnitTypes:: DistanceUnit QgsXmlUtils:: readMapUnits(const QDomElement& element)
Decodes a distance unit from a DOM element.
| Parameters | |
|---|---|
| element | DOM element to decode |
| Returns | distance units |
static QDomElement QgsXmlUtils:: writeMapUnits(QgsUnitTypes:: DistanceUnit units,
QDomDocument& doc)
Encodes a distance unit to a DOM element.
| Parameters | |
|---|---|
| units | units to encode |
| doc | DOM document |
| Returns | element containing encoded units |
static QDomElement QgsXmlUtils:: writeVariant(const QVariant& value,
QDomDocument& doc)
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)