CSvgJavaInterfaceImpl Class Reference

aDocumentHandle

)

Destroy the given svg document (by handle). NOTE: Java MIDlet could use multiple documents.

Since: 1.0

Destroy the given svg document (by handle).

Parameters

SvgDocumentHandle aDocumentHandle

Document handle.

SvgDocumentDispatchMouseEvent(SvgDocumentHandle, TInt, TInt)

IMPORT_C SvgElementHandle	SvgDocumentDispatchMouseEvent	(	SvgDocumentHandle	aDocumentHandle,
			TInt	aMouseX,
			TInt	aMouseY
		)

Request a mouse event at the given coordinate. This method is used to dispatch a mouse "click" event to the given document. The mouse position is given as screen coordinates aMouseX, aMouseY. If the aMouseX, aMouseY values are outside the viewport area or no target is available for the aMouseX, aMouseY coordinates, the event is not dispatched.

Since: 1.0

javax.microedition.m2g.SVGImage::dispatchMouseEvent() Request a mouse event at the given coordinate.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
TInt aMouseX	The y location of the mouse/pointer in viewport coordinate system.
TInt aMouseY

SvgDocumentEndElementAt(SvgDocumentHandle, SvgElementHandle, TReal32)

IMPORT_C void	SvgDocumentEndElementAt	(	SvgDocumentHandle	aDocumentHandle,
			SvgElementHandle	aElementHandle,
			TReal32	aOffsetTime
		)

Set the end animation time for the given element in the given SVG document. The new time is added to the end instance times list. NOTE: Native engine checks the element is active before set the new end time.

Since: 1.0

org.w3c.dom.svg.SVGAnimationElement::endElementAt() Set the end animation time for the given element.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
SvgElementHandle aElementHandle	Element handle
TReal32 aOffsetTime	The time in seconds at which to end the element.

SvgDocumentFocusOn(SvgDocumentHandle, SvgElementHandle)

IMPORT_C void	SvgDocumentFocusOn	(	SvgDocumentHandle	aDocumentHandle,
			SvgElementHandle	aElementHandle
		)

Set the given element to have the focus in the given SVG document. The initial focus is always null and setting NULL will remove the current focus. NOTE: Java doesn't use this method.

Since: 1.0

javax.microedition.m2g.SVGImage::focusOn() changes made for Focus-in/focus-out bug(AMIA-6T8EEG)

Set the given element to have the focus.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
SvgElementHandle aElementHandle	The element to set the focus on.

SvgDocumentFocusOut(SvgDocumentHandle, SvgElementHandle)

IMPORT_C void	SvgDocumentFocusOut	(	SvgDocumentHandle	aDocumentHandle,
			SvgElementHandle	aElementHandle
		)

Set the focus out of the given element. The initial focus is always null and setting NULL will remove the current focus. NOTE: Java doesn't use this method.

Since: 1.0

javax.microedition.m2g.SVGImage::focusOut() changes made for Focus-in/focus-out bug(AMIA-6T8EEG)

Unset the focus from the given element passed as parameter.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
SvgElementHandle aElementHandle	The element for which to set the focus out.

SvgDocumentGetElementById(SvgDocumentHandle, const TPtrC16 &)

IMPORT_C SvgElementHandle	SvgDocumentGetElementById	(	SvgDocumentHandle	aDocumentHandle,
			const TPtrC16 &	aID
		)

Get the svg element in the given SVG document with the given unique ID string.If no such element exists, this returns NULL.

Since: 1.0

org.w3c.dom.Document::getElementById() Get the svg element identified by the given id-string.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
const TPtrC16 & aID

SvgDocumentGetExternalListItem(SvgDocumentHandle, TInt, TPtrC16 &)

IMPORT_C TInt	SvgDocumentGetExternalListItem	(	SvgDocumentHandle	aDocumentHandle,
			TInt	aIndex,
			TPtrC16 &	aItem
		)

Get an external item indicated in a SVG document. Java side might request an external resouce and once the requested external resource is available, java side forwards this information (SvgDocumentGetExternalListItem) to the SVG engine. Note: Returning null indicates that the SVG engine tryes to handle the requested resource.

Since: 1.0

Svg Document GetExternalListItem.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
TInt aIndex
TPtrC16 & aItem

SvgDocumentGetExternalListSize(SvgDocumentHandle)

IMPORT_C TInt

SvgDocumentGetExternalListSize

(

aDocumentHandle

)

Get number of external list items in a SVG document. After the SVG document is created (see SvgDocumentCreateL) java side checks if the SVG document contains external item(s)

Since: 1.0

Svg Document get external list item.

Parameters

SvgDocumentHandle aDocumentHandle

SVG document handle

SvgDocumentGetFocus(SvgDocumentHandle)

IMPORT_C SvgElementHandle

SvgDocumentGetFocus

(

aDocumentHandle

)

Get the element having the focus. NOTE: Java doesn't use this method.

Since: 1.0

javax.microedition.m2g.SVGImage::focusOn() Get the element having the focus.

Parameters

SvgDocumentHandle aDocumentHandle

SVG document handle

SvgDocumentGetId(SvgDocumentHandle, TInt, TPtrC16 &)

IMPORT_C TInt	SvgDocumentGetId	(	SvgDocumentHandle	aDocumentHandle,
			TInt	index,
			TPtrC16 &	aId
		)

Get an id (at index) from the current SVG document. NOTE: Java doesn't use this method.

Since: 1.0

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
TInt index	ID index
TPtrC16 & aId

SvgDocumentGetMediaTime(SvgDocumentHandle)

IMPORT_C TReal32

