CHLUserDictContentHandler Class Reference

Inheritance diagram for CHLUserDictContentHandler:

Public Member Functions
	CHLUserDictContentHandler (IPMUnknown *boss)
virtual void	StartDocument (ISAXServices *saxServices)
virtual void	EndDocument ()
virtual void	StartElement (const WideString &uri, const WideString &localname, const WideString &qname, ISAXAttributes *attrs)
virtual void	EndElement (const WideString &uri, const WideString &localname, const WideString &qname)
virtual void	Characters (const WideString &chars)
virtual void	ProcessingInstruction (const WideString &target, const WideString &data)
virtual void	StartPrefixMapping (const WideString &prefix, const WideString &uri)
virtual void	EndPrefixMapping (const WideString &prefix)
virtual void	IgnorableWhitespace (const WideString &chars)
virtual void	SkippedEntity (const WideString &name)
virtual void	ExtComment (const WideString &comment)
virtual void	ExtXMLDecl (const WideString &version, const WideString &encoding, const WideString &standalone, const WideString &actualEncoding)
Public Member Functions inherited from CSAXContentHandler
	CSAXContentHandler (IPMUnknown *boss)
virtual void	Register (ISAXServices *saxServices, IPMUnknown *importer=nil)
virtual bool16	HandlesSubElements () const
virtual void	SetDocumentLocator (ISAXLocator *locator)
virtual ISAXLocator *	GetDocumentLocator () const
Public Member Functions inherited from CPMUnknown< ISAXContentHandler >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Public Types inherited from ISAXContentHandler
enum	{ kDefaultIID = IID_ISAXCONTENTHANDLER }
Protected Member Functions inherited from CSAXContentHandler
bool16	HasAttribute (ISAXAttributes *attrs, const PMString &key)
bool16	HasAttribute (ISAXAttributes *attrs, const WideString &key)
PMString	GetAttributeString (ISAXAttributes *attrs, const PMString &key, const PMString &defaultValue="")
WideString	GetAttributeString (ISAXAttributes *attrs, const WideString &key, const WideString *defaultValue=nil)
bool16	GetAttributeBool (ISAXAttributes *attrs, const PMString &key, bool16 defaultValue=kFalse)
bool16	GetAttributeBool (ISAXAttributes *attrs, const WideString &key, bool16 defaultValue=kFalse)
int32	GetAttributeInt (ISAXAttributes *attrs, const PMString &key, int32 defaultValue=0)
int32	GetAttributeInt (ISAXAttributes *attrs, const WideString &key, int32 defaultValue=0)
Protected Attributes inherited from CPMUnknown< ISAXContentHandler >
HelperInterface	fHelperInterface

Detailed Description

Implements a sax content handler to read the user dictionary xml format.

Member Function Documentation

void CHLUserDictContentHandler::Characters ( const WideString &  chars )

virtual

Receives character data

The parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks. But all characters in any single event must come from the same external entity so the Locator provides useful information.

Note some parsers will report whitespace using the IgnorableWhitespace() method rather than this one (validating parsers must do so).

Parameters

Chars

The characters from the XML document.

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::EndDocument ( )

virtual

Receive end of document notification

The SAX 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.

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::EndElement ( const WideString &  uri, const WideString &  localname, const WideString &  qname  )

virtual

Receive end of element notification

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

Parameters

uri	The URI of the associated namespace for this element
localname	The local part of the element name
qname	The QName of this element

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::EndPrefixMapping ( const WideString &  prefix )

virtual

Receive end of namespace prefix mapping notification

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each namespace prefix mapping.

Parameters

prefix

The namespace prefix used

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::ExtComment ( const WideString &  comment )

virtual

(Extension) Receive a comment

The parser will invoke this method when it encounters a comment.

Parameters

comment

The interior text of the comment.

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::ExtXMLDecl ( const WideString &  version, const WideString &  encoding, const WideString &  standalone, const WideString &  actualEncoding  )

virtual

(Extension) Receive the XML declaration

The parser will invoke this method when it encounters a well-formed XML declaration. Any or all of these strings may be invalid, so check first before using them.

Parameters

version	The XML version
encoding	The encoding specified in the declaration
standalone	The value of the standalone indicator.
actualEncoding	The actual encoding detected by the parser

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::IgnorableWhitespace ( const WideString &  chars )

virtual

Receive ignorable whitespace in element content

Validating parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10). Non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks. But all characters in any single event must come from the same external entity so the Locator provides useful information.

Parameters

chars

The characters from the XML document.

See Also

Characters

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::ProcessingInstruction ( const WideString &  target, const WideString &  data  )

virtual

Receive a processing instruction

The parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Parameters

target	The processing instruction target
data	The processing instruction data, or null if none was supplied

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::SkippedEntity ( const WideString &  name )

virtual

Receive a skipped entity notification

The parser will invoke this method once for each entity skipped. All processors may skip external entities, depending on the values of the features:
http://xml.org/sax/features/external-general-entities
http://xml.org/sax/features/external-parameter-entities

Parameters

name	The name of the skipped entity. If it is a parameter entity, the name will begin with %, and if it is the external DTD subset, it will be the string [dtd].

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::StartDocument ( ISAXServices *  saxServices )

virtual

Receive the beginning of document notification

The SAX parser will invoke this method once before other methods in this interface or in DTDHandler (except for setDocumentLocator).

Parameters

saxServices

The instance of ISAXServices instantiated for this parse.

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::StartElement ( const WideString &  uri, const WideString &  localname, const WideString &  qname, ISAXAttributes *  attrs  )

virtual

Receive the beginning of element notification

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

Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.

Parameters

uri	The URI of the asscioated namespace for this element
localname	The local part of the element name
qname	The QName of this element
attrs	The attributes attached to the element, if any.

See Also

EndElement

ISAXAttributes

Reimplemented from CSAXContentHandler.

void CHLUserDictContentHandler::StartPrefixMapping ( const WideString &  prefix, const WideString &  uri  )

virtual

Receive start of namespace prefix mapping notification

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each namespace prefix mapping.

Parameters

prefix	The namespace prefix used
uri	The namespace URI used.

Reimplemented from CSAXContentHandler.