Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

contenthandler.h File Reference

#include "xmlcpg.h"

Go to the source code of this file.

Typedefs

typedef void(* xmlcpgcharDataContentHandler )(const char *, int, int)
typedef void(* xmlcpgstartDocumentContentHandler )()
typedef void(* xmlcpgendDocumentContentHandler )()
typedef void(* xmlcpgstartElementContentHandler )(const char *, const char *, const char *, xmlcpgList *)
typedef void(* xmlcpgendElementContentHandler )(const char *, const char *, const char *)

Functions

void xmlcpgsetCharDataContentHandler (xmlcpgcharDataContentHandler handler)
 Sets the charData content handler.

void xmlcpgcallCharDataContentHandler (const char *ch, int start, int length)
 Receive notification of character data.

void xmlcpgsetDocumentContentHandler (xmlcpgstartDocumentContentHandler start, xmlcpgendDocumentContentHandler end)
 Sets the document content handlers.

void xmlcpgcallStartDocumentContentHandler ()
 Receive notification of the beginning of a document.

void xmlcpgcallEndDocumentContentHandler ()
 Receive notification of the end of a document.

void xmlcpgsetElementContentHandler (xmlcpgstartElementContentHandler start, xmlcpgendElementContentHandler end)
 Sets the element content handlers.

void xmlcpgcallStartElementContentHandler (const char *uri, const char *localName, const char *qName, xmlcpgList *atts)
 Receive notification of the beginning of an element.

void xmlcpgcallEndElementContentHandler (const char *uri, const char *localName, const char *qName)
 Receive notification of the end of an element.


Typedef Documentation

typedef void(* xmlcpgcharDataContentHandler)(const char*, int, int)
 

typedef void(* xmlcpgendDocumentContentHandler)()
 

typedef void(* xmlcpgendElementContentHandler)(const char*, const char*, const char*)
 

typedef void(* xmlcpgstartDocumentContentHandler)()
 

typedef void(* xmlcpgstartElementContentHandler)(const char*, const char*, const char*, xmlcpgList*)
 


Function Documentation

void xmlcpgcallCharDataContentHandler const char *    ch,
int    start,
int    length
 

Receive notification of character data.

The application must not attempt to read from the array outside of the specified range.

Parameters:
ch  the characters from the XML document.
start  the start position in the array.
length  the number of characters to read from the array.

void xmlcpgcallEndDocumentContentHandler  
 

Receive notification of the end of a document.

The parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

void xmlcpgcallEndElementContentHandler const char *    uri,
const char *    localName,
const char *    qName
 

Receive notification of the end of an element.

The parser will invoke this method at the end of every element in the XML document; there will be a corresponding xmlcpgstartElementContentHandler event for every xmlcpgendElementContentHandler event (even when the element is empty).

For information on the names, see xmlcpgstartElementContentHandler.

Parameters:
uri  the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
localName  the local name (without prefix), or the empty string if Namespace processing is not being performed.
qName  the qualified XML 1.0 name (with prefix), or the empty string if qualified names are not available.

void xmlcpgcallStartDocumentContentHandler  
 

Receive notification of the beginning of a document.

The parser will invoke this method only once, before any other event callbacks (except for setDocumentLocator).

void xmlcpgcallStartElementContentHandler const char *    uri,
const char *    localName,
const char *    qName,
xmlcpgList   atts
 

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding xmlcpgendElementContentHandler event for every xmlcpgstartElementContentHandler event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding xmlcpgendElementContentHandler event.

This event allows up to three name components for each element:

1. the Namespace URI; 2. the local name; and 3. the qualified (prefixed) name.

The Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be); the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default).

Parameters:
uri  the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
localName  the local name (without prefix), or the empty string if Namespace processing is not being performed.
qName  the qualified name (with prefix), or the empty string if qualified names are not available.
atts  the attributes attached to the element. If there are no attributes, it shall be an empty xmlcpgList object.

void xmlcpgsetCharDataContentHandler xmlcpgcharDataContentHandler    handler
 

Sets the charData content handler.

Parameters:
handler  the charData content handler.

void xmlcpgsetDocumentContentHandler xmlcpgstartDocumentContentHandler    start,
xmlcpgendDocumentContentHandler    end
 

Sets the document content handlers.

Parameters:
start  the start document content handler.
end  the end document content handler.

void xmlcpgsetElementContentHandler xmlcpgstartElementContentHandler    start,
xmlcpgendElementContentHandler    end
 

Sets the element content handlers.

Parameters:
start  the start element content handler.
end  the end element content handler.


Generated on Tue Nov 11 14:59:46 2003 for xmlcpg by doxygen1.2.18