SvgDocumentGetMediaTime

(

aDocumentHandle

)

Get current animation or media timeline time for the specified document.

Since: 1.0

org.w3c.dom.svg.SVGSVGElement::getCurrentTime() Get Media time for the specified document.

Parameters

SvgDocumentHandle aDocumentHandle

SVG document handle

SvgDocumentGetNumberOfIds(SvgDocumentHandle)

IMPORT_C TInt

SvgDocumentGetNumberOfIds

(

aDocumentHandle

)

Get the number of ids in the current SVG document. NOTE: Java doesn't use this method.

Since: 1.0

Parameters

SvgDocumentHandle aDocumentHandle

SVG document handle

SvgDocumentGetRootElement(SvgDocumentHandle)

IMPORT_C SvgElementHandle

SvgDocumentGetRootElement

(

aDocumentHandle

)

Return a child element of the given SVG document Node which corresponds to the top-most tag in XML file. For SVG files it must be SVGSVGElement.

Since: 1.0

org.w3c.dom.Document::getDocumentElement() Get the root element for the given document.

Parameters

SvgDocumentHandle aDocumentHandle

SVG document handle

SvgDocumentGetViewportHeight(SvgDocumentHandle)

IMPORT_C TInt

SvgDocumentGetViewportHeight

(

aDocumentHandle

)

Get the viewport height of the given SVG document. The value returned is always in pixels. If the specified height is defined in percentages, the values are mapped to the default view port size of 100x100. If the viewport height is explicitly changed by the java application, then the percentages are ignored and the content is made to fit to this new viewport height.

Since: 1.0

javax.microedition.m2g.ScalableImage::getViewportHeight() SvgDocumentSetViewportHeight Get the viewport height for the given document.

Parameters

SvgDocumentHandle aDocumentHandle

SVG document handle

SvgDocumentGetViewportHeightUnits(SvgDocumentHandle)

IMPORT_C TInt

SvgDocumentGetViewportHeightUnits

(

aDocumentHandle

)

Get the viewport height units for the given document. NOTE: Java side is not actually need this method.

Since: 1.0

Get the viewport height units for the given document.

Parameters

SvgDocumentHandle aDocumentHandle

Document

SvgDocumentGetViewportWidth(SvgDocumentHandle)

IMPORT_C TInt

SvgDocumentGetViewportWidth

(

aDocumentHandle

)

Get the viewport width of the given SVG document. The value returned is always in pixels. If the specified width is defined in percentages, the values are mapped to the default view port size of 100x100. If the viewport width is explicitly changed by the java application, then the percentages are ignored and the content is made to fit to this new viewport width.

Since: 1.0

javax.microedition.m2g.ScalableImage::getViewportWidth() SvgDocumentSetViewportWidth Get the viewport width for the given document.

Parameters

SvgDocumentHandle aDocumentHandle

SVG document handle

SvgDocumentGetViewportWidthUnits(SvgDocumentHandle)

IMPORT_C TInt

SvgDocumentGetViewportWidthUnits

(

aDocumentHandle

)

Get the viewport width units for the given document. NOTE: Java side is not actually need this method.

Since: 1.0

Get the viewport width units for the given document.

Parameters

SvgDocumentHandle aDocumentHandle

Document

SvgDocumentHasAnimation(SvgDocumentHandle)

IMPORT_C TInt

SvgDocumentHasAnimation

(

aDocumentHandle

)

Check if document has animation. NOTE: Java doesn't use this method.

Since: 1.0

Check if document has animation.

Parameters

SvgDocumentHandle aDocumentHandle

SVG document handle

SvgDocumentRequestCompleted(SvgDocumentHandle, const TPtrC16 &, const TPtrC8 &)

EXPORT_C TInt	SvgDocumentRequestCompleted	(	SvgDocumentHandle	hDocument,
			const TPtrC16 &	aUri,
			const TPtrC8 &
		)

Svg Document request complete. Once the requested external resource is available, the application forwards this information (data) to the SVG engine. If this method is called a second time for a same URL (uri) of a same SVG document, the engine will replace the current resource data with the new one. Note: Setting NULL for data (0 for data_size) indicates that the requested resource could not be fetched by java side, and in this event the SVG engine will not make further attempts to load this resource.

Since: 1.0

javax.microedition.m2g.ScalableImage::requestCompleted() Svg Document RequestCompleted

Parameters

SvgDocumentHandle hDocument	SVG document handle
const TPtrC16 & aUri
const TPtrC8 &

SvgDocumentSetMediaTime(SvgDocumentHandle, TReal32)

IMPORT_C void	SvgDocumentSetMediaTime	(	SvgDocumentHandle	aDocumentHandle,
			TReal32	seconds
		)

Increments the animation or media timeline for the specified document aDocumentHandle (in seconds). This method is intended to move only forward in the timeline. It is important to note that setting large increments of time would result in skipping parts of the animation as per the SVG animation model.

Since: 1.0

javax.microedition.m2g.SVGImage::incrementTime() org.w3c.dom.svg.SVGSVGElement::setCurrentTime() Set Media time for the specified document.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle.
TReal32 seconds	the value of time to be set in seconds.

SvgDocumentSetViewportHeight(SvgDocumentHandle, TInt)

IMPORT_C void	SvgDocumentSetViewportHeight	(	SvgDocumentHandle	aDocumentHandle,
			TInt	aHeight
		)

Set the new (viewport) height for the given SVG document.

Since: 1.0

javax.microedition.m2g.ScalableImage::setViewportHeight() SvgDocumentGetViewportHeight Set the viewport height for the given document.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
TInt aHeight	The new height to be set.

