XmlWriter.h

This HTML document was auto-generated from XmlWriter.h

Interface: XmlWriter

/*****************************************************************
Interface: XmlWriter
Desc:
This interface allows control over the serialization of an XML
document.
Notes: 
*****************************************************************/

Method: XmlWriter::write

//=========================================================================
// Method:	write
// Desc:	Serialize the XML data associated with the writer
// 
// Notes:	
//=========================================================================

C++ Signature

int
XmlWriter::write(
);


Method: XmlWriter::getWriteDeclaration

//=========================================================================
// Method:	getWriteDeclaration
// Desc:	Return non-zero if the XmlWriter will output an XML declaration
// 
// Notes:	
//=========================================================================

C++ Signature

int
XmlWriter::getWriteDeclaration(
);


Method: XmlWriter::setWriteDeclaration

//=========================================================================
// Method:	setWriteDeclaration
// Desc:	Set if XmlWriter should output an XML declaration
// 
// Notes:	
//=========================================================================

C++ Signature

void
XmlWriter::setWriteDeclaration(
	int writeDeclaration                            //non-zero if XML decl should be output
);


Method: XmlWriter::getEncoding

//=========================================================================
// Method:	getEncoding
// Desc:	Return string with name of character encoding to use, if available
// 
// Notes:	
//=========================================================================

C++ Signature

const unicode *
XmlWriter::getEncoding(
);


Method: XmlWriter::setEncoding

//=========================================================================
// Method:	setEncoding
// Desc:	Set the name of the character encoding to use, if available
// 
// Notes:	
//=========================================================================

C++ Signature

void
XmlWriter::setEncoding(
	const unicode * encoding                        
);


Method: XmlWriter::getEndian

//=========================================================================
// Method:	getEndian
// Desc:	Return non-zero if big-endian (Motorola) byte-ordering will
//			be used with encodings for which it matters (e.g., UTF-16). 
//			A return of zero means little-endian (Intel) ordering.
// 
// Notes:	
//=========================================================================

C++ Signature

int
XmlWriter::getEndian(
);


Method: XmlWriter::setEndian

//=========================================================================
// Method:	setEndian
// Desc:	Set the if big-endian (Motorola) byte-ordering or little-endian
//			(Intel) byte-ordering should be used for encodings for which
//			it matters (e.g., UTF-16)
// 
// Notes:	
//=========================================================================

C++ Signature

void
XmlWriter::setEndian(
	int endian                                      //non-zero for big-endian
);


Method: XmlWriter::getIndent

//=========================================================================
// Method:	getIndent
// Desc:	Return non-zero if extra whitespace will be output for
//			readability
// 
// Notes:	
//=========================================================================

C++ Signature

int
XmlWriter::getIndent(
);


Method: XmlWriter::setIndent

//=========================================================================
// Method:	setIndent
// Desc:	Set if extra whitespace may be output for readability
// 
// Notes:	
//=========================================================================

C++ Signature

void
XmlWriter::setIndent(
	int indent                                      //non-zero if extra whitespace may be output
);


Method: XmlWriter::getStandalone

//=========================================================================
// Method:	getStandalone
// Desc:	Return non-zero if a "standalone=yes" declaration will be output
//			in the XML decl, if one is output
// 
// Notes:	
//=========================================================================

C++ Signature

int
XmlWriter::getStandalone(
);


Method: XmlWriter::setStandalone

//=========================================================================
// Method:	setStandalone
// Desc:	Set if a "standalone=yes" declaration should be output in any
//			XML decl that is output.
// 
// Notes:	
//=========================================================================

C++ Signature

void
XmlWriter::setStandalone(
	int standalone                                  //non-zero for a "standalone=yes" decl
);


Method: XmlWriter::getDoctypePublic

//=========================================================================
// Method:	getDoctypePublic
// Desc:	Return the public id to use for the DOCTYPE, if any
// 
// Notes:	
//=========================================================================

C++ Signature

const unicode *
XmlWriter::getDoctypePublic(
);


Method: XmlWriter::setDoctypePublic

//=========================================================================
// Method:	setDoctypePublic
// Desc:	Set the public id to use for the DOCTYPE. 
// 
// Notes:	
//			The public id will only be used if there is also a system id.
//=========================================================================

C++ Signature

void
XmlWriter::setDoctypePublic(
	const unicode * doctypePublic                   //public id for the DOCTYPE (may be 0)
);


Method: XmlWriter::getDoctypeSystem

//=========================================================================
// Method:	getDoctypeSystem
// Desc:	Return the system id to use for the DOCTYPE, if any
// 
// Notes:
//			If the system id is non-null and non-empty, then a DOCTYPE
//			declaration will be output	
//=========================================================================

C++ Signature

const unicode *
XmlWriter::getDoctypeSystem(
);


Method: XmlWriter::setDoctypeSystem

//=========================================================================
// Method:	setDoctypeSystem
// Desc:	Set the system id to use for the DOCTYPE.
// 
// Notes:	
//			If the system id is non-null and non-empty, then a DOCTYPE
//			declaration will be output	
//=========================================================================

C++ Signature

void
XmlWriter::setDoctypeSystem(
	const unicode * doctypeSystem                   //system id for the DOCTYPE (may be 0)
);


Method: XmlWriter::getDisableTextEscaping

//=========================================================================
// Method:	getDisableTextEscaping
// Desc:	Return non-zero if XML text escaping is disabled for this
//			XmlWriter.
// 
// Notes:	
//			Disabling text escaping means that no character references or
//			entity references will be output for text nodes.
//=========================================================================

C++ Signature

int
XmlWriter::getDisableTextEscaping(
);


Method: XmlWriter::setDisableTextEscaping

//=========================================================================
// Method:	setDisableTextEscaping
// Desc:	Set if XML text escaping should be disabled for this XmlWriter
// 
// Notes:	
//			Disabling text escaping means that no character references or
//			entity references will be output for text nodes.
//=========================================================================

C++ Signature

void
XmlWriter::setDisableTextEscaping(
	int disableTextEscaping                         
);