QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
qgsxmlutils.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsxmlutils.h
3 ---------------------
4 begin : December 2013
5 copyright : (C) 2013 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSXMLUTILS_H
16#define QGSXMLUTILS_H
17
18class QDomDocument;
19
20class QgsRectangle;
21class QgsBox3D;
22
23#include "qgis.h"
24#include "qgis_core.h"
25#include "qgis_sip.h"
26
27#include <QDomElement>
28#include <QMetaEnum>
29
34class CORE_EXPORT QgsXmlUtils
35{
36 public:
37
38 /* reading */
39
46 static Qgis::DistanceUnit readMapUnits( const QDomElement &element );
47
48 static QgsRectangle readRectangle( const QDomElement &element );
49
56 static QgsBox3D readBox3D( const QDomElement &element );
57
58 /* writing */
59
67 static QDomElement writeMapUnits( Qgis::DistanceUnit units, QDomDocument &doc );
68
77 static QDomElement writeBox3D( const QgsBox3D &box, QDomDocument &doc, const QString &elementName = QStringLiteral( "extent3D" ) );
78
86 static QDomElement writeRectangle( const QgsRectangle &rect, QDomDocument &doc, const QString &elementName = QStringLiteral( "extent" ) );
87
101 static QDomElement writeVariant( const QVariant &value, QDomDocument &doc );
102
106 static QVariant readVariant( const QDomElement &element );
107
117 template<class T> static T readFlagAttribute( const QDomElement &element, const QString &attributeName, T defaultValue ) SIP_SKIP
118 {
119 T value = defaultValue;
120 // Get source categories
121 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
122 const QString sourceCategoriesStr( element.attribute( attributeName, metaEnum.valueToKeys( static_cast<int>( defaultValue ) ) ) );
123 if ( metaEnum.isValid() )
124 {
125 bool ok = false;
126 const int newValue = metaEnum.keysToValue( sourceCategoriesStr.toUtf8().constData(), &ok );
127 if ( ok )
128 value = static_cast<T>( newValue );
129 }
130 return value;
131 }
132};
133
134
135#endif // QGSXMLUTILS_H
DistanceUnit
Units of distance.
Definition qgis.h:5013
A 3-dimensional box composed of x, y, z coordinates.
Definition qgsbox3d.h:42
A rectangle specified with double values.
Assorted helper methods for reading and writing chunks of XML.
Definition qgsxmlutils.h:35
static T readFlagAttribute(const QDomElement &element, const QString &attributeName, T defaultValue)
Read a flag value from an attribute of the element.
static QDomElement writeBox3D(const QgsBox3D &box, QDomDocument &doc, const QString &elementName=QStringLiteral("extent3D"))
Encodes a 3D box to a DOM element.
static QDomElement writeVariant(const QVariant &value, QDomDocument &doc)
Write a QVariant to a QDomElement.
static QgsBox3D readBox3D(const QDomElement &element)
Decodes a DOM element to a 3D box.
static QDomElement writeRectangle(const QgsRectangle &rect, QDomDocument &doc, const QString &elementName=QStringLiteral("extent"))
Encodes a rectangle to a DOM element.
static QVariant readVariant(const QDomElement &element)
Read a QVariant from a QDomElement.
static Qgis::DistanceUnit readMapUnits(const QDomElement &element)
Decodes a distance unit from a DOM element.
static QgsRectangle readRectangle(const QDomElement &element)
static QDomElement writeMapUnits(Qgis::DistanceUnit units, QDomDocument &doc)
Encodes a distance unit to a DOM element.
#define SIP_SKIP
Definition qgis_sip.h:134