SvgDocumentSetViewportWidth(SvgDocumentHandle, TInt)

IMPORT_C void	SvgDocumentSetViewportWidth	(	SvgDocumentHandle	aDocumentHandle,
			TInt	aWidth
		)

Set the new (viewport) width for the given SVG document.

Since: 1.0

javax.microedition.m2g.ScalableImage::setViewportWidth() SvgDocumentGetViewportWidth Set the viewport width for the given document.

Parameters

SvgDocumentHandle aDocumentHandle	SVG document handle
TInt aWidth	The new width to be set.

SvgDocumentViewportInit(SvgDocumentHandle)

IMPORT_C void

SvgDocumentViewportInit

(

aDocumentHandle

)

Set the default viewport size for the given SVG document. The default viewport size of 100-by-100 pixels is used when the size is unspecified.

Since: 1.0

Parameters

SvgDocumentHandle aDocumentHandle

Document

SvgElementAddEventListener(SvgElementHandle, TInt, SvgAttrType)

IMPORT_C void	SvgElementAddEventListener	(	SvgElementHandle	aElementHandle,
			TInt	aListener,
			SvgAttrType	aType
		)

Add event listener to the given element. Note: need to replace void* with specific class NOTE: Java doesn't use this method.

Since: 1.0

Add event listener to the given element. Note: need to replace void* with specific class

Parameters

SvgElementHandle aElementHandle	The element handle.
TInt aListener	Listener
SvgAttrType aType	Type

SvgElementAppendChild(SvgElementHandle, SvgElementHandle)

IMPORT_C void	SvgElementAppendChild	(	SvgElementHandle	aElementHandle,
			SvgElementHandle	aChildElementHandle
		)

Append the given child element to the given svg element.

Since: 1.0

org.w3c.dom.Node::appendChild() Append the given child element to the given svg element.

Parameters

SvgElementHandle aElementHandle	Element handle
SvgElementHandle aChildElementHandle	New child element handle

SvgElementCheckRemoveable(SvgElementHandle)

IMPORT_C TInt

SvgElementCheckRemoveable

(

aElementHandle

)

Check if the given element is removable (no id or children with ids).

Since: 1.0

org.w3c.dom.Node::removeChild() Check removable element. any element that doesnt have an id and its children dont have ids

Parameters

SvgElementHandle aElementHandle

The element handle.

SvgElementCreate(SvgAttrType)

IMPORT_C SvgElementHandle

SvgElementCreate

(

SvgAttrType

aType

)

Create a new svg element based on the specified (aType) SVG tag name. Only the following elements must be supported: <rect>, <circle>, <ellipse>, <line>, <path> <use> <image> <text>, <a> and <g>.

Since: 1.0

org.w3c.dom.Document::createElementNS() Create a new svg element of the given tag string and append to the given svg element parent.

Parameters

SvgAttrType aType

SvgElementDestroy(SvgElementHandle)

IMPORT_C void

SvgElementDestroy

(

hElement

)

Destroy svg element of the given handle. NOTE: Java doesn't use this method.

Since: 1.0

Destroy svg element of the given handle.

Parameters

SvgElementHandle hElement

Element handle

SvgElementElementInDOM(TInt, TInt)

IMPORT_C TInt	SvgElementElementInDOM	(	TInt	hDocument,
			TInt	hElement
		)

Find whether the element is present in a document.

Since: 1.0

Parameters

TInt hDocument	The SVG document handle.
TInt hElement	The element handle.

SvgElementGetBBox(SvgElementHandle, SvgAttrType, TReal32 , TReal32 , TReal32 , TReal32 )

IMPORT_C void	SvgElementGetBBox	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttributeType,
			TReal32 *	aX,
			TReal32 *	aY,
			TReal32 *	aWidth,
			TReal32 *	aHeight
		)

Returns the tight bounding box in current user coordinate space. Tight bounding box is the smallest possible rectangle that includes the geometry of all contained graphics elements excluding stroke. The calculation is done in the user coordinate space of the element. When bounding box is calculated elements with display property (trait) set to none are ignored. Exact rules for the bounding box calculation are given in the SVG spec.

Since: 1.0

org.w3c.dom.svg.SVGLocatableElement::getBBox() Get the bounding box rectangle attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aAttributeType	The name of the attribute (trait) to retrieve.
TReal32 * aX	X coordinate.
TReal32 * aY	Y coordinate.
TReal32 * aWidth	Width.
TReal32 * aHeight	Height.

SvgElementGetColorAttribute(SvgElementHandle, SvgAttrType, TInt , TInt , TInt *)

IMPORT_C TInt	SvgElementGetColorAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttribute,
			TInt *	aRedValue,
			TInt *	aGreenValue,
			TInt *	aBlueValue
		)

Get a color attribute from the given element. The values are copied into the color components given.

Since: 1.0

org.w3c.dom.svg.SVGRGBColor Get a color attribute from the given element. The values are copied into the color object given.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aAttribute
TInt * aRedValue	The red value
TInt * aGreenValue	The green value
TInt * aBlueValue	The blue value

SvgElementGetEnumAttribute(SvgElementHandle, SvgAttrType)

IMPORT_C short	SvgElementGetEnumAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttribute
		)

Get enum attribute (trait) value.

Since: 1.0

org.w3c.dom.svg.SVGElement Get enum attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aAttribute	The name of the attribute (trait).

SvgElementGetFirstElementChild(SvgElementHandle)

IMPORT_C SvgElementHandle

SvgElementGetFirstElementChild

(

aElementHandle

)

Returns the first child element node of the given element. Return NULL if this element has no child elements.

