Collapse all Symbian^3 Application Developer Library

MSvgLoadingListener Class Reference

class MSvgLoadingListener : public MSvgListener

This interface is the callback mechanism for the SVG Engine to communicate to interested clients about svg-file loading/parsing progress. The client (listener) is notified at the start and end of the document, at the start and end of an element.

The ReportAllElements method controls if all elements should be reported or only the direct children of the root <svg> element is reported.

Included in this interface are notifications for external data requests: when one is initiated, received or failed. External data requests include embedded images or svg-files.

SVGEngine.lib

Since: 3.1

Inherits from

MSvgLoadingListener
- MSvgListener

Public Member Functions
TBool	DocumentEnd ()
TBool	DocumentStart ()
TBool	ElementEnd (const TDesC &)
TBool	ElementStart (const TDesC &, MSvgAttributeList &)
TBool	ExternalDataReceived (const TDesC &)
TBool	ExternalDataRequestFailed (const TDesC &)
TBool	ExternalDataRequested (const TDesC &)
void	ImageDataReference (const TDesC &)
void	ImagesLoaded ( TInt )
TBool	ReportAllElements ()
TBool	UnsupportedElement (const TDesC &, MSvgAttributeList &)
TBool	WillAssignImageData ()

Member Functions Documentation

DocumentEnd()

TBool

DocumentEnd

(

)

[pure virtual]

Notified when the end of a svg document(</svg> tag) is encountered.

Since: 1.0

DocumentStart()

TBool

DocumentStart

(

)

[pure virtual]

Notified when the start of a svg document(<svg> tag) is encountered.

Since: 1.0

ElementEnd(const TDesC &)

TBool

ElementEnd

(

const TDesC &

aTagName

)

[pure virtual]

Notified when the end of a svg element is encountered. activated.

Since: 1.0

Parameters

const TDesC & aTagName

ElementStart(const TDesC &, MSvgAttributeList &)

TBool	ElementStart	(	const TDesC &	aTagName,
			MSvgAttributeList &	aAttributeList
		)	[pure virtual]

Notified when the start of a svg element is encountered.

Since: 1.0

Parameters

const TDesC & aTagName
MSvgAttributeList & aAttributeList

ExternalDataReceived(const TDesC &)

TBool

ExternalDataReceived

(

const TDesC &

aUri

)

[pure virtual]

Notified when an external data has been retrieved, such as a image-file or an embedded svg-file.

Since: 1.0

Parameters

const TDesC & aUri

ExternalDataRequestFailed(const TDesC &)

TBool

ExternalDataRequestFailed

(

const TDesC &

aUri

)

[pure virtual]

Notified when an external data request has failed.

Since: 1.0

Parameters

const TDesC & aUri

ExternalDataRequested(const TDesC &)

TBool

ExternalDataRequested

(

const TDesC &

aUri

)

[pure virtual]

Notified when an external data is needed by the svg document, such as a image-file or an embedded svg-file.

Since: 1.0

Parameters

const TDesC & aUri

ImageDataReference(const TDesC &)

void

ImageDataReference

(

const TDesC &

aUri

)

[pure virtual]

Callback when the href:xlink attribute is encountered for the <image> element. This method is used to notify clients of image data references needed by <image> element. This method is called only when 'WillAssignImageData' returns ETrue.

Since: 1.0

Parameters

const TDesC & aUri

ImagesLoaded(TInt)

void

ImagesLoaded

(

TInt

aError

)

[pure virtual]

Parameters

TInt aError

ReportAllElements()

TBool

ReportAllElements

(

)

[pure virtual]

Query the listener if every element is to be reported or only the children of <svg> tag.

Since: 1.0

UnsupportedElement(const TDesC &, MSvgAttributeList &)

TBool	UnsupportedElement	(	const TDesC &	aTagName,
			MSvgAttributeList &	aAttributeList
		)	[pure virtual]

Notified when an unsupported element is encountered.

Since: 1.0

Parameters

const TDesC & aTagName
MSvgAttributeList & aAttributeList

WillAssignImageData()

TBool

WillAssignImageData

(

)

[pure virtual]

Query the listener if client will call 'AssignImageData' to decode images separately from parsing. This is used to avoid non-thread-safe calls in creating bitmap and decoding images, which must be executed in the main thread.

Since: 1.0