dom_document.h Source File - ClanLib SDK
Description: dom_document.h Source File

dom_document.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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 "dom_node.h"
33#include <vector>
34
35namespace clan
36{
39
40 class IODevice;
41 class DomDocumentType;
42 class DomImplementation;
43 class DomCDATASection;
44 class DomProcessingInstruction;
45 class DomElement;
46 class DomDocumentFragment;
47 class DomComment;
48 class DomText;
49 class DomAttr;
50 class DomEntityReference;
51 class DomNodeList;
52 class DomDocument_Impl;
53
64 class DomDocument : public DomNode
65 {
66 public:
68 DomDocument();
69
74 DomDocument(IODevice &input, bool eat_whitespace = true);
75
76 DomDocument(
77 const DomString &namespace_uri,
78 const DomString &qualified_name,
79 const DomDocumentType &doctype);
80
84 DomDocument(const std::shared_ptr<DomNode_Impl> &impl);
85
86 ~DomDocument();
87
89
92 DomDocumentType get_doctype();
93
95 DomImplementation get_implementation();
96
98
100 DomElement get_document_element();
101
103
106 DomElement create_element(const DomString &tag_name);
107
109 DomElement create_element_ns(
110 const DomString &namespace_uri,
111 const DomString &qualified_name);
112
114 DomDocumentFragment create_document_fragment();
115
119 DomText create_text_node(const DomString &data);
120
124 DomComment create_comment(const DomString &data);
125
129 DomCDATASection create_cdata_section(const DomString &data);
130
135 DomProcessingInstruction create_processing_instruction(
136 const DomString &target,
137 const DomString &data);
138
140
142 DomAttr create_attribute(const DomString &name);
143
145
146 DomAttr create_attribute_ns(
147 const DomString &namespace_uri,
148 const DomString &qualified_name);
149
153 DomEntityReference create_entity_reference(const DomString &name);
154
156
159 DomNodeList get_elements_by_tag_name(const DomString &tag_name);
160
162
164 DomNodeList get_elements_by_tag_name_ns(
165 const DomString &namespace_uri,
166 const DomString &qualified_name);
167
169 DomElement get_element_by_id(const DomString &element_id);
170
172
181 DomNode import_node(
182 const DomNode &node,
183 bool deep);
184
191 std::vector<DomNode> load(
192 IODevice &input,
193 bool eat_whitespace = true,
194 DomNode insert_point = DomNode());
195
200 void save(IODevice &output, bool insert_whitespace = true);
201
203 void clear_all();
204 };
205
207}
clan::DomAttr
DOM Attribute class.
Definition dom_attr.h:67
clan::DomCDATASection
DOM CDATA Section.
Definition dom_cdata_section.h:55
clan::DomComment
DOM Comment class.
Definition dom_comment.h:45
clan::DomDocumentFragment
DOM Document Fragment class.
Definition dom_document_fragment.h:71
clan::DomDocumentType
DOM Document Type class.
Definition dom_document_type.h:51
clan::DomDocument::create_document_fragment
DomDocumentFragment create_document_fragment()
Creates an empty DocumentFragment object.
clan::DomDocument::get_implementation
DomImplementation get_implementation()
Returns the DomImplementation object that handles this document.
clan::DomDocument::create_element
DomElement create_element(const DomString &tag_name)
Creates an element of the type specified.
clan::DomDocument::load
std::vector< DomNode > load(IODevice &input, bool eat_whitespace=true, DomNode insert_point=DomNode())
Loads the DOM document as XML from an input source.
clan::DomDocument::DomDocument
DomDocument(const std::shared_ptr< DomNode_Impl > &impl)
Constructs a DomDocument.
clan::DomDocument::DomDocument
DomDocument()
Constructs a DOM Document.
clan::DomDocument::create_cdata_section
DomCDATASection create_cdata_section(const DomString &data)
Creates a CDATASection node whose value is the specified string.
clan::DomDocument::create_comment
DomComment create_comment(const DomString &data)
Creates a Comment node given the specified string.
clan::DomDocument::~DomDocument
~DomDocument()
clan::DomDocument::get_doctype
DomDocumentType get_doctype()
Returns the Document Type Declaration (see DomDocumentType)associated with this document.
clan::DomDocument::DomDocument
DomDocument(const DomString &namespace_uri, const DomString &qualified_name, const DomDocumentType &doctype)
clan::DomDocument::create_entity_reference
DomEntityReference create_entity_reference(const DomString &name)
Creates an EntityReference object.
clan::DomDocument::create_attribute_ns
DomAttr create_attribute_ns(const DomString &namespace_uri, const DomString &qualified_name)
Creates an attribute of the given qualified name and namespace URI.
clan::DomDocument::save
void save(IODevice &output, bool insert_whitespace=true)
Saves the DOM document as XML to an input source.
clan::DomDocument::DomDocument
DomDocument(IODevice &input, bool eat_whitespace=true)
Constructs a DomDocument.
clan::DomDocument::create_element_ns
DomElement create_element_ns(const DomString &namespace_uri, const DomString &qualified_name)
Creates an element of the given qualified name and namespace URI.
clan::DomDocument::clear_all
void clear_all()
Removes all nodes from the DOM document.
clan::DomDocument::get_elements_by_tag_name
DomNodeList get_elements_by_tag_name(const DomString &tag_name)
Returns a NodeList of all the Elements with a given tag name.
clan::DomDocument::create_attribute
DomAttr create_attribute(const DomString &name)
Creates an Attr of the given name.
clan::DomDocument::get_elements_by_tag_name_ns
DomNodeList get_elements_by_tag_name_ns(const DomString &namespace_uri, const DomString &qualified_name)
Returns a NodeList of all the Elements with a given local name and namespace URI.
clan::DomDocument::get_element_by_id
DomElement get_element_by_id(const DomString &element_id)
Returns the Element whose ID is given by element_id.
clan::DomDocument::create_processing_instruction
DomProcessingInstruction create_processing_instruction(const DomString &target, const DomString &data)
Creates a ProcessingInstruction node given the specified name and data strings.
clan::DomDocument::import_node
DomNode import_node(const DomNode &node, bool deep)
Imports a node from another document to this document.
clan::DomDocument::create_text_node
DomText create_text_node(const DomString &data)
Creates a Text node given the specified string.
clan::DomDocument::get_document_element
DomElement get_document_element()
Returns the root document element node.
clan::DomElement
DOM Element class.
Definition dom_element.h:60
clan::DomEntityReference
DOM Entity Reference class.
Definition dom_entity_reference.h:52
clan::DomImplementation
DOM Implementation class.
Definition dom_implementation.h:49
clan::DomNodeList
DOM Node List class.
Definition dom_node_list.h:51
clan::DomNode::DomNode
DomNode()
clan::DomNode::impl
std::shared_ptr< DomNode_Impl > impl
Definition dom_node.h:396
clan::DomProcessingInstruction
DOM Processing Instruction class.
Definition dom_processing_instruction.h:44
clan::DomText
DOM Text class.
Definition dom_text.h:55
clan::IODevice
I/O Device interface.
Definition iodevice.h:50
clan::DomString
std::string DomString
Definition dom_string.h:37
clan
Definition clanapp.h:36