Since: 1.0

org.w3c.dom.svg.SVGElement::getFirstElementChild() Get the first child element for the given svg element.

Parameters

SvgElementHandle aElementHandle

Element handle

SvgElementGetFloatAttribute(SvgElementHandle, SvgAttrType)

IMPORT_C TReal32	SvgElementGetFloatAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttribute
		)

Return a attribute (trait) value as float.

Since: 1.0

org.w3c.dom.svg.SVGElement::getFloatTrait() Get a float attribute value.

Parameters

SvgElementHandle aElementHandle	The element.
SvgAttrType aAttribute	Attribute's (or trait's) name

SvgElementGetMatrixAttribute(SvgElementHandle, SvgAttrType, TReal32 , TReal32 , TReal32 , TReal32 , TReal32 , TReal32 )

IMPORT_C TInt	SvgElementGetMatrixAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aMatrixAttribute,
			TReal32 *	aAVal,
			TReal32 *	aBVal,
			TReal32 *	aCVal,
			TReal32 *	aDVal,
			TReal32 *	aEVal,
			TReal32 *	aFVal
		)

Get the matrix attribute (trait) values. NOTE: The returned values are copies of the actual attribute (trait) values and will not change if the corresponding trait changes.

 [aAVal aCVal aEVal]
 [aBVal aDVal aFVal]

Since: 1.0

org.w3c.dom.svg.SVGElement::getMatrixTrait() Get the matrix attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aMatrixAttribute	The name of the attribute (trait) to retrieve.
TReal32 * aAVal	The x scaling component
TReal32 * aBVal	The y shearing component
TReal32 * aCVal	The x shearing component
TReal32 * aDVal	The y scaling component
TReal32 * aEVal	The x translation component
TReal32 * aFVal	The y translation component

SvgElementGetNextElementSibling(SvgElementHandle)

IMPORT_C SvgElementHandle

SvgElementGetNextElementSibling

(

aElementHandle

)

Returns the next sibling element of the given element. Return NULL if the given element has no element sibling nodes that come after this one in the document tree.

Since: 1.0

org.w3c.dom.svg.SVGElement::getNextElementSibling() Get the next sibling element for the given svg element.

Parameters

SvgElementHandle aElementHandle

Element handle

SvgElementGetParent(SvgElementHandle)

IMPORT_C SvgElementHandle

SvgElementGetParent

(

aElementHandle

)

Returns a parent element of the given element.

Since: 1.0

org.w3c.dom.svg.SVGElement::getParentNode() Get the parent element for the given svg element.

Parameters

SvgElementHandle aElementHandle

Element handle

SvgElementGetPathAttribute(SvgElementHandle, SvgAttrType)

IMPORT_C TInt	SvgElementGetPathAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aPathAttribute
		)

Get the path attribute (trait)value. NOTE: The returned values are copies of the actual attribute values and will not change if the corresponding trait changes.

Since: 1.0

org.w3c.dom.svg.SVGElement::getPathTrait() org.w3c.dom.svg.SVGPath Get the path attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aPathAttribute	The name of the attribute (trait) to retrieve.

SvgElementGetRectAttribute(SvgElementHandle, SvgAttrType, TReal32 , TReal32 , TReal32 , TReal32 )

IMPORT_C TInt	SvgElementGetRectAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aRectAttribute,
			TReal32 *	aX,
			TReal32 *	aY,
			TReal32 *	aWidth,
			TReal32 *	aHeight
		)

Return the rectangle attribute (trait) values. NOTE: The returned values are copies of the actual attribute (trait) values and will not change if the corresponding trait changes.

Since: 1.0

org.w3c.dom.svg.SVGElement::getRectTrait() Get the rectangle attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aRectAttribute	The name of the attribute (trait) to retrieve.
TReal32 * aX	X coordinate.
TReal32 * aY	Y coordinate.
TReal32 * aWidth	Width.
TReal32 * aHeight	Height.

SvgElementGetScreenBBox(TInt, TReal32 , TReal32 , TReal32 , TReal32 )

IMPORT_C void	SvgElementGetScreenBBox	(	TInt	hElement,
			TReal32 *	x,
			TReal32 *	y,
			TReal32 *	w,
			TReal32 *	h
		)

Gets a screen bounding box for the given element. Returns the tight bounding box in screen coordinate space. Tight bounding box is the smallest possible rectangle that includes the geometry of all contained graphics elements excluding stroke. The box coordinates are in the screen coordinate space, which is connected to the current user coordinate space by the matrix returned by SvgElementGetMatrixAttribute (with attribute id=<svg>).

Since: 1.0

org.w3c.dom.svg.SVGLocatableElement::getScreenBBox() org.w3c.dom.svg.SVGLocatableElement::getScreenCTM()

Parameters

TInt hElement	The element handle.
TReal32 * x
TReal32 * y
TReal32 * w
TReal32 * h

SvgElementGetStringAttribute(SvgElementHandle, SvgAttrType, TPtrC16 &)

IMPORT_C TInt	SvgElementGetStringAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttributeName,
			TPtrC16 &	aStrAttribute
		)

Get a string attribute from the given element.

Since: 1.0

org.w3c.dom.svg.SVGElement Get a string attribute from the given element. returning 16 bit characters now instead of 8 bit ones that the original JSR used...

Parameters

SvgElementHandle aElementHandle	The element.
SvgAttrType aAttributeName	Attribute's name
TPtrC16 & aStrAttribute

SvgElementGetType(SvgElementHandle)

IMPORT_C TInt

SvgElementGetType

(

aElementHandle

)

