doc/api/tree_8h_source.html

 #ifndef TREE_H_0302202332

 #define TREE_H_0302202332


 #include "export.h"


 #include "element.h"


 #include <expat.h>


 #ifdef __cplusplus

 extern "C" {

 #endif /* __cplusplus */


 typedef enum

   {

     scew_tree_standalone_unknown,

     scew_tree_standalone_no,

     scew_tree_standalone_yes

   } scew_tree_standalone;


 typedef struct scew_tree scew_tree;


 typedef scew_bool (*scew_tree_cmp_hook) (scew_tree const *, scew_tree const *);


 extern SCEW_API scew_tree* scew_tree_create (void);


 extern SCEW_API scew_tree* scew_tree_copy (scew_tree const *tree);


 extern SCEW_API void scew_tree_free (scew_tree *tree);


 extern SCEW_API scew_bool scew_tree_compare (scew_tree const *a,

                                              scew_tree const *b,

                                              scew_tree_cmp_hook hook);


 extern SCEW_API XML_Char const*

 scew_tree_xml_version (scew_tree const *tree);


 extern SCEW_API void scew_tree_set_xml_version (scew_tree *tree,

                                                 XML_Char const *version);


 extern SCEW_API XML_Char const* scew_tree_xml_encoding (scew_tree const *tree);


 extern SCEW_API void scew_tree_set_xml_encoding (scew_tree *tree,

                                                  XML_Char const *encoding);


 extern SCEW_API scew_tree_standalone

 scew_tree_xml_standalone (scew_tree const *tree);


 extern SCEW_API void

 scew_tree_set_xml_standalone (scew_tree *tree,

                               scew_tree_standalone standalone);


 extern SCEW_API scew_element* scew_tree_root (scew_tree const *tree);


 extern SCEW_API scew_element* scew_tree_set_root (scew_tree *tree,

                                                   XML_Char const *name);


 extern SCEW_API scew_element* scew_tree_set_root_element (scew_tree *tree,

                                                           scew_element *root);

 extern SCEW_API XML_Char const* scew_tree_xml_preamble (scew_tree const *tree);


 extern SCEW_API void scew_tree_set_xml_preamble (scew_tree *tree,

                                                  XML_Char const *preamble);


 #ifdef __cplusplus

 }

 #endif /* __cplusplus */


 #endif /* TREE_H_0302202332 */

element.h
SCEW element's handling routines.

scew_tree_set_root
SCEW_API scew_element * scew_tree_set_root(scew_tree *tree, XML_Char const *name)
Creates the root element of an XML tree with the given name.

scew_tree_standalone
scew_tree_standalone
List of possible values for the standalone attribute.
Definition: tree.h:61

export.h
SCEW shared library support.

scew_tree_set_xml_preamble
SCEW_API void scew_tree_set_xml_preamble(scew_tree *tree, XML_Char const *preamble)
Sets the preamble string for the XML document.

scew_tree_root
SCEW_API scew_element * scew_tree_root(scew_tree const *tree)
Returns the root element of the given tree.

scew_tree_standalone_no
Extra files are necessary.
Definition: tree.h:64

scew_bool
unsigned char scew_bool
This should be defined using stdbool.h when C99 is available.
Definition: bool.h:35

scew_tree_xml_standalone
SCEW_API scew_tree_standalone scew_tree_xml_standalone(scew_tree const *tree)
Returns whether the given tree is an standalone document.

scew_tree_standalone_yes
Document stands on its own.
Definition: tree.h:65

scew_tree_set_xml_encoding
SCEW_API void scew_tree_set_xml_encoding(scew_tree *tree, XML_Char const *encoding)
Sets the character encoding used in the given XML tree.

scew_tree_compare
SCEW_API scew_bool scew_tree_compare(scew_tree const *a, scew_tree const *b, scew_tree_cmp_hook hook)
Performs a deep comparison for the given trees.

scew_tree_free
SCEW_API void scew_tree_free(scew_tree *tree)
Frees a tree memory structure.

scew_tree_set_xml_standalone
SCEW_API void scew_tree_set_xml_standalone(scew_tree *tree, scew_tree_standalone standalone)
The standalone property tells the XML processor whether there are any other extra files to load...

scew_tree_xml_version
SCEW_API XML_Char const * scew_tree_xml_version(scew_tree const *tree)
Returns the current XML version for the given tree.

scew_tree_set_xml_version
SCEW_API void scew_tree_set_xml_version(scew_tree *tree, XML_Char const *version)
Sets the XML version in the XML declaration to the given tree.

scew_tree_xml_encoding
SCEW_API XML_Char const * scew_tree_xml_encoding(scew_tree const *tree)
Returns the current XML character encoding for the given tree.

scew_tree_xml_preamble
SCEW_API XML_Char const * scew_tree_xml_preamble(scew_tree const *tree)
Return the XML preamble for the given tree.

scew_tree_cmp_hook
scew_bool(* scew_tree_cmp_hook)(scew_tree const *, scew_tree const *)
SCEW tree compare hooks might be used to define new user XML tree comparisons.
Definition: tree.h:84

scew_tree
struct scew_tree scew_tree
This is the type delcaration for XML trees.
Definition: tree.h:73

scew_tree_create
SCEW_API scew_tree * scew_tree_create(void)
Creates a new empty XML tree in memory.

scew_tree_set_root_element
SCEW_API scew_element * scew_tree_set_root_element(scew_tree *tree, scew_element *root)
Sets the root element of an XML tree with the given element.

scew_tree_copy
SCEW_API scew_tree * scew_tree_copy(scew_tree const *tree)
Makes a deep copy of the given tree.

scew_element
struct scew_element scew_element
This is the type delcaration for SCEW elements.
Definition: element.h:56

scew_tree_standalone_unknown
Standalone attribute not defined.
Definition: tree.h:63