libxml++
2.36.0
|
Represents an XML document in the DOM model. More...
#include <libxml++/document.h>
Public Member Functions | |
Document (const Glib::ustring& version="1.0") | |
Create a new document. | |
Document (_xmlDoc* doc) | |
Create a new C++ wrapper for an xmlDoc struct. | |
virtual | ~Document () |
Glib::ustring | get_encoding () const |
Dtd* | get_internal_subset () const |
Get the internal subset of this document. | |
void | set_internal_subset (const Glib::ustring& name, const Glib::ustring& external_id, const Glib::ustring& system_id) |
Create the internal subset of this document. | |
Element* | get_root_node () const |
Return the root node. | |
Element* | create_root_node (const Glib::ustring& name, const Glib::ustring& ns_uri=Glib::ustring(), const Glib::ustring& ns_prefix=Glib::ustring()) |
Create the root element node. | |
Element* | create_root_node_by_import (const Node* node, bool recursive=true) |
Create a root element node by importing the node from another document, without affecting the source node. | |
CommentNode* | add_comment (const Glib::ustring& content) |
Append a new comment node. | |
ProcessingInstructionNode* | add_processing_instruction (const Glib::ustring& name, const Glib::ustring& content) |
Append a new processing instruction node. | |
void | write_to_file (const Glib::ustring& filename, const Glib::ustring& encoding=Glib::ustring()) |
Write the document to a file. | |
void | write_to_file_formatted (const Glib::ustring& filename, const Glib::ustring& encoding=Glib::ustring()) |
Write the document to a file. | |
Glib::ustring | write_to_string (const Glib::ustring& encoding=Glib::ustring()) |
Write the document to the memory. | |
Glib::ustring | write_to_string_formatted (const Glib::ustring& encoding=Glib::ustring()) |
Write the document to the memory. | |
void | write_to_stream (std::ostream& output, const Glib::ustring& encoding=Glib::ustring()) |
Write the document to a std::ostream. | |
void | write_to_stream_formatted (std::ostream& output, const Glib::ustring& encoding=Glib::ustring()) |
Write the document to a std::ostream. | |
virtual void | set_entity_declaration (const Glib::ustring& name, XmlEntityType type, const Glib::ustring& publicId, const Glib::ustring& systemId, const Glib::ustring& content) |
Add an Entity declaration to the document. | |
int | process_xinclude (bool generate_xinclude_nodes=true) |
Perform XInclude substitution on the XML document. | |
_xmlDoc* | cobj () |
Access the underlying libxml implementation. | |
const _xmlDoc* | cobj () const |
Access the underlying libxml implementation. |
Protected Member Functions | |
_xmlEntity* | get_entity (const Glib::ustring& name) |
Retrieve an Entity. |
Additional Inherited Members |
Represents an XML document in the DOM model.
|
explicit |
Create a new document.
version | XML version. |
xmlpp::internal_error | If memory allocation fails. |
|
explicit |
Create a new C++ wrapper for an xmlDoc struct.
The created xmlpp::Document takes ownership of the xmlDoc. When the Document is deleted, so is the xmlDoc and all its nodes.
doc | A pointer to an xmlDoc struct. Must not be 0 . |
|
virtual |
CommentNode* xmlpp::Document::add_comment | ( | const Glib::ustring & | content | ) |
Append a new comment node.
content | The text. This should be unescaped - see ContentNode::set_content(). |
xmlpp::internal_error |
ProcessingInstructionNode* xmlpp::Document::add_processing_instruction | ( | const Glib::ustring & | name, |
const Glib::ustring & | content | ||
) |
Append a new processing instruction node.
name | The name of the application to which the instruction is directed. |
content | The content of the instruction. This should be unescaped - see ContentNode::set_content(). |
xmlpp::internal_error |
_xmlDoc* xmlpp::Document::cobj | ( | ) |
Access the underlying libxml implementation.
const _xmlDoc* xmlpp::Document::cobj | ( | ) | const |
Access the underlying libxml implementation.
Element* xmlpp::Document::create_root_node | ( | const Glib::ustring & | name, |
const Glib::ustring & | ns_uri = Glib::ustring() , |
||
const Glib::ustring & | ns_prefix = Glib::ustring() |
||
) |
Create the root element node.
If the document already contains a root element node, it is replaced, and the old root element node and all its descendants are deleted.
name | The node's name. |
ns_uri | The namespace URI. A namespace declaration will be added to this node, because it could not have been declared before. |
ns_prefix | The namespace prefix to associate with the namespace. If no namespace prefix is specified then the namespace URI will be the default namespace. |
xmlpp::internal_error | If memory allocation fails. |
xmlpp::exception | If a new namespace node cannot be created. |
Create a root element node by importing the node from another document, without affecting the source node.
If the document already contains a root element node, it is replaced, and the old root element node and all its descendants are deleted.
node | The node to copy and insert as the root node of the document. It must be an element node. |
recursive | Whether to import the child nodes also. Defaults to true. |
xmlpp::exception | If the node can't be copied. |
Glib::ustring xmlpp::Document::get_encoding | ( | ) | const |
|
protected |
Retrieve an Entity.
The entity can be from an external subset or internally declared.
name | The name of the entity to get. |
0
if not found. Dtd* xmlpp::Document::get_internal_subset | ( | ) | const |
Get the internal subset of this document.
0
if not found. Element* xmlpp::Document::get_root_node | ( | ) | const |
Return the root node.
This function does not create a default root node if it doesn't exist.
0
otherwise. int xmlpp::Document::process_xinclude | ( | bool | generate_xinclude_nodes = true | ) |
Perform XInclude substitution on the XML document.
XInclude substitution may both add and delete nodes in the document, as well as change the type of some nodes. All pointers to deleted nodes and nodes whose type is changed become invalid. (The node type represented by an underlying xmlNode struct can change. The type of a C++ wrapper can't change. The old wrapper is deleted, and a new one is created if and when it's required.)
generate_xinclude_nodes | Generate XIncludeStart and XIncludeEnd nodes. |
xmlpp::exception |
|
virtual |
Add an Entity declaration to the document.
name | The name of the entity that will be used in an entity reference. |
type | The type of entity. |
publicId | The public ID of the subset. |
systemId | The system ID of the subset. |
content | The value of the Entity. In entity reference substitutions, this is the replacement value. |
xmlpp::internal_error |
void xmlpp::Document::set_internal_subset | ( | const Glib::ustring & | name, |
const Glib::ustring & | external_id, | ||
const Glib::ustring & | system_id | ||
) |
Create the internal subset of this document.
If the document already has an internal subset, a new one is not created.
name | The DTD name. |
external_id | The external (PUBLIC) ID, or an empty string. |
system_id | The system ID, or an empty string. |
void xmlpp::Document::write_to_file | ( | const Glib::ustring & | filename, |
const Glib::ustring & | encoding = Glib::ustring() |
||
) |
Write the document to a file.
filename | |
encoding | If not provided, UTF-8 is used |
xmlpp::exception |
void xmlpp::Document::write_to_file_formatted | ( | const Glib::ustring & | filename, |
const Glib::ustring & | encoding = Glib::ustring() |
||
) |
Write the document to a file.
The output is formatted by inserting whitespaces, which is easier to read for a human, but may insert unwanted significant whitespaces. Use with care !
filename | |
encoding | If not provided, UTF-8 is used |
xmlpp::exception |
void xmlpp::Document::write_to_stream | ( | std::ostream & | output, |
const Glib::ustring & | encoding = Glib::ustring() |
||
) |
Write the document to a std::ostream.
output | A reference to the stream in which the document will be written |
encoding | If not provided, UTF-8 is used |
xmlpp::exception | |
xmlpp::internal_error |
void xmlpp::Document::write_to_stream_formatted | ( | std::ostream & | output, |
const Glib::ustring & | encoding = Glib::ustring() |
||
) |
Write the document to a std::ostream.
The output is formatted by inserting whitespaces, which is easier to read for a human, but may insert unwanted significant whitespaces. Use with care !
output | A reference to the stream in which the document will be written |
encoding | If not provided, UTF-8 is used |
xmlpp::exception | |
xmlpp::internal_error |
Glib::ustring xmlpp::Document::write_to_string | ( | const Glib::ustring & | encoding = Glib::ustring() | ) |
Write the document to the memory.
encoding | If not provided, UTF-8 is used |
xmlpp::exception |
Glib::ustring xmlpp::Document::write_to_string_formatted | ( | const Glib::ustring & | encoding = Glib::ustring() | ) |
Write the document to the memory.
The output is formatted by inserting whitespaces, which is easier to read for a human, but may insert unwanted significant whitespaces. Use with care !
encoding | If not provided, UTF-8 is used |
xmlpp::exception |