Request element type. The following element type are supported: <a>, <animate>, <animateColor>, <animateMotion>, <animateTransform> <circle> <defs> <ellipse>, <font>, <font-face>, <font-face-name>, <font-face-src>, <foreignObject>, <g>, <glyph>, <hkern>, <image>, <line>, <metadata>, <missing-glyph>, <metadata>, <mpath>. <path>, <polygon>, <polyline>, <rect>, <set>, <svg>, <switch>, <text>, <title>, <use>.

Since: 1.0

org.w3c.dom.svg.SVGElement Request element type.

Parameters

SvgElementHandle aElementHandle

The element.

SvgElementGetUsedFromElement(TInt)

IMPORT_C TInt

SvgElementGetUsedFromElement

(

TInt

hElement

)

Finds the handle to the actual cloned element.

Since: 1.0

javax.microedition.m2g.SVGImage::dispatchMouseEvent()

Parameters

TInt hElement

aElement This is handle to the cloned element. this is child of the <use> element.

SvgElementHasAnimation(SvgElementHandle)

IMPORT_C TInt

SvgElementHasAnimation

(

aElementHandle

)

Check if document has animation. NOTE: Java doesn't use this method.

Since: 1.0

Check if element has animation.

Parameters

SvgElementHandle aElementHandle

SVG element handle

SvgElementInsertBefore(SvgElementHandle, SvgElementHandle, SvgElementHandle)

IMPORT_C void	SvgElementInsertBefore	(	SvgElementHandle	aElementHandle,
			SvgElementHandle	aChildElementHandle,
			SvgElementHandle	aReferenceElementHandle
		)

Inserts aChildElementHandle before aReferenceElementHandle in the child list for the aElementHandle. If aReferenceElementHandle is NULL, aChildElementHandle is inserted at the end of the list. If the aChildElementHandle is already part of the tree, it is first removed.

Since: 1.0

org.w3c.dom.Node::insertBefore()

Exceptions

TODO	Should throw exception if the `aChildElementHandle` would cause the SVG document to go into error, for ex: when the newChild contains a <use> element with an invalid xlink:href attribute.

Add the given child element to the given svg element, before the given reference element.

Parameters

SvgElementHandle aElementHandle	The parent element.
SvgElementHandle aChildElementHandle	The child to add
SvgElementHandle aReferenceElementHandle	The child before which the new child should be added.

SvgElementIsActive(SvgElementHandle)

IMPORT_C TInt

SvgElementIsActive

(

aElementHandle

)

Check if element is active. i.e. an animation element is active in these cases:

A media time is 1s.

    <rect id="&lt;element&gt;" x="&lt;0&gt;" y="&lt;20&gt;" width="&lt;20&gt;" height="&lt;20&gt;">
          <animate id=<animationElement> attributeName=<x> attributeType=<XML>
                 begin=<1s> dur=<4s> end=<2s> fill=<freeze> 
				 from=<0> to=<80>
		   </animate>
		   </rect>

A media time is 2s.

    <rect id="&lt;element&gt;" x="&lt;0&gt;" y="&lt;20&gt;" width="&lt;20&gt;" height="&lt;20&gt;">
          <animate id=<animationElement> attributeName=<x> attributeType=<XML>
                 begin=<1s> dur=<4s> end=<2s> fill=<freeze> 
				 from=<0> to=<80>
		   </animate>
		   </rect>

Since: 1.0

org.w3c.dom.svg.SVGAnimationElement::endElementAt() Check if element is active.

Parameters

SvgElementHandle aElementHandle

The element handle.

SvgElementIsUsed(TInt)

IMPORT_C TInt

SvgElementIsUsed

(

TInt

hElement

)

Checks whether this element is child of a use element.

Since: 1.0

javax.microedition.m2g.SVGImage::dispatchMouseEvent()

Parameters

TInt hElement

The element handle.

SvgElementRemoveChild(SvgElementHandle, SvgElementHandle)

IMPORT_C SvgElementHandle	SvgElementRemoveChild	(	SvgElementHandle	aElementHandle,
			SvgElementHandle	aChildElementHandle
		)

Remove the given child element from the given svg element. Elements that have ids cannot be removed from the tree.

Since: 1.0

org.w3c.dom.Node::removeChild() Remove the given child element from the given svg element.

Parameters

SvgElementHandle aElementHandle	The parent element.
SvgElementHandle aChildElementHandle	The element that is to be removed TODO

SvgElementRemoveEventListener(SvgElementHandle, TInt, SvgAttrType)

IMPORT_C void	SvgElementRemoveEventListener	(	SvgElementHandle	aElementHandle,
			TInt	aListener,
			SvgAttrType	aType
		)

Remove event listener from the given element. Note: need to replace void* with specific class NOTE: Java doesn't use this method.

Since: 1.0

Remove event listener from the given element. Note: need to replace void* with specific class

Parameters

SvgElementHandle aElementHandle	The element handle.
TInt aListener	Listener
SvgAttrType aType	Type

SvgElementSetColorAttribute(SvgElementHandle, SvgAttrType, TInt, TInt, TInt)

IMPORT_C void	SvgElementSetColorAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttribute,
			TInt	aRedValue,
			TInt	aGreenValue,
			TInt	aBlueValue
		)

Set a color attribute for the given element.

Since: 1.0

org.w3c.dom.svg.SVGRGBColor Set a color attribute for the given element.

Parameters

SvgElementHandle aElementHandle	The element.
SvgAttrType aAttribute	Attribute's name
TInt aRedValue	The red value
TInt aGreenValue	The green value
TInt aBlueValue	The blue value

