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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*
** ClanLib SDK
** Copyright (c) 1997-2005 The ClanLib Team
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
** claim that you wrote the original software. If you use this software
** in a product, an acknowledgment in the product documentation would be
** appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
** misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Note: Some of the libraries ClanLib may link to may have additional
** requirements or restrictions.
**
** File Author(s):
**
** Magnus Norddahl
** (if your name is missing here, please add it)
*/
//! clanCore="XML"
//! header=core.h
#ifndef header_dom_element
#define header_dom_element
#ifdef CL_API_DLL
#ifdef CL_CORE_EXPORT
#define CL_API_CORE __declspec(dllexport)
#else
#define CL_API_CORE __declspec(dllimport)
#endif
#else
#define CL_API_CORE
#endif
#if _MSC_VER > 1000
#pragma once
#endif
#include "dom_node.h"
//: DOM Element class.
//- !group=Core/XML!
//- !header=core.h!
//- <p>By far the vast majority of objects (apart from text) that authors encounter when
//- traversing a document are Element nodes. Assume the following XML document:</p>
//- <pre>
//- <elementExample id="demo">
//- <subelement1/>
//- <subelement2><subsubelement/></subelement2>
//- </elementExample/gt;
//- </pre>
//- <p>When represented using DOM, the top node is an Element node for "elementExample",
//- which contains two child Element nodes, one for "subelement1" and one for "subelement2".
//- "subelement1" contains no child nodes.</p>
//- <p>Elements may have attributes associated with them; since the Element interface
//- inherits from Node, the generic Node interface method getAttributes may be used to
//- retrieve the set of all attributes for an element. There are methods on the Element
//- interface to retrieve either an Attr object by name or an attribute value by name.
//- In XML, where an attribute value may contain entity references, an Attr object should
//- be retrieved to examine the possibly fairly complex sub-tree representing the attribute
//- value.</p>
class CL_API_CORE CL_DomElement : public CL_DomNode
{
//! Construction:
public:
//: Constructs a DOM Element handle.
CL_DomElement();
CL_DomElement(CL_DomDocument &doc, const std::string &tag_name);
CL_DomElement(const CL_SharedPtr<CL_DomNode_Generic> &impl);
~CL_DomElement();
//! Attributes:
public:
//: Returns the name of the element.
std::string get_tag_name() const;
//! Operations:
public:
//: Returns true if the element has the specified attribute.
bool has_attribute(const std::string &name) const;
//: Returns the specified attribute.
std::string get_attribute(const std::string &name) const;
//: Returns the specified attribute, using a default value if its not there.
std::string get_attribute(const std::string &name, const std::string &default_value) const;
//: Adds a new attribute.
//- <p>If an attribute with that name is already present in the element, its value is
//- changed to be that of the value parameter.</p>
//- <p>This value is a simple string, it is not parsed as it is being set. So any markup
//- (such as syntax to be recognized as an entity reference) is treated as literal text, and
//- is appropriately escaped by the implementation when it is written out. In order to
//- assign an attribute value that contains entity references, the user must create an Attr
//- node plus any Text and EntityReference nodes, build the appropriate subtree, and use
//- set_attribute_node to assign it as the value of an attribute.</p>
void set_attribute(const std::string &name, const std::string &value);
//: Removes an attribute by name.
//- <p>If the removed attribute has a default value it is immediately replaced.</p>
void remove_attribute(const std::string &name);
//: Returns a NodeList of all descendant elements with a given tag name.
//- <p>The descendant elements are returned in the order in which they would be
//- encountered in a preorder traversal of the Element tree.</p>
CL_DomNodeList get_elements_by_tag_name(const std::string &name);
//: Merges any adjacent Text nodes.
//- <p>Puts all Text nodes in the full depth of the sub-tree underneath this Element into
//- a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA
//- sections, and entity references) separates Text nodes, i.e., there are no adjacent Text
//- nodes. This can be used to ensure that the DOM view of a document is the same as if it
//- were saved and re-loaded, and is useful when operations (such as XPointer lookups) that
//- depend on a particular document tree structure are to be used.</p>
void normalize();
//: Returns the text of all child Text nodes appended together.
std::string get_text() const;
};
#endif
|
