dom_element.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "../api_core.h"
33 #include "dom_node.h"
34 
35 namespace clan
36 {
39 
60 class CL_API_CORE DomElement : public DomNode
61 {
64 
65 public:
67  DomElement();
68 
69  DomElement(
70  DomDocument &doc,
71  const DomString &tag_name,
72  const DomString &namespace_uri = DomString());
73 
77  DomElement(const std::shared_ptr<DomNode_Impl> &impl);
78 
79  ~DomElement();
80 
84 
85 public:
87  DomString get_tag_name() const;
88 
92 
93 public:
95  bool has_attribute(const DomString &name) const;
96 
98  bool has_attribute_ns(
99  const DomString &namespace_uri,
100  const DomString &local_name) const;
101 
103  DomString get_attribute(const DomString &name) const;
104 
111  DomString get_attribute(const DomString &name, const DomString &default_value) const;
112 
114  DomString get_attribute_ns(
115  const DomString &namespace_uri,
116  const DomString &local_name) const;
117 
118  DomString get_attribute_ns(
119  const DomString &namespace_uri,
120  const DomString &local_name,
121  const DomString &default_value) const;
122 
124 
132  void set_attribute(const DomString &name, const DomString &value);
133 
134  void set_attribute_ns(
135  const DomString &namespace_uri,
136  const DomString &qualified_name,
137  const DomString &value);
138 
140 
141  void remove_attribute(const DomString &name);
142 
143  void remove_attribute_ns(
144  const DomString &namespace_uri,
145  const DomString &local_name);
146 
152  DomAttr get_attribute_node(const DomString &name) const;
153 
154  DomAttr get_attribute_node_ns(
155  const DomString &namespace_uri,
156  const DomString &local_name) const;
157 
163  DomAttr set_attribute_node(const DomAttr &attr);
164 
170  DomAttr set_attribute_node_ns(const DomAttr &attr);
171 
173 
175  DomNodeList get_elements_by_tag_name(const DomString &name);
176 
177  DomNodeList get_elements_by_tag_name_ns(
178  const DomString &namespace_uri,
179  const DomString &local_name);
180 
182  std::string get_text() const;
183 
185 
186  DomString get_child_string(const DomString &name, const DomString &default_value = DomString()) const;
187 
189 
190  DomString get_child_string_ns(const DomString &namespace_uri, const DomString &local_name, const DomString &default_value = DomString()) const;
191 
193 
194  int get_child_int(const DomString &name, int default_value = 0) const;
195 
197 
198  int get_child_int_ns(const DomString &namespace_uri, const DomString &local_name, int default_value = 0) const;
199 
201 
202  bool get_child_bool(const DomString &name, bool default_value = false) const;
203 
205 
206  bool get_child_bool_ns(const DomString &namespace_uri, const DomString &local_name, bool default_value = false) const;
207 
209 
210  void set_child_string(const DomString &name, const DomString &value);
211 
213 
214  void set_child_string_ns(const DomString &namespace_uri, const DomString &qualified_name, const DomString &value);
215 
217 
218  void set_child_int(const DomString &name, int value);
219 
221 
222  void set_child_int_ns(const DomString &namespace_uri, const DomString &qualified_name, int value);
223 
225 
226  void set_child_bool(const DomString &name, bool value);
227 
229 
230  void set_child_bool_ns(const DomString &namespace_uri, const DomString &qualified_name, bool value);
231 
233  DomElement get_first_child_element() const;
234 
236  DomElement get_next_sibling_element() const;
237 
239  int get_attribute_int(const DomString &name, int default_value = 0) const;
240 
242  int get_attribute_int_ns(const DomString &namespace_uri, const DomString &local_name, int default_value = 0) const;
243 
245  bool get_attribute_bool(const DomString &name, bool default_value = false) const;
246 
248  bool get_attribute_bool_ns(const DomString &namespace_uri, const DomString &local_name, bool default_value = false) const;
249 
251  float get_attribute_float(const DomString &name, float default_value = 0.0f) const;
252 
254  float get_attribute_float_ns(const DomString &namespace_uri, const DomString &local_name, float default_value = 0.0f) const;
255 
257  void set_attribute_int(const DomString &name, int value);
258 
260  void set_attribute_int_ns(const DomString &namespace_uri, const DomString &qualified_name, int value);
261 
263  void set_attribute_bool(const DomString &name, bool value);
264 
266  void set_attribute_bool_ns(const DomString &namespace_uri, const DomString &qualified_name, bool value);
267 
269  void set_attribute_float(const DomString &name, float value, int num_decimal_places = 6);
270 
272  void set_attribute_float_ns(const DomString &namespace_uri, const DomString &qualified_name, float value, int num_decimal_places = 6);
274 };
275 
276 }
277 
DOM Attribute class.
Definition: dom_attr.h:67
DOM Node List class.
Definition: dom_node_list.h:51
std::string DomString
Definition: dom_string.h:37
DOM Document class.
Definition: dom_document.h:65
DOM Node class.
Definition: dom_node.h:71
DOM Element class.
Definition: dom_element.h:60