Symbian^3 Application Developer Library >

CSvgDocumentImpl Class Reference

class CSvgDocumentImpl : public CBase

An SVG document that represents a SVG element tree..

Inherits from

Public Member Functions
~CSvgDocumentImpl ()
void AddEventBeginTime ( MSvgEventReceiver *, TUint32 , MSvgEventReceiver *)
void AddInternalMouseListener (const MSvgMouseListener *)
void AddToEventReceiverListL ( MSvgEventReceiver *, TUint8 )
void AddToEventReceiverListL ( MSvgEventReceiver *, TSvgEvent , TUint8 )
TUint32 AnimationDuration ()
MXmlElement * AppendChildL ( MXmlElement *)
void CancelParsing ()
TInt CreateAttribute (const TDesC &)
MXmlElement * CreateElementL (const TDesC &)
MXmlElement * CreateElementL (const TUint8 )
TInt32 CurrentTime ()
TInt32 DecCurFocusIndex ()
void DocumentTransform ( TGfxAffineTransform &)
void ElementAppendedOrRemoved ()
CSvgEngineImpl * Engine ()
void FindAllElements ( CSvgElementImpl *, TInt , RPointerArray < CSvgElementImpl > &, TSvgSearchFlags )
void FindAllIds ( CSvgElementImpl *, RPointerArray < TDesC > &)
CSvgBitmapFontProvider * GetBitmapFontProvider ()
TInt32 GetCurFocusIndex ()
CSvgElementImpl * GetCurFocusObject ()
TGfxAffineTransform GetDocumentTransform ()
MXmlElement * GetElementById (const TDesC &)
MSvgError * GetError ()
CSvgElementImpl * GetEventReceiverElement ( TInt32 , TBool , TUint8 , TInt32 &)
CXmlElementImpl * GetFocusElement ()
TDesC * GetId ( TInt )
TInt GetImageElementsCount ()
const RPointerArray < MSvgLoadingListener > * GetLoadingListeners ()
TInt GetNumberOfIds ( MXmlElement *)
void GetUri ( TDes &)
TDesC & GetUrl ()
TBool HasError ()
void ImageLoadingCompleted ( TInt )
TInt32 IncCurFocusIndex ()
TBool IsAnimationFile ()
TBool IsDocumentContentInteractive ()
TUint32 IsIndefiniteAnimation ()
TBool IsParsing ()
TBool IsThumbNailOnly ()
TBool IsValidSubEventMask ( TUint16 )
void Load (const TDesC &, CSvgErrorImpl &)
void Load (const TDesC8 &, CSvgErrorImpl &, TBool )
void Load ( RFile &, CSvgErrorImpl &)
void Load16BitString (const TDesC16 &, CSvgErrorImpl &, TBool )
TInt MouseInternalListenerCount ()
CSvgDocumentImpl * NewL ( CSvgBitmapFontProvider *, const TBool , const TSvgSyncBehaviour , const TInt32 )
CSvgDocumentImpl * NewLC ( CSvgBitmapFontProvider *, const TBool , const TSvgSyncBehaviour , const TInt32 )
void NotifyDocumentEnd ()
void NotifyDocumentStart ()
void NotifyElementEnd (const TDesC &, TBool )
void NotifyElementStart (const TDesC &, MSvgAttributeList &, TBool )
void NotifyExternalDataReceived (const TDesC &)
void NotifyExternalDataRequestFailed (const TDesC &)
void NotifyExternalDataRequested (const TDesC &)
void NotifyInternalMouseEntered ( RPointerArray < CSvgElementImpl > &, TInt , TInt )
void NotifyInternalMouseExited ( RPointerArray < CSvgElementImpl > &, TInt , TInt )
void NotifyInternalMouseMoved ( RPointerArray < CSvgElementImpl > &, TInt , TInt )
void NotifyInternalMousePressed ( RPointerArray < CSvgElementImpl > &, TInt , TInt )
void NotifyInternalMouseReleased ( RPointerArray < CSvgElementImpl > &, TInt , TInt )
void NotifyUnsupportedElement (const TDesC &, MSvgAttributeList &)
TSvgObjectType ObjectType ()
void OpenSession ( RFs &, CSvgErrorImpl &)
void ParsePostOrderMediaElements ( CSvgElementImpl *, RPointerArray < CSvgElementImpl > &)
void PrepareError ( CSvgErrorImpl &, TSvgErrorCode , TInt , const TDesC &, const TDesC &)
void PrintAllElements ( CSvgElementImpl *)
void QueueFontReleaseReq ( CFont *)
void ReInitialize ()
void RemoveFromEventReceiverList ( MSvgEventReceiver *)
void RemoveInternalMouseListener (const MSvgMouseListener *)
void Reset ( MSvgEvent *)
IMPORT_C MXmlElement * RootElement ()
CSvgSchemaData * SchemaData ()
TBool SearchByPointer ( CSvgElementImpl *, CSvgElementImpl *)
void SetCurFocusIndex ( TInt32 )
void SetCurFocusObject ( CSvgElementImpl *)
void SetCurrentTime (const TInt32 )
void SetDRMMode ( TBool )
void SetDRMRights ( TBool )
void SetEngine ( CSvgEngineImpl *)
void SetError ( TInt , const TDesC &, const TDesC &)
void SetFocusElement ( CXmlElementImpl *)
void SetImageElementsCount ( TInt )
void SetIsWarning ( TBool )
void SetLoadingListeners (const RPointerArray < MSvgLoadingListener > *)
void SetTCSyncBehavior (const TSvgSyncBehaviour )
void SetTCSyncMaster (const TBool )
void SetTCSyncTolerance (const TUint32 )
void SetThumbNailMode ( TBool )
void SetUri (const TDesC &)
void SetWasPrepared ( TBool )
void SortEventList ()
TBool SvgElementPresent ( CSvgElementImpl *)
TBool SvgHasAnimationElement ()
TSvgSyncBehaviour SyncBehaviorDefault ()
TUint32 SyncToleranceDefault ()
CSvgTimeContainer * TimeContainer ()
TBool WasPrepared ()
TBool isGroupOpacity ( CSvgElementImpl *)
Private Member Functions
CSvgDocumentImpl ( CSvgBitmapFontProvider *, const TBool , const TSvgSyncBehaviour , const TInt32 )
TBool CanGenerateTick ()
TBool CanUseParentTick ()
void ConstructL ()
TInt CreateProcessPrivateDirectory ( RFs &, TFileName &)
CSvgTimeContainer * GetChildTimeContainer ()
void GetCnfSyncMasterStatus ( TBool &)
void GetCurSyncMasterStatus ( TBool &)
void GetEntityCurrentTime ( TUint32 &)
TSvgSyncBehaviour GetEntitySyncBehavior ()
TInt GetProcessPrivatePath ( RFs &, TFileName &)
TBool IsBinarySvg (const TDesC8 &)
TBool IsDRMContent ( RFile &)
TBool IsDRMContent (const TDesC8 &)
TBool IsGzipContent ( RFile &)
TBool IsGzipContent (const TDesC8 &)
void Load ( RFs &, RFile &, CSvgErrorImpl &)
void LoadingCompleted ()
void ParentTimeContainerTick ( TSvgTick )
void PauseTimedEntity ()
void Process16BitSvgContentL (const TDesC16 &, CSvgErrorImpl &, TBool )
HBufC8 * ProcessDRMContentL ( RFile &, CSvgErrorImpl &)
void ProcessDRMError ( TInt , CSvgErrorImpl &)
TBool ProcessGZipContent ( RFs &, RFile &, TFileName &, CSvgErrorImpl &)
TBool ProcessGZipContent ( RFs &, TFileName &, TFileName &, CSvgErrorImpl &)
void ProcessSvgContentL (const TDesC8 &, CSvgErrorImpl &, TBool )
void ResumeTimedEntity ()
void ResyncTimedEntity ( TUint32 )
MXmlElement * SearchElementById ( MXmlElement *, const TDesC &)
void SetCurSyncMasterStatus ( TBool )
void StopTimedEntity ()
TUint32 SubtreeDuration ( CSvgElementImpl *)
TInt WriteToTempFile ( RFs &, const TDesC8 &, TFileName &, CSvgErrorImpl &)
TInt WriteToTempFile ( RFs &, RFile &, TFileName &, CSvgErrorImpl &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Attributes
TBool iAnimationResetNeeded
CSvgEventHandler * iEventHandler
TBool iFinishedParsing
CSvgFontHashMap * iFontHashMap
TBool iHasGroupOpacity
TInt iImageElementCnt
TBool iInitSortList
TBool iInitialDrawFlag
TBool iIsInteractive
TBool iIsPruningTree
TBool iIsRendering
CSvgMemoryManager * iMemoryManager
CSvgElementImpl * iPerfText
TBool iReqExReqFtrSysLTested
RPointerArray < CSvgAnimationBase > iSvgAnimations
TUint32 iTimeForJSR226
Private Attributes
const TInt KIndefiniteAnimationDuration
TUint iAnimationDuration
TBool iCheckedAnimationDuration
TInt32 iCurObjIdx
CSvgElementImpl * iCurrentFocusObject
TBool iDrmEnable
TBool iDrmRightsConsumptionEnabled
CSvgEngineImpl * iEngine
CSvgErrorImpl * iError
TBool iHasGradientElement
TBool iHasParent
TBool iIsDRMProtected
TBool iIsThumbNailMode
const RPointerArray < MSvgLoadingListener > * iLoadingListeners
TBool iMultipleRendering
CSvgElementImpl * iRootElement
CSvgSchemaData * iSchemaData
CSvgBitmapFontProvider * iSvgBitmapFontProvider
RPointerArray < MSvgMouseListener > iSvgMouseListeners
TSvgSyncBehaviour iSyncBehaviorDefault
TUint32 iSyncToleranceDefault
CSvgTimeContainer * iTimeContainer
TGfxAffineTransform iTransformMatrix
TBuf < 256 > iUri
TBool iWasPrepared
CSvgContentHandler * iXmlHandler

Constructor & Destructor Documentation

CSvgDocumentImpl(CSvgBitmapFontProvider *, const TBool, const TSvgSyncBehaviour, const TInt32)

CSvgDocumentImpl ( CSvgBitmapFontProvider * aSvgBitmapFontProvider,
const TBool aHasParent,
const TSvgSyncBehaviour aSyncBehavDefault,
const TInt32 aSyncTolDefault
) [private]

Constructor

Parameters

CSvgBitmapFontProvider * aSvgBitmapFontProvider
const TBool aHasParent - Indicates whether document has a parent or not aSyncBehavDefault - Indicates default synchronised behaviour for runtime synchronisation. aSyncTolDefault - Indicates the synchronised tolerance in msecs for runtime synchronisation.
const TSvgSyncBehaviour aSyncBehavDefault
const TInt32 aSyncTolDefault

~CSvgDocumentImpl()

~CSvgDocumentImpl ( ) [virtual]

Need method description

Since
1.0

Member Functions Documentation

AddEventBeginTime(MSvgEventReceiver *, TUint32, MSvgEventReceiver *)

void AddEventBeginTime ( MSvgEventReceiver * aElement,
TUint32 aTime,
MSvgEventReceiver * aTargetElement
)

Provide the event end time information to the Event Handler

Since
1.0

Parameters

MSvgEventReceiver * aElement - An element that, ultimately, processes the event (eg. an animation element)
TUint32 aTime - The end time for an event on the target element
MSvgEventReceiver * aTargetElement - The element for which the event is processed

AddInternalMouseListener(const MSvgMouseListener *)

void AddInternalMouseListener ( const MSvgMouseListener * aListener )

Add a MSvgMouseListener to this SvgEngine

Parameters

const MSvgMouseListener * aListener

AddToEventReceiverListL(MSvgEventReceiver *, TUint8)

void AddToEventReceiverListL ( MSvgEventReceiver * aElement,
TUint8 aEventMask
)

Add an object to the list of objects that are notified of an event

Since
1.0

Parameters

MSvgEventReceiver * aElement - An SVG element that wants to be registered for an event (implements MSvgEventReceiver interface)
TUint8 aEventMask - A bit mask that indicates the types of events an object listens for

AddToEventReceiverListL(MSvgEventReceiver *, TSvgEvent, TUint8)

void AddToEventReceiverListL ( MSvgEventReceiver * aElement,
TSvgEvent aEvent,
TUint8 aEventMask
)

Add an object to the list of objects that are notified of an event Has an additional parameter aEvent which is used to check for interactive events

Since
v3.2

Parameters

MSvgEventReceiver * aElement - An SVG element that wants to be registered for an event (implements MSvgEventReceiver interface)
TSvgEvent aEvent - An SVG Event that the target element needs to generate
TUint8 aEventMask - A bit mask that indicates the types of events an object listens for

AnimationDuration()

TUint32 AnimationDuration ( )

return the animation duration in milliseconds.

AppendChildL(MXmlElement *)

MXmlElement * AppendChildL ( MXmlElement * aAppendChild )

Need method description

Since
1.0

Parameters

MXmlElement * aAppendChild

CanGenerateTick()

TBool CanGenerateTick ( ) [private]
From MSvgTimedEntityInterface Check if timed entity can provide timing ticks to rest of time container elements. This behavior could change dynamically. For example, if audio clip is over, the audio element can't generate ticks for others.
Since
Series 3.2

CanUseParentTick()

TBool CanUseParentTick ( ) [private]
Check if timed entity can use its parent's tick. Usually only the parent document should return true for this function. All other elements return false
Since
Series 3.2

CancelParsing()

void CancelParsing ( )

Cancel loading of document if it is currently parsing.

ConstructL()

void ConstructL ( ) [private]

2-phase construction

CreateAttribute(const TDesC &)

TInt CreateAttribute ( const TDesC & aName )

Need method description

Since
1.0

Parameters

const TDesC & aName

CreateElementL(const TDesC &)

MXmlElement * CreateElementL ( const TDesC & aTagName )

Need method description

Since
1.0

Parameters

const TDesC & aTagName

CreateElementL(const TUint8)

MXmlElement * CreateElementL ( const TUint8 aTagName )

Parameters

const TUint8 aTagName

CreateProcessPrivateDirectory(RFs &, TFileName &)

TInt CreateProcessPrivateDirectory ( RFs & aSession,
TFileName & aPath
) [private]

Parameters

RFs & aSession
TFileName & aPath

CurrentTime()

TInt32 CurrentTime ( )
Accessor Function for the document's current time
Since
S60 3.2

DecCurFocusIndex()

TInt32 DecCurFocusIndex ( )

DocumentTransform(TGfxAffineTransform &)

void DocumentTransform ( TGfxAffineTransform & aTr )

Parameters

TGfxAffineTransform & aTr

ElementAppendedOrRemoved()

void ElementAppendedOrRemoved ( )

Called by AppendChild/RemoveChild to notify owner document of changes.

Engine()

CSvgEngineImpl * Engine ( )

Need method description

Since
1.0

FindAllElements(CSvgElementImpl *, TInt, RPointerArray< CSvgElementImpl > &, TSvgSearchFlags)

void FindAllElements ( CSvgElementImpl * aStartElement,
TInt aElementId,
RPointerArray < CSvgElementImpl > & aList,
TSvgSearchFlags aFlags = ESvgSearchAllElements
)

Parameters

CSvgElementImpl * aStartElement
TInt aElementId
RPointerArray < CSvgElementImpl > & aList
TSvgSearchFlags aFlags = ESvgSearchAllElements

FindAllIds(CSvgElementImpl *, RPointerArray< TDesC > &)

void FindAllIds ( CSvgElementImpl * aStartElement,
RPointerArray < TDesC > & aList
)

Need method description

Since
1.0

Parameters

CSvgElementImpl * aStartElement
RPointerArray < TDesC > & aList

GetBitmapFontProvider()

CSvgBitmapFontProvider * GetBitmapFontProvider ( )

GetChildTimeContainer()

CSvgTimeContainer * GetChildTimeContainer ( ) [private]

GetCnfSyncMasterStatus(TBool &)

void GetCnfSyncMasterStatus ( TBool & aIsSyncMaster ) [private]
From MSvgTimedEntityInterface Returns the configured sync master value(as per DOM tree) as specified in the SVG content.
Since
Series 3.2

Parameters

TBool & aIsSyncMaster Indicates whether the element is configured as Sync Master.

GetCurFocusIndex()

TInt32 GetCurFocusIndex ( )

GetCurFocusObject()

CSvgElementImpl * GetCurFocusObject ( )

GetCurSyncMasterStatus(TBool &)

void GetCurSyncMasterStatus ( TBool & isSyncMaster ) [private]
From MSvgTimedEntityInterface Check if timed entity is going to act as timing master in the time container. This behavior could change dynamically.
Since
Series 3.2

Parameters

TBool & isSyncMaster

GetDocumentTransform()

TGfxAffineTransform GetDocumentTransform ( )

GetElementById(const TDesC &)

MXmlElement * GetElementById ( const TDesC & aElementId )

Need method description

Since
1.0

Parameters

const TDesC & aElementId

GetEntityCurrentTime(TUint32 &)

void GetEntityCurrentTime ( TUint32 & aEntityCurTime ) [private]
From MSvgTimedEntityInterface When the timed entity acts as timing master in the time container, the time container gets the timed entity clock using this method and feeds to rest of timed entities.
Since
Series 3.2

Parameters

TUint32 & aEntityCurTime Current Entity Time in msecs.

GetEntitySyncBehavior()

TSvgSyncBehaviour GetEntitySyncBehavior ( ) [private]
From MSvgTimedEntityInterface Returns the sync behavior of the entity.
Since
Series 3.2

GetError()

MSvgError * GetError ( )

return the error reference. May be NULL. Call HasError first.

GetEventReceiverElement(TInt32, TBool, TUint8, TInt32 &)

CSvgElementImpl * GetEventReceiverElement ( TInt32 aIndex,
TBool aNext,
TUint8 aEventMask,
TInt32 & aNewIndex
)

returns the next (or prev) focussable object starting with a given index

Since
1.0

Parameters

TInt32 aIndex - search for a focussable object with this index
TBool aNext - Etrue (next) EFalse (prev) (go forward or backward for search)
TUint8 aEventMask - Event mask for event types the client is interested in
TInt32 & aNewIndex - Return the actual index where the object was found

GetFocusElement()

CXmlElementImpl * GetFocusElement ( )

GetId(TInt)

TDesC * GetId ( TInt index )

Need method description

Since
1.0

Parameters

TInt index

GetImageElementsCount()

TInt GetImageElementsCount ( )

GetLoadingListeners()

const RPointerArray < MSvgLoadingListener > * GetLoadingListeners ( )

Set the list of MSvgLoadingListener for this document to send back notification of parsing progress. NULL is also valid.

GetNumberOfIds(MXmlElement *)

TInt GetNumberOfIds ( MXmlElement * aElement )

Need method description

Since
1.0

Parameters

MXmlElement * aElement

GetProcessPrivatePath(RFs &, TFileName &)

TInt GetProcessPrivatePath ( RFs & aSession,
TFileName & aPath
) [private]

Parameters

RFs & aSession
TFileName & aPath

GetUri(TDes &)

void GetUri ( TDes & aUri )

Need method description

Since
1.0

Parameters

TDes & aUri

GetUrl()

TDesC & GetUrl ( )

Need method description

Since
1.0

HasError()

TBool HasError ( )

return whether this document has an error set.

ImageLoadingCompleted(TInt)

void ImageLoadingCompleted ( TInt aErrorStatus ) [virtual]

ImageLoadingObserver interface method. Called from Image loading class to notify image loading completion.

Since
1.0

Parameters

TInt aErrorStatus

IncCurFocusIndex()

TInt32 IncCurFocusIndex ( )

IsAnimationFile()

TBool IsAnimationFile ( )

Checks whether the current loaded file is animatable or static

IsBinarySvg(const TDesC8 &)

TBool IsBinarySvg ( const TDesC8 & aByteArray ) [private]

Parameters

const TDesC8 & aByteArray

IsDRMContent(RFile &)

TBool IsDRMContent ( RFile & aFileHandle ) [private]

Parameters

RFile & aFileHandle

IsDRMContent(const TDesC8 &)

TBool IsDRMContent ( const TDesC8 & aByteData ) [private]

Parameters

const TDesC8 & aByteData

IsDocumentContentInteractive()

TBool IsDocumentContentInteractive ( )

Finds if Document content is Interactive

Since
Series 3.2

IsGzipContent(RFile &)

TBool IsGzipContent ( RFile & aFile ) [private]

Parameters

RFile & aFile

IsGzipContent(const TDesC8 &)

TBool IsGzipContent ( const TDesC8 & aByteArray ) [private]

Parameters

const TDesC8 & aByteArray

IsIndefiniteAnimation()

TUint32 IsIndefiniteAnimation ( )

return wether animation is indefinite.

IsParsing()

TBool IsParsing ( )

Return whether document is currently parsing.

IsThumbNailOnly()

TBool IsThumbNailOnly ( )

Return whether the loaded document is a thumbnail only. ETrue is returned only when the loaded content is DRM protected AND SetThumbNailMode is called with ETrue.

IsValidSubEventMask(TUint16)

TBool IsValidSubEventMask ( TUint16 aSubEventMask )
Checks whether the aSubEventMask is has a valid value set
Since
v3.2

Parameters

TUint16 aSubEventMask

Load(const TDesC &, CSvgErrorImpl &)

void Load ( const TDesC & aFileName,
CSvgErrorImpl & aError
)

Load a svg content from the given filename

Parameters

const TDesC & aFileName
CSvgErrorImpl & aError

Load(const TDesC8 &, CSvgErrorImpl &, TBool)

void Load ( const TDesC8 & aByteData,
CSvgErrorImpl & aError,
TBool aRemoveFalseSwitchElements = ETrue
)

Load a svg content from the given byte-array

Parameters

const TDesC8 & aByteData
CSvgErrorImpl & aError
TBool aRemoveFalseSwitchElements = ETrue

Load(RFile &, CSvgErrorImpl &)

void Load ( RFile & aFileHandle,
CSvgErrorImpl & aError
)

Load a svg content from the given file-handle

Parameters

RFile & aFileHandle
CSvgErrorImpl & aError

Load(RFs &, RFile &, CSvgErrorImpl &)

void Load ( RFs & aSession,
RFile & aFileHandle,
CSvgErrorImpl & aError
) [private]

Parameters

RFs & aSession
RFile & aFileHandle
CSvgErrorImpl & aError

Load16BitString(const TDesC16 &, CSvgErrorImpl &, TBool)

void Load16BitString ( const TDesC16 & aSvgString,
CSvgErrorImpl & aError,
TBool aRemoveFalseSwitchElements = ETrue
)

Load a svg content from JSR226 that is already TDesc16

Parameters

const TDesC16 & aSvgString
CSvgErrorImpl & aError
TBool aRemoveFalseSwitchElements = ETrue

LoadingCompleted()

void LoadingCompleted ( ) [private]

MouseInternalListenerCount()

TInt MouseInternalListenerCount ( )

Return number of mouselisteners.

NewL(CSvgBitmapFontProvider *, const TBool, const TSvgSyncBehaviour, const TInt32)

CSvgDocumentImpl * NewL ( CSvgBitmapFontProvider * aSvgBitmapFontProvider,
const TBool aHasParent = EFalse,
const TSvgSyncBehaviour aSyncBehavDefault =  KSvgDefaultSyncBehaviour ,
const TInt32 aSyncTolDefault =  KSvgDefaultSyncTolerance
) [static]

Parameters

CSvgBitmapFontProvider * aSvgBitmapFontProvider
const TBool aHasParent = EFalse
const TSvgSyncBehaviour aSyncBehavDefault =  KSvgDefaultSyncBehaviour
const TInt32 aSyncTolDefault =  KSvgDefaultSyncTolerance

NewLC(CSvgBitmapFontProvider *, const TBool, const TSvgSyncBehaviour, const TInt32)

CSvgDocumentImpl * NewLC ( CSvgBitmapFontProvider * aSvgBitmapFontProvider,
const TBool aHasParent = EFalse,
const TSvgSyncBehaviour aSyncBehavDefault =  KSvgDefaultSyncBehaviour ,
const TInt32 aSyncTolDefault =  KSvgDefaultSyncTolerance
) [static]

Need method description

Since
1.0

Parameters

CSvgBitmapFontProvider * aSvgBitmapFontProvider
const TBool aHasParent = EFalse - Indicates whether document has a parent document or not aSyncBehavDefault - Indicates default synchronised behaviour for runtime synchronisation. aSyncTolDefault - Indicates the synchronised tolerance in msecs for runtime synchronisation.
const TSvgSyncBehaviour aSyncBehavDefault =  KSvgDefaultSyncBehaviour
const TInt32 aSyncTolDefault =  KSvgDefaultSyncTolerance

NotifyDocumentEnd()

void NotifyDocumentEnd ( )

Send to loading listeners of a document end event.

NotifyDocumentStart()

void NotifyDocumentStart ( )

Send to loading listeners of a document start event.

NotifyElementEnd(const TDesC &, TBool)

void NotifyElementEnd ( const TDesC & aTagName,
TBool aIsSvgChild
)

Send to loading listeners of an element end event.

Parameters

const TDesC & aTagName
TBool aIsSvgChild

NotifyElementStart(const TDesC &, MSvgAttributeList &, TBool)

void NotifyElementStart ( const TDesC & aTagName,
MSvgAttributeList & aAttributeList,
TBool aIsSvgChild
)

Send to loading listeners of an element start event.

Parameters

const TDesC & aTagName
MSvgAttributeList & aAttributeList
TBool aIsSvgChild

NotifyExternalDataReceived(const TDesC &)

void NotifyExternalDataReceived ( const TDesC & aUri )

Send to loading listeners of a succesfful external data reception.

Parameters

const TDesC & aUri

NotifyExternalDataRequestFailed(const TDesC &)

void NotifyExternalDataRequestFailed ( const TDesC & aUri )

Send to loading listeners of a failed external data request.

Parameters

const TDesC & aUri

NotifyExternalDataRequested(const TDesC &)

void NotifyExternalDataRequested ( const TDesC & aUri )

Send to loading listeners of an external data request.

Parameters

const TDesC & aUri

NotifyInternalMouseEntered(RPointerArray< CSvgElementImpl > &, TInt, TInt)

void NotifyInternalMouseEntered ( RPointerArray < CSvgElementImpl > & aElements,
TInt aX,
TInt aY
)

Send to mouse listeners of a mouse-entered event.

Parameters

RPointerArray < CSvgElementImpl > & aElements
TInt aX
TInt aY

NotifyInternalMouseExited(RPointerArray< CSvgElementImpl > &, TInt, TInt)

void NotifyInternalMouseExited ( RPointerArray < CSvgElementImpl > & aElements,
TInt aX,
TInt aY
)

Send to mouse listeners of a mouse-exited event.

Parameters

RPointerArray < CSvgElementImpl > & aElements
TInt aX
TInt aY

NotifyInternalMouseMoved(RPointerArray< CSvgElementImpl > &, TInt, TInt)

void NotifyInternalMouseMoved ( RPointerArray < CSvgElementImpl > & aElements,
TInt aX,
TInt aY
)

Send to mouse listeners of a mouse-moved event.

Parameters

RPointerArray < CSvgElementImpl > & aElements
TInt aX
TInt aY

NotifyInternalMousePressed(RPointerArray< CSvgElementImpl > &, TInt, TInt)

void NotifyInternalMousePressed ( RPointerArray < CSvgElementImpl > & aElements,
TInt aX,
TInt aY
)

Send to mouse listeners of a mouse-pressed event.

Parameters

RPointerArray < CSvgElementImpl > & aElements
TInt aX
TInt aY

NotifyInternalMouseReleased(RPointerArray< CSvgElementImpl > &, TInt, TInt)

void NotifyInternalMouseReleased ( RPointerArray < CSvgElementImpl > & aElements,
TInt aX,
TInt aY
)

Send to mouse listeners of a mouse-released event.

Parameters

RPointerArray < CSvgElementImpl > & aElements
TInt aX
TInt aY

NotifyUnsupportedElement(const TDesC &, MSvgAttributeList &)

void NotifyUnsupportedElement ( const TDesC & aTagName,
MSvgAttributeList & aAttributeList
)

Send to loading listeners of an unsupported element event.

Parameters

const TDesC & aTagName
MSvgAttributeList & aAttributeList

ObjectType()

TSvgObjectType ObjectType ( )

OpenSession(RFs &, CSvgErrorImpl &)

void OpenSession ( RFs & aSession,
CSvgErrorImpl & aError
) [static]

Parameters

RFs & aSession
CSvgErrorImpl & aError

ParentTimeContainerTick(TSvgTick)

void ParentTimeContainerTick ( TSvgTick aTick ) [private]
From MSvgTimedEntityInterface The parent time container provides the timing clock to the timed entity (audio, video, animation, document) using this routine.
Since
Series 3.2

Parameters

TSvgTick aTick Current tick information

ParsePostOrderMediaElements(CSvgElementImpl *, RPointerArray< CSvgElementImpl > &)

void ParsePostOrderMediaElements ( CSvgElementImpl * aRoot,
RPointerArray < CSvgElementImpl > & aPostOrderList
)
Prepare a list of media elements in DOM tree in postorder
Since
Series 3.2

Parameters

CSvgElementImpl * aRoot Root Node of tree
RPointerArray < CSvgElementImpl > & aPostOrderList List of nodes which will contain the elements.

PauseTimedEntity()

void PauseTimedEntity ( ) [private]
From MSvgTimedEntityInterface This would be used for pausing the timed entity while other locked timed entities get loaded.
Since
S60 3.2

PrepareError(CSvgErrorImpl &, TSvgErrorCode, TInt, const TDesC &, const TDesC &)

void PrepareError ( CSvgErrorImpl & aError,
TSvgErrorCode aSvgErrorCode,
TInt aSystemError,
const TDesC & aMsg1,
const TDesC & aMsg2
) [static]

Fill the given error object with the appropriate error codes, messages.

Parameters

CSvgErrorImpl & aError
TSvgErrorCode aSvgErrorCode
TInt aSystemError
const TDesC & aMsg1
const TDesC & aMsg2

PrintAllElements(CSvgElementImpl *)

void PrintAllElements ( CSvgElementImpl * aStartElement )

Parameters

CSvgElementImpl * aStartElement

Process16BitSvgContentL(const TDesC16 &, CSvgErrorImpl &, TBool)

void Process16BitSvgContentL ( const TDesC16 & aByteArray,
CSvgErrorImpl & aError,
TBool aRemoveFalseSwitchElements = ETrue
) [private]

Parameters

const TDesC16 & aByteArray
CSvgErrorImpl & aError
TBool aRemoveFalseSwitchElements = ETrue

ProcessDRMContentL(RFile &, CSvgErrorImpl &)

HBufC8 * ProcessDRMContentL ( RFile & aFileHandle,
CSvgErrorImpl & aError
) [private]

Parameters

RFile & aFileHandle
CSvgErrorImpl & aError

ProcessDRMError(TInt, CSvgErrorImpl &)

void ProcessDRMError ( TInt errorCode,
CSvgErrorImpl & aError
) [private]

Parameters

TInt errorCode
CSvgErrorImpl & aError

ProcessGZipContent(RFs &, RFile &, TFileName &, CSvgErrorImpl &)

TBool ProcessGZipContent ( RFs & aSession,
RFile & aFileHandle,
TFileName & aFileName,
CSvgErrorImpl & aError
) [private]

Parameters

RFs & aSession
RFile & aFileHandle
TFileName & aFileName
CSvgErrorImpl & aError

ProcessGZipContent(RFs &, TFileName &, TFileName &, CSvgErrorImpl &)

TBool ProcessGZipContent ( RFs & aSession,
TFileName & aZippedFileName,
TFileName & aUnzippedFileName,
CSvgErrorImpl & aError
) [private]

Parameters

RFs & aSession
TFileName & aZippedFileName
TFileName & aUnzippedFileName
CSvgErrorImpl & aError

ProcessSvgContentL(const TDesC8 &, CSvgErrorImpl &, TBool)

void ProcessSvgContentL ( const TDesC8 & aByteArray,
CSvgErrorImpl & aError,
TBool aRemoveFalseSwitchElements = ETrue
) [private]

Parameters

const TDesC8 & aByteArray
CSvgErrorImpl & aError
TBool aRemoveFalseSwitchElements = ETrue

QueueFontReleaseReq(CFont *)

void QueueFontReleaseReq ( CFont * aFont )

Parameters

CFont * aFont

ReInitialize()

void ReInitialize ( )

RemoveFromEventReceiverList(MSvgEventReceiver *)

void RemoveFromEventReceiverList ( MSvgEventReceiver * aElement )

Removed an object to the list of objects that are notified of an event

Since
1.0

Parameters

MSvgEventReceiver * aElement - An SVG element that wants to be registered for an event (implements MSvgEventReceiver interface)

RemoveInternalMouseListener(const MSvgMouseListener *)

void RemoveInternalMouseListener ( const MSvgMouseListener * aListener )

Remove a MSvgMouseListener to this SvgEngine

Parameters

const MSvgMouseListener * aListener

Reset(MSvgEvent *)

void Reset ( MSvgEvent * aEvent )
Two Phase constructor for SVG document
Since
1.0

Parameters

MSvgEvent * aEvent

ResumeTimedEntity()

void ResumeTimedEntity ( ) [private]
From MSvgTimedEntityInterface This would be used for resuming the timed entity once all locked timed entities get loaded.
Since
S60 3.2

ResyncTimedEntity(TUint32)

void ResyncTimedEntity ( TUint32 aSynctime ) [private]
From MSvgTimedEntityInterface If the timed entity needs to be in sync with the time container and it has slipped beyond the sync tolerance limit, the method is called to bring the element in sync with the time container.
Since
Series 3.2

Parameters

TUint32 aSynctime Time for resync in msecs.

RootElement()

IMPORT_C MXmlElement * RootElement ( )

get root element

SchemaData()

CSvgSchemaData * SchemaData ( )

Need method description

Since
1.0

SearchByPointer(CSvgElementImpl *, CSvgElementImpl *)

TBool SearchByPointer ( CSvgElementImpl * aParent,
CSvgElementImpl * aElement
)

Parameters

CSvgElementImpl * aParent
CSvgElementImpl * aElement

SearchElementById(MXmlElement *, const TDesC &)

MXmlElement * SearchElementById ( MXmlElement * aElement,
const TDesC & aId
) [private]

search element by ID

Parameters

MXmlElement * aElement
const TDesC & aId

SetCurFocusIndex(TInt32)

void SetCurFocusIndex ( TInt32 aVal )

Parameters

TInt32 aVal

SetCurFocusObject(CSvgElementImpl *)

void SetCurFocusObject ( CSvgElementImpl * aElement )

Parameters

CSvgElementImpl * aElement

SetCurSyncMasterStatus(TBool)

void SetCurSyncMasterStatus ( TBool aSyncMasterStatus ) [private]
From MSvgTimedEntityInterface If some other element is resolved as syncMaster in the time container group, this element can not act as sync master.
Since
Series 3.2

Parameters

TBool aSyncMasterStatus Indicates whether the element is currrently Sync Master.

SetCurrentTime(const TInt32)

void SetCurrentTime ( const TInt32 aCurTime )
Set Function for the document's current time
Since
S60 3.2

Parameters

const TInt32 aCurTime Current Time to be set in msecs

SetDRMMode(TBool)

void SetDRMMode ( TBool aEnable )

Sets DRM Check Enable/Disable

Parameters

TBool aEnable

SetDRMRights(TBool)

void SetDRMRights ( TBool aEnable )

Set the document to disable/enable consuming drm rights

Parameters

TBool aEnable

SetEngine(CSvgEngineImpl *)

void SetEngine ( CSvgEngineImpl * aEngine )

Need method description

Since
1.0

Parameters

CSvgEngineImpl * aEngine

SetError(TInt, const TDesC &, const TDesC &)

void SetError ( TInt aErrorType,
const TDesC & aMsg1,
const TDesC & aMsg2
)

Set the error type and error message for this document. Will note override existing error.

Parameters

TInt aErrorType
const TDesC & aMsg1
const TDesC & aMsg2

SetFocusElement(CXmlElementImpl *)

void SetFocusElement ( CXmlElementImpl * aElement )

Parameters

CXmlElementImpl * aElement

SetImageElementsCount(TInt)

void SetImageElementsCount ( TInt aCnt )

Parameters

TInt aCnt

SetIsWarning(TBool)

void SetIsWarning ( TBool aIsWarning = ETrue )

Parameters

TBool aIsWarning = ETrue

SetLoadingListeners(const RPointerArray< MSvgLoadingListener > *)

void SetLoadingListeners ( const RPointerArray < MSvgLoadingListener > * aList )

Set the list of MSvgLoadingListener for this document to send back notification of parsing progress. NULL is also valid.

Parameters

const RPointerArray < MSvgLoadingListener > * aList

SetTCSyncBehavior(const TSvgSyncBehaviour)

void SetTCSyncBehavior ( const TSvgSyncBehaviour aValue )
Set the Synchronised behaviour for the time container
Since
S60 3.2

Parameters

const TSvgSyncBehaviour aValue canSlip | locked | independent

SetTCSyncMaster(const TBool)

void SetTCSyncMaster ( const TBool aValue )
Set the time container as Synchronised Master
Since
S60 3.2

Parameters

const TBool aValue true | false

SetTCSyncTolerance(const TUint32)

void SetTCSyncTolerance ( const TUint32 aValue )
Set the Synchronised Tolerance for the time container
Since
S60 3.2

Parameters

const TUint32 aValue Clock-value

SetThumbNailMode(TBool)

void SetThumbNailMode ( TBool aThumbNailMode )

Set the document to be in thumbnailmode, which will not consume the DRM right if the Svg content is DRM encrypted.

Parameters

TBool aThumbNailMode

SetUri(const TDesC &)

void SetUri ( const TDesC & aUri )

Need method description

Since
1.0

Parameters

const TDesC & aUri

SetWasPrepared(TBool)

void SetWasPrepared ( TBool aBool )

Set the flag to indicate this document was prepared (PrepareDom) or loaded (Load).

Parameters

TBool aBool

SortEventList()

void SortEventList ( )

An internal method that sorts the events in a time scale

Since
1.0

StopTimedEntity()

void StopTimedEntity ( ) [private]
From MSvgTimedEntityInterface This would be used for stopping the timed entity.
Since
S60 3.2

SubtreeDuration(CSvgElementImpl *)

TUint32 SubtreeDuration ( CSvgElementImpl * aRootElement ) [private]

Parameters

CSvgElementImpl * aRootElement

SvgElementPresent(CSvgElementImpl *)

TBool SvgElementPresent ( CSvgElementImpl * aElement )

Parameters

CSvgElementImpl * aElement

SvgHasAnimationElement()

TBool SvgHasAnimationElement ( )

Finds if Animation element is there.

Since
Series 3.2

SyncBehaviorDefault()

TSvgSyncBehaviour SyncBehaviorDefault ( )
Accessor funciton for SyncBehaviorDefault value
Since
S60 3.2

SyncToleranceDefault()

TUint32 SyncToleranceDefault ( )
Accessor funciton for SyncToleranceDefault value
Since
S60 3.2

TimeContainer()

CSvgTimeContainer * TimeContainer ( )
Accessor for the time container.
Since
Series 3.2

WasPrepared()

TBool WasPrepared ( )

Return whether this document was prepared (PrepareDom) or loaded (Load).

WriteToTempFile(RFs &, const TDesC8 &, TFileName &, CSvgErrorImpl &)

TInt WriteToTempFile ( RFs & aSession,
const TDesC8 & aByteArray,
TFileName & aFilename,
CSvgErrorImpl & aError
) [private]

Parameters

RFs & aSession
const TDesC8 & aByteArray
TFileName & aFilename
CSvgErrorImpl & aError

WriteToTempFile(RFs &, RFile &, TFileName &, CSvgErrorImpl &)

TInt WriteToTempFile ( RFs & aSession,
RFile & aFileHandle,
TFileName & aFilename,
CSvgErrorImpl & aError
) [private]

Parameters

RFs & aSession
RFile & aFileHandle
TFileName & aFilename
CSvgErrorImpl & aError

isGroupOpacity(CSvgElementImpl *)

TBool isGroupOpacity ( CSvgElementImpl * aElement )

Parameters

CSvgElementImpl * aElement

Member Data Documentation

const TInt KIndefiniteAnimationDuration

const TInt KIndefiniteAnimationDuration [private, static]

TUint iAnimationDuration

TUint iAnimationDuration [private]

TBool iAnimationResetNeeded

TBool iAnimationResetNeeded

TBool iCheckedAnimationDuration

TBool iCheckedAnimationDuration [private]

TInt32 iCurObjIdx

TInt32 iCurObjIdx [private]

CSvgElementImpl * iCurrentFocusObject

CSvgElementImpl * iCurrentFocusObject [private]

TBool iDrmEnable

TBool iDrmEnable [private]

TBool iDrmRightsConsumptionEnabled

TBool iDrmRightsConsumptionEnabled [private]

CSvgEngineImpl * iEngine

CSvgEngineImpl * iEngine [private]

CSvgErrorImpl * iError

CSvgErrorImpl * iError [private]

CSvgEventHandler * iEventHandler

CSvgEventHandler * iEventHandler

TBool iFinishedParsing

TBool iFinishedParsing

CSvgFontHashMap * iFontHashMap

CSvgFontHashMap * iFontHashMap

TBool iHasGradientElement

TBool iHasGradientElement [private]

TBool iHasGroupOpacity

TBool iHasGroupOpacity

TBool iHasParent

TBool iHasParent [private]

TInt iImageElementCnt

TInt iImageElementCnt

TBool iInitSortList

TBool iInitSortList

TBool iInitialDrawFlag

TBool iInitialDrawFlag

TBool iIsDRMProtected

TBool iIsDRMProtected [private]

TBool iIsInteractive

TBool iIsInteractive

TBool iIsPruningTree

TBool iIsPruningTree

TBool iIsRendering

TBool iIsRendering

TBool iIsThumbNailMode

TBool iIsThumbNailMode [private]

const RPointerArray< MSvgLoadingListener > * iLoadingListeners

const RPointerArray < MSvgLoadingListener > * iLoadingListeners [private]

CSvgMemoryManager * iMemoryManager

CSvgMemoryManager * iMemoryManager

TBool iMultipleRendering

TBool iMultipleRendering [private]

CSvgElementImpl * iPerfText

CSvgElementImpl * iPerfText

TBool iReqExReqFtrSysLTested

TBool iReqExReqFtrSysLTested

CSvgElementImpl * iRootElement

CSvgElementImpl * iRootElement [private]

CSvgSchemaData * iSchemaData

CSvgSchemaData * iSchemaData [private]

RPointerArray< CSvgAnimationBase > iSvgAnimations

RPointerArray < CSvgAnimationBase > iSvgAnimations

CSvgBitmapFontProvider * iSvgBitmapFontProvider

CSvgBitmapFontProvider * iSvgBitmapFontProvider [private]

RPointerArray< MSvgMouseListener > iSvgMouseListeners

RPointerArray < MSvgMouseListener > iSvgMouseListeners [private]

TSvgSyncBehaviour iSyncBehaviorDefault

TSvgSyncBehaviour iSyncBehaviorDefault [private]

TUint32 iSyncToleranceDefault

TUint32 iSyncToleranceDefault [private]

CSvgTimeContainer * iTimeContainer

CSvgTimeContainer * iTimeContainer [private]

TUint32 iTimeForJSR226

TUint32 iTimeForJSR226

TGfxAffineTransform iTransformMatrix

TGfxAffineTransform iTransformMatrix [private]

TBuf< 256 > iUri

TBuf < 256 > iUri [private]

TBool iWasPrepared

TBool iWasPrepared [private]

CSvgContentHandler * iXmlHandler

CSvgContentHandler * iXmlHandler [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.