StartDocument.h
1 /*
2  * Copyright (C) 2012 Marc Boris Duerner
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 
29 #ifndef Pt_Xml_StartDocument_h
30 #define Pt_Xml_StartDocument_h
31 
32 #include <Pt/Xml/Api.h>
33 #include <Pt/Xml/Node.h>
34 
35 namespace Pt {
36 
37 namespace Xml {
38 
44 class StartDocument : public Node
45 {
46  public:
51  , _standalone(false)
52  { }
53 
56  void clear()
57  {
58  _standalone = false;
59  }
60 
63  bool isStandalone() const
64  { return _standalone; }
65 
68  void setStandalone(bool alone)
69  { _standalone = alone; }
70 
72  inline static const Node::Type nodeId()
73  { return Node::StartDocument; }
74 
75  private:
76  bool _standalone;
77 };
78 
84 {
85  return nodeCast<StartDocument>(node);
86 }
87 
92 inline const StartDocument* toStartDocument(const Node* node)
93 {
94  return nodeCast<StartDocument>(node);
95 }
96 
102 {
103  return nodeCast<StartDocument>(node);
104 }
105 
110 inline const StartDocument& toStartDocument(const Node& node)
111 {
112  return nodeCast<StartDocument>(node);
113 }
114 
115 } // namespace Xml
116 
117 } // namespace Pt
118 
119 #endif // Pt_Xml_StartDocument_h
const StartDocument * toStartDocument(const Node *node)
Casts a generic node to a StartDocument node.
Definition: StartDocument.h:92
StartDocument & toStartDocument(Node &node)
Casts a generic node to a StartDocument node.
Definition: StartDocument.h:101
const StartDocument & toStartDocument(const Node &node)
Casts a generic node to a StartDocument node.
Definition: StartDocument.h:110
StartDocument()
Creates an empty object.
Definition: StartDocument.h:49
void clear()
Clears all content.
Definition: StartDocument.h:56
A Node representing the begin of the XML document.
Definition: StartDocument.h:44
StartDocument * toStartDocument(Node *node)
Casts a generic node to a StartDocument node.
Definition: StartDocument.h:83
void setStandalone(bool alone)
Indicates that the document is standalone.
Definition: StartDocument.h:68
bool isStandalone() const
Returns true if the document is standalone.
Definition: StartDocument.h:63
XML document node.
Definition: Node.h:50