GXmlDocument.hpp
3.78 KB
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
/***************************************************************************
* GXmlDocument.hpp - XML document node class definition *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2013 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GXmlDocument.hpp
* @brief XML document node class interface definition
* @author Juergen Knodlseder
*/
#ifndef GXMLDOCUMENT_HPP
#define GXMLDOCUMENT_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GUrl.hpp"
#include "GXmlNode.hpp"
#include "GXmlAttribute.hpp"
/***********************************************************************//**
* @class GXmlDocument
*
* @brief XML document node class
*
* This class implements the root node of an XML document. The root node is
* a Processing Instruction which contains the following attributes:
* - @p version
* - @p encoding
* - @p standalone
*
* All three attributes are systematically written.
***************************************************************************/
class GXmlDocument : public GXmlNode {
public:
// Constructors and destructors
GXmlDocument(void);
GXmlDocument(const GXmlDocument& node);
virtual ~GXmlDocument(void);
// Operators
GXmlDocument& operator=(const GXmlDocument& node);
// Implemented pure virtual base class methods
void clear(void);
GXmlDocument* clone(void) const;
void write(GUrl& url, const int& indent = 0) const;
NodeType type(void) const { return NT_DOCUMENT; }
std::string print(const GChatter& chatter = NORMAL,
const int& indent = 0) const;
// Methods
std::string version(void) const { return m_version.value(); }
std::string encoding(void) const { return m_encoding.value(); }
std::string standalone(void) const { return m_standalone.value(); }
void version(const std::string& version) { m_version.value(version); }
void encoding(const std::string& encoding) { m_encoding.value(encoding); }
void standalone(const std::string& standalone) { m_standalone.value(standalone); }
protected:
// Protected methods
void init_members(void);
void copy_members(const GXmlDocument& node);
void free_members(void);
// Protected data members
GXmlAttribute m_version; //!< XML version ("1.0", "1.1")
GXmlAttribute m_encoding; //!< Encoding (e.g. "UTF-8")
GXmlAttribute m_standalone; //!< Standalone ("yes", "no")
};
#endif /* GXMLDOCUMENT_HPP */