Main Page | Class Hierarchy | Class List | File List | Class Members

xml::init Class Reference

The xml::init class is used to initilize the XML parser. More...

#include <init.h>

Inheritance diagram for xml::init:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 init (void)
 Create a new xml::init object.

virtual ~init (void)
 Clean up the XML parser.

void indent_output (bool flag)
 This member function controls whether or not the XML parser should add text nodes for indenting when generating XML text output from a node tree.

void remove_whitespace (bool flag)
 This member function controls whether or not the XML parser should remove ignorable whitespace around XML elements.

void substitute_entities (bool flag)
 This member function controls whether or not the XML parser should substitute entities while parsing.

void load_external_subsets (bool flag)
 This member function controls whether or not the XML parser should load external (DTD) subsets while parsing.

void validate_xml (bool flag)
 This member function controls whether or not the XML parser should validate every XML document that is parses with its DTD.


Detailed Description

The xml::init class is used to initilize the XML parser.

For thread safety it should be instantiated one time in the main thread before any other threads use xmlwrapp. Non-threaded programs should instantiante a xml::init class before using xmlwrapp as well, at least for consistanticy.

If you want to use and of the xml::init member functions, do so before you start any threads or use any other part of xmlwrapp. The member functions may alter global and/or static variables. In other words, this class is not thread safe.


Constructor & Destructor Documentation

xml::init::init void   ) 
 

Create a new xml::init object.

This constructor will prepare the XML parser and set some default values for the parsers global variables.

Author:
Peter Jones

Reimplemented in xslt::init.

virtual xml::init::~init void   )  [virtual]
 

Clean up the XML parser.

Don't let the xml::init object go out of scope before you are done using the xmlwrapp library!

Author:
Peter Jones

Reimplemented in xslt::init.


Member Function Documentation

void xml::init::indent_output bool  flag  ) 
 

This member function controls whether or not the XML parser should add text nodes for indenting when generating XML text output from a node tree.

The default, set in the xml::init constructor, is true.

Parameters:
flag True to turn on indenting, false to turn it off.
Author:
Peter Jones

void xml::init::load_external_subsets bool  flag  ) 
 

This member function controls whether or not the XML parser should load external (DTD) subsets while parsing.

This will only affect the loading of the subsets, it does not cause files to be validated. The default, set in the xml::init constructor, is true.

Parameters:
flag True to turn on loading, flase to turn it off.
Author:
Peter Jones

void xml::init::remove_whitespace bool  flag  ) 
 

This member function controls whether or not the XML parser should remove ignorable whitespace around XML elements.

The default, set in the xml::init constructor, is false.

Parameters:
flag True to remove whitespace, false to leave alone.
Author:
Peter Jones

void xml::init::substitute_entities bool  flag  ) 
 

This member function controls whether or not the XML parser should substitute entities while parsing.

The default, set in the xml::init constructor, is true.

Parameters:
flag True to turn on substitution, false to turn off.
Author:
Peter Jones

void xml::init::validate_xml bool  flag  ) 
 

This member function controls whether or not the XML parser should validate every XML document that is parses with its DTD.

The default, set in the xml::init constructor, is false.

Returns:
flag True to turn on validation, false to turn it off.
Author:
Peter Jones


The documentation for this class was generated from the following file:
Generated on Tue Oct 19 12:26:03 2004 for xmlwrapp by doxygen 1.3.6