SvgElementSetEnumAttribute(SvgElementHandle, SvgAttrType, short)

IMPORT_C void	SvgElementSetEnumAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttribute,
			short	aValue
		)

Set enum attribute (trait) value.

Since: 1.0

org.w3c.dom.svg.SVGElement Set enum attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aAttribute	The name of the attribute (trait) to be set.
short aValue	The value of the attribute (trait) to be set.

SvgElementSetFloatAttribute(SvgElementHandle, SvgAttrType, TReal32)

IMPORT_C void	SvgElementSetFloatAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttribute,
			TReal32	aFloatValue
		)

Set the attribute (trait) value as float.

Since: 1.0

org.w3c.dom.svg.SVGElement::getFloatTrait() Set a float attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aAttribute	The name of the attribute (trait) to be set.
TReal32 aFloatValue	The value of the attribute (trait) to be set as float.

SvgElementSetMatrixAttribute(SvgElementHandle, SvgAttrType, TReal32, TReal32, TReal32, TReal32, TReal32, TReal32)

IMPORT_C void	SvgElementSetMatrixAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aMatrixAttribute,
			TReal32	aAVal,
			TReal32	aBVal,
			TReal32	aCVal,
			TReal32	aDVal,
			TReal32	aEVal,
			TReal32	aFVal
		)

Set the matrix attribute (trait) values.

 [aAVal aCVal aEVal]
 [aBVal aDVal aFVal]

Since: 1.0

org.w3c.dom.svg.SVGElement::setMatrixTrait() Set the matrix attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aMatrixAttribute	The name of the attribute (trait) to be set.
TReal32 aAVal	The x scaling component
TReal32 aBVal	The y shearing component
TReal32 aCVal	The x shearing component
TReal32 aDVal	The y scaling component
TReal32 aEVal	The x translation component
TReal32 aFVal	The y translation component

SvgElementSetPathAttribute(SvgElementHandle, SvgAttrType, SvgPathHandle)

IMPORT_C void	SvgElementSetPathAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aPathAttribute,
			SvgPathHandle	aPathHandle
		)

Set the path attribute (trait) value. NOTE: Value is a copy in the trait so subsequent changes to the given aPathHandle have no effect on the value of the attribute (trait).

Since: 1.0

org.w3c.dom.svg.SVGElement::setPathTrait() org.w3c.dom.svg.SVGPath

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aPathAttribute	The name of the attribute (trait) to be set.
SvgPathHandle aPathHandle	The value of the attribute (trait) to be set as.

SvgElementSetRectAttribute(SvgElementHandle, SvgAttrType, TReal32, TReal32, TReal32, TReal32)

IMPORT_C void	SvgElementSetRectAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aRectAttribute,
			TReal32	aX,
			TReal32	aY,
			TReal32	aWidth,
			TReal32	aHeight
		)

Set the rectangle attribute (trait) values.

Since: 1.0

org.w3c.dom.svg.SVGElement::setRectTrait() Set the rectangle attribute value.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgAttrType aRectAttribute	The name of the attribute (trait) to be set.
TReal32 aX	X coordinate.
TReal32 aY	Y coordinate.
TReal32 aWidth	Width.
TReal32 aHeight	Height.

SvgElementSetStringAttribute(SvgElementHandle, SvgAttrType, const TPtrC16 &)

IMPORT_C void	SvgElementSetStringAttribute	(	SvgElementHandle	aElementHandle,
			SvgAttrType	aAttributeName,
			const TPtrC16 &	aAttributeValue
		)

Set a string attribute in the given element.

Since: 1.0

org.w3c.dom.svg.SVGElement Set a string attribute on the given element.

Parameters

SvgElementHandle aElementHandle	The SVG element handle.
SvgAttrType aAttributeName	Attribute's name
const TPtrC16 & aAttributeValue	Atribute's value.

SvgElementUpdatePath(SvgElementHandle, SvgPathHandle)

IMPORT_C void	SvgElementUpdatePath	(	SvgElementHandle	aElementHandle,
			SvgPathHandle	aPathHandle
		)

Update path info. NOTE: Java doesn't use this method.

Since: 1.0

Update path info.

Parameters

SvgElementHandle aElementHandle	The element handle.
SvgPathHandle aPathHandle	The path handle.

SvgEngineCreate()

IMPORT_C SvgEngineHandle

SvgEngineCreate

(

)

Create an SvgEngine instance. NOTE: Java side uses engine only during rendering phase.

Since: 1.0

javax.microedition.m2g.ScalableGraphics::render() Create an SvgEngine instance.

SvgEngineDestroy(SvgEngineHandle)

IMPORT_C void

SvgEngineDestroy

(

aEngineHandle

)

Request to destroy the given engine by handle. NOTE: Java MIDlet could use multiple engines.

Since: 1.0

Request to destroy the given engine by handle.

Parameters

SvgEngineHandle aEngineHandle

Engine

SvgEngineRenderDocument(SvgEngineHandle, SvgDocumentHandle, TInt, TInt, TReal32)

IMPORT_C void	SvgEngineRenderDocument	(	SvgEngineHandle	aEngineHandle,
			SvgDocumentHandle	aDocumentHandle,
			TInt	aSurfaceHandle,
			TInt	aSurfaceMaskHandle = NULL,
			TReal32	aCurrentTime = 0.0f
		)

Request to render the SVG document.

Since: 1.0

javax.microedition.m2g.ScalableGraphics::render() Request to render the SVG document.

Parameters

