xml::init Class Reference

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

#include <init.h>

Inheritance diagram for xml::init:

Static Public Member Functions
static 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. More...
static void	remove_whitespace (bool flag)
	This member function controls whether or not the XML parser should remove ignorable whitespace around XML elements. More...
static void	substitute_entities (bool flag)
	This member function controls whether or not the XML parser should substitute entities while parsing. More...
static void	load_external_subsets (bool flag)
	This member function controls whether or not the XML parser should load external (DTD) subsets while parsing. More...
static 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. More...

Detailed Description

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

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 and affect the behavior of subsequently created classes (and the parser in particular). In other words, this class is not thread safe.

Note

In xmlwrapp versions prior to 0.6.0, this class was used to initialize the library and exactly one instance had to be created before first use. This is no longer true: user code doesn't have to create any instances, but it can create as many instances as it wants.

Member Function Documentation

indent_output()

static void xml::init::indent_output ( bool  flag )

static

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 is true.

Parameters

flag	True to turn on indenting, false to turn it off.

load_external_subsets()

static void xml::init::load_external_subsets ( bool  flag )

static

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 is true.

Parameters

flag	True to turn on loading, false to turn it off.

remove_whitespace()

static void xml::init::remove_whitespace ( bool  flag )

static

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

The default is false.

Parameters

flag	True to remove whitespace, false to leave alone.

substitute_entities()

static void xml::init::substitute_entities ( bool  flag )

static

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

The default is true.

Parameters

flag	True to turn on substitution, false to turn off.

validate_xml()

static void xml::init::validate_xml ( bool  flag )

static

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

The default is false.

Returns

flag True to turn on validation, false to turn it off.

---

The documentation for this class was generated from the following file:

• xmlwrapp/init.h