GXmlComment.hpp
3.29 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
/***************************************************************************
* GXmlComment.hpp - XML comment 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 GXmlComment.hpp
* @brief XML comment node class interface definition
* @author Juergen Knodlseder
*/
#ifndef GXMLCOMMENT_HPP
#define GXMLCOMMENT_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GUrl.hpp"
#include "GXmlNode.hpp"
/***********************************************************************//**
* @class GXmlComment
*
* @brief XML comment node class
*
* This class implements a XML comment. The comment text is stored without
* the <!-- --> brackets.
***************************************************************************/
class GXmlComment : public GXmlNode {
public:
// Constructors and destructors
GXmlComment(void);
GXmlComment(const GXmlComment& node);
explicit GXmlComment(const std::string& segment);
virtual ~GXmlComment(void);
// Operators
GXmlComment& operator=(const GXmlComment& node);
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GXmlComment* clone(void) const;
virtual void write(GUrl& url, const int& indent = 0) const;
virtual NodeType type(void) const { return NT_COMMENT; }
virtual std::string print(const GChatter& chatter = NORMAL,
const int& indent = 0) const;
// Other methods
const std::string& comment(void) const { return m_comment; }
void comment(const std::string& comment) { m_comment=comment; }
protected:
// Protected methods
void init_members(void);
void copy_members(const GXmlComment& node);
void free_members(void);
void parse(const std::string& segment);
// Protected data members
std::string m_comment; //!< Comment (excluding brackets)
};
#endif /* GXMLCOMMENT_HPP */