SvgEngineHandle aEngineHandle	Svg engine handle
SvgDocumentHandle aDocumentHandle	Svg document handle
TInt aSurfaceHandle	Svg surface handle
TInt aSurfaceMaskHandle = NULL	Mask that defines what pixels should be thrown and what not.
TReal32 aCurrentTime = 0.0f	Current frame time. NOTE might be obsolete since the

SvgEngineRenderDocumentL(SvgEngineHandle, SvgDocumentHandle, TInt, const TPoint &, const TRect &, TReal32, TReal32)

IMPORT_C void	SvgEngineRenderDocumentL	(	SvgEngineHandle	aEngineHandle,
			SvgDocumentHandle	aDocumentHandle,
			TInt	aSurfaceHandle,
			const TPoint &	aAnchor,
			const TRect &	aRenderArea,
			TReal32	aCurrentTime,
			TReal32	aAlpha
		)

Parameters

SvgEngineHandle aEngineHandle
SvgDocumentHandle aDocumentHandle
TInt aSurfaceHandle
const TPoint & aAnchor
const TRect & aRenderArea
TReal32 aCurrentTime
TReal32 aAlpha

SvgEngineResume(SvgEngineHandle)

IMPORT_C void

SvgEngineResume

(

aEngineHandle

)

Parameters

SvgEngineHandle aEngineHandle

SvgEngineSetRenderQuality(SvgEngineHandle, TInt)

IMPORT_C void	SvgEngineSetRenderQuality	(	SvgEngineHandle	aEngineHandle,
			TInt	aQuality
		)

Request to set render quality. Set the quality of rendering. It can take one of the values, RENDERING_QUALITY_LOW (=1) or RENDERING_QUALITY_HIGH (=2). Default value is RENDERING_QUALITY_HIGH. The implementation of these quality levels is implementation dependent and should be mapped to definitions in SVG spec (shape, text, image and color rendering)

Since: 1.0

javax.microedition.m2g.ScalableGraphics::setRenderingQuality() Request to set render quality.

Parameters

SvgEngineHandle aEngineHandle	Engine handle.
TInt aQuality	This value indicates the quality of rendering required.

SvgEngineStart(SvgEngineHandle)

IMPORT_C void

SvgEngineStart

(

aEngineHandle

)

Parameters

SvgEngineHandle aEngineHandle

SvgEngineStop(SvgEngineHandle)

IMPORT_C void

SvgEngineStop

(

aEngineHandle

)

Parameters

SvgEngineHandle aEngineHandle

SvgEnumerationMappingJSRtoSVG(const TInt, TInt)

TInt	SvgEnumerationMappingJSRtoSVG	(	const TInt	aAttributeId,
			TInt	aJsrEnumValue
		)	[private]

Gets the Enumeration value mapping from JSR to SVG. Attribute t

This maps the Enumeration Mapping form JSR specific to SVG specific

Parameters

const TInt aAttributeId
TInt aJsrEnumValue

SvgEnumerationMappingSVGtoJSR(const TInt, TInt32)

TInt	SvgEnumerationMappingSVGtoJSR	(	const TInt	aAttributeId,
			TInt32	aSvgEnumValue
		)	[private]

Gets the Enumeration value mapping from JSR to SVG. Attribute t

This maps the Enumeration from SVG to JSR.

Parameters

const TInt aAttributeId
TInt32 aSvgEnumValue

SvgEnumerationtoStringMappingJSRtoSVG(const TInt, short, TDes &)

TInt	SvgEnumerationtoStringMappingJSRtoSVG	(	const TInt	aAttributeId,
			short	aJsrEnumValue,
			TDes &	aValue
		)	[private]

Gets the Enumeration value to string mapping from JSR to SVG. Attribute t

This maps the Enumeration from JSR to SVG. SVG enumerated value here is string type.

Parameters

const TInt aAttributeId
short aJsrEnumValue
TDes & aValue

The path handle.

SvgPathAddCurveTo(SvgPathHandle, TReal32, TReal32, TReal32, TReal32, TReal32, TReal32)

IMPORT_C void	SvgPathAddCurveTo	(	SvgPathHandle	aPathHandle,
			TReal32	aX1,
			TReal32	aY1,
			TReal32	aX2,
			TReal32	aY2,
			TReal32	aX3,
			TReal32	aY3
		)

Appends 'C' (absolute cubic curve) segment to the path.

Since: 1.0

org.w3c.dom.svg.SVGPath::curveTo() Add a curve-to command to the given path.

Parameters

SvgPathHandle aPathHandle	The path handle.
TReal32 aX1	the x-axis coordinate of the first control point.
TReal32 aY1	the y-axis coordinate of the first control point.
TReal32 aX2	the x-axis coordinate of the second end point.
TReal32 aY2	the y-axis coordinate of the second end point.
TReal32 aX3	the x-axis coordinate of the final end point.
TReal32 aY3	the y-axis coordinate of the final end point.

SvgPathAddLineTo(SvgPathHandle, TReal32, TReal32)

IMPORT_C void	SvgPathAddLineTo	(	SvgPathHandle	aPathHandle,
			TReal32	aX,
			TReal32	aY
		)

Appends 'L' (absolute line) segment to the path with the specified coordinates.

Since: 1.0

org.w3c.dom.svg.SVGPath::moveTo() Add a line-to command to the given path.

Parameters

SvgPathHandle aPathHandle	The path handle.
TReal32 aX	The x-axis coordinate for the specified point.
TReal32 aY	The y-axis coordinate for the specified point.

SvgPathAddMoveTo(SvgPathHandle, TReal32, TReal32)

IMPORT_C void	SvgPathAddMoveTo	(	SvgPathHandle	aPathHandle,
			TReal32	aX,
			TReal32	aY
		)

