MSenContentHandlerClient Class Reference

Link against: SenXml.LIB

Capability Information

Required Capabilities

None

#include <MSenContentHandlerClient.h>

Inherited by CSenBaseFragment.

Detailed Description

Interface for SAX Parser Callback events.

If an application (client) needs to be informed of basic parsing events, it implements this interface and registers an instance with the SAX parser using the SetContentHandler() method. The parser uses the instance to report basic document-related events like the start and end of elements.*

Dll SenXML.dll
Since:
Series60 3.0

Public Member Functions

virtual TInt StartDocument ()=0
 Receive notification of the beginning of a document.
virtual TInt EndDocument ()=0
 Receive notification of the end of a document.
virtual TInt StartElement (const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
 Receive notification of the beginning of an element.
virtual TInt EndElement (const TDesC8 &, const TDesC8 &, const TDesC8 &)
 Receive notification of the end of an element.
virtual TInt Characters (const TDesC8 &, const TInt, const TInt)
 Receive notification of character data inside an element.
virtual TInt ProcessingInstructions (const TDesC8 &, const TDesC8 &)
 Receive notification of a processing instruction Called when OnProcessingInstructionL callback is received from Symbian XML framework.
virtual TInt SkippedEntity (const TDesC8 &)
 Receive notification of a skipped entity.
virtual TInt Error (TInt)
 Receive notification of error situation during parsing.
virtual TInt StartPrefixMappingL (const TDesC8 &, const TDesC8 &)
 Receive notification of prefix mapping start.
virtual TInt EndPrefixMappingL (const TDesC8 &)
 Receive notification of prefix mapping end.
virtual TInt OnIgnorableWhiteSpaceL (const TDesC8 &)
 Receive notification of ignorable whitespace in element content.
virtual TAny * GetExtendedInterface (const TInt32)
 Method obtains the interface matching the specified UID.

Member Function Documentation

virtual TInt MSenContentHandlerClient::Characters ( const TDesC8 & ,
const TInt ,
const TInt 
)  [inline, virtual]
 

Receive notification of character data inside an element.

Called when OnContentL callback is received from Symbian XML framework.

Parameters:
aBuff,: The characters.
aStart,: The start position in the character buffer.
aLength,: The number of characters to use from the character buffer.
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::EndDocument (   )  [pure virtual]
 

Receive notification of the end of a document.

Called when OnEndDocumentL callback is received from Symbian XML framework.

Returns:
KErrNone or some of the system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::EndElement ( const TDesC8 & ,
const TDesC8 & ,
const TDesC8 & 
)  [inline, virtual]
 

Receive notification of the end of an element.

Called when OnEndElementL callback is received from Symbian XML framework.

Parameters:
aURI,: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
aLocalName,: The local name (without prefix)
aName,: The qualified name
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::EndPrefixMappingL ( const TDesC8 &   )  [inline, virtual]
 

Receive notification of prefix mapping end.

Called when OnEndPrefixMappingL callback is received from Symbian XML framework.

Parameters:
aPrefix,: The prefix
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::Error ( TInt   )  [inline, virtual]
 

Receive notification of error situation during parsing.

Called when OnError callback is received from Symbian XML framework. Complete list of error codes is listed under <Xml.h>

Parameters:
aErrorCode,: Error status code.
aSeverity,: Error Severity.
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
virtual TAny* MSenContentHandlerClient::GetExtendedInterface ( const   TInt32  )  [inline, virtual]
 

Method obtains the interface matching the specified UID.

Parameters:
aUid the UID identifying the required interface.
Returns:
NULL if no interface matching the UID is found or method is not overridden in the implementing class. Otherwise, the this pointer cast to that interface.
virtual TInt MSenContentHandlerClient::OnIgnorableWhiteSpaceL ( const TDesC8 &   )  [inline, virtual]
 

Receive notification of ignorable whitespace in element content.

Called when OnIgnorableWhiteSpaceL callback is received from Symbian XML framework.

Parameters:
aBytes,: The whitespace characters.
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::ProcessingInstructions ( const TDesC8 & ,
const TDesC8 & 
)  [inline, virtual]
 

Receive notification of a processing instruction Called when OnProcessingInstructionL callback is received from Symbian XML framework.

This method is currently not in use - inlined.

Parameters:
aTarget,: The processing instruction target.
aData,: The processing instruction data, or null if none is supplied.
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::SkippedEntity ( const TDesC8 &   )  [inline, virtual]
 

Receive notification of a skipped entity.

Called when OnSkippedEntityL callback is received from Symbian XML framework.

Parameters:
aName,: The name of the skipped entity.
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::StartDocument (   )  [pure virtual]
 

Receive notification of the beginning of a document.

Called when OnStartDocumentL callback is received from Symbian XML framework.

Returns:
KErrNone or some of the system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::StartElement ( const TDesC8 & ,
const TDesC8 & ,
const TDesC8 & ,
const RAttributeArray & 
)  [inline, virtual]
 

Receive notification of the beginning of an element.

Called when OnStartElementL callback is received from Symbian XML framework.

Parameters:
aURI,: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
aLocalName,: The local name (without prefix)
aName,: The qualified name
apAttrs,: The attributes attached to the element. If there are no attributes, it shall be an empty array. Namespaces declared in the current element will be located in the array also.
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
virtual TInt MSenContentHandlerClient::StartPrefixMappingL ( const TDesC8 & ,
const TDesC8 & 
)  [inline, virtual]
 

Receive notification of prefix mapping start.

Called when OnStartPrefixMappingL callback is received from Symbian XML framework.

Parameters:
aPrefix,: The prefix
aUri,: The URI mapped to the prefix.
Returns:
KErrNotSupported If the class implementing this interface doesn't override this. KErrNone or other system-wide Symbian error codes.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top