Appends 'M' (absolute move) segment to the path with the specified coordinates.

Since: 1.0

org.w3c.dom.svg.SVGPath::moveTo() Add a move-to command to the given path.

Parameters

SvgPathHandle aPathHandle	The path handle.
TReal32 aX	The x-axis coordinate for the specified point.
TReal32 aY	The y-axis coordinate for the specified point.

SvgPathAddQuadTo(SvgPathHandle, TReal32, TReal32, TReal32, TReal32)

IMPORT_C void	SvgPathAddQuadTo	(	SvgPathHandle	aPathHandle,
			TReal32	aX1,
			TReal32	aY1,
			TReal32	aX2,
			TReal32	aY2
		)

Appends 'Q' (absolute quadratic curve) segment to the path.

Since: 1.0

org.w3c.dom.svg.SVGPath::quadTo() Add a quad-to command to the given path.

Parameters

SvgPathHandle aPathHandle	The path handle.
TReal32 aX1	the x-axis coordinate of the first control point.
TReal32 aY1	the y-axis coordinate of the first control point.
TReal32 aX2	the x-axis coordinate of the final end point.
TReal32 aY2	the y-axis coordinate of the final end point.

SvgPathCreate()

IMPORT_C SvgPathHandle

SvgPathCreate

(

)

Creates new path object that is empty. This object can be used to modify value of path traits

Since: 1.0

org.w3c.dom.svg.SVGSVGElement::createSVGPath() org.w3c.dom.svg.SVGPath Create an empty path

SvgPathDestroy(SvgPathHandle)

IMPORT_C void

SvgPathDestroy

(

SvgPathHandle

aPathHandle

)

Destroy the specified path path

Since: 1.0

org.w3c.dom.svg.SVGPath Destroy the specified path path

Parameters

SvgPathHandle aPathHandle

Handle to the path to be deleted.

SvgPathGetSegmentCount(SvgPathHandle)

IMPORT_C TInt

SvgPathGetSegmentCount

(

SvgPathHandle

aPathHandle

)

Get the segment count of the given path.

Since: 1.0

org.w3c.dom.svg.SVGPath::getNumberOfSegments() Get the segment count for the given path.

Parameters

SvgPathHandle aPathHandle

The path handle.

SvgPathGetSegmentParameter(SvgPathHandle, TInt, TInt)

IMPORT_C TReal32	SvgPathGetSegmentParameter	(	SvgPathHandle	aPathHandle,
			TInt	aSegmentIndex,
			TInt	aSegmentParameterIndex
		)

Returns segment parameter by zero-based command index and zero-based parametr index.

Since: 1.0

org.w3c.dom.svg.SVGPath::getSegmentParameter() Get the segment parameter for the given path.

Parameters

SvgPathHandle aPathHandle	The path handle.
TInt aSegmentIndex	The command index for the segment command to retrieve.
TInt aSegmentParameterIndex	The parameter index for the segment parameter to retrieve.

SvgPathGetSegmentType(SvgPathHandle, TInt)

IMPORT_C TInt	SvgPathGetSegmentType	(	SvgPathHandle	aPathHandle,
			TInt	aSegmentIndex
		)

Returns segment command by zero-based command index. Returns one of MOVE_TO, LINE_TO, CURVE_TO, QUAD_TO or CLOSE.

Since: 1.0

org.w3c.dom.svg.SVGPath::getSegment() Get the segment type for the given path.

Parameters

SvgPathHandle aPathHandle	The path handle.
TInt aSegmentIndex	The command index for the segment command to retrieve.

SvgRenderingSurfaceClearBuffer(SvgSurfaceHandle)

IMPORT_C void

SvgRenderingSurfaceClearBuffer

(

aSurface

)

Clear the Svg Rendering Surface. NOTE: Java doesn't use this method.

Since: 1.0

Parameters

SvgSurfaceHandle aSurface

Surface

SvgRenderingSurfaceCreate(TInt, TInt)

IMPORT_C SvgSurfaceHandle	SvgRenderingSurfaceCreate	(	TInt	aWidth,
			TInt	aHeight
		)

Create a Svg Rendering Surface. NOTE: Java doesn't use this method.

Since: 1.0

Create a Svg Rendering Surface.

Parameters

TInt aWidth	Width
TInt aHeight	Height

SvgRenderingSurfaceDestroy(SvgSurfaceHandle)

IMPORT_C void

SvgRenderingSurfaceDestroy

(

aSurface

)

Destroy a Svg Rendering Surface. NOTE: Java doesn't use this method.

Since: 1.0

Destroy a Svg Rendering Surface.

Parameters

SvgSurfaceHandle aSurface

Surface

SvgRenderingSurfaceGetBuffer(SvgSurfaceHandle)

IMPORT_C TUint *

SvgRenderingSurfaceGetBuffer

(

aSurface

)

Get a pointer to the Svg Rendering surface. NOTE: Java doesn't use this method.

Since: 1.0

Get a pointer to the Svg Rendering surface.

Parameters

SvgSurfaceHandle aSurface

Surface

SvgRenderingSurfaceGetHeight(SvgSurfaceHandle)

IMPORT_C TInt

SvgRenderingSurfaceGetHeight

(

aSurface

)

Get the height of the Svg Rendering Surface. NOTE: Java doesn't use this method.

Since: 1.0

Get the height of the Svg Rendering Surface

Parameters

SvgSurfaceHandle aSurface

Surface

SvgRenderingSurfaceGetWidth(SvgSurfaceHandle)

IMPORT_C TInt

SvgRenderingSurfaceGetWidth

(