R Python Language Binding for SVG

This appendix is normative.

R.1 Module dom

Error constants for DOMException

The DOMException class holds the following constants:

INDEX_SIZE_ERR

This constant is an int and its value is 1.

DOMSTRING_SIZE_ERR

This constant is an int and its value is 2.

HIERARCHY_REQUEST_ERR

This constant is an int and its value is 3.

WRONG_DOCUMENT_ERR

This constant is an int and its value is 4.

INVALID_CHARACTER_ERR

This constant is an int and its value is 5.

NO_DATA_ALLOWED_ERR

This constant is an int and its value is 6.

NO_MODIFICATION_ALLOWED_ERR

This constant is an int and its value is 7.

NOT_FOUND_ERR

This constant is an int and its value is 8.

NOT_SUPPORTED_ERR

This constant is an int and its value is 9.

INUSE_ATTRIBUTE_ERR

This constant is an int and its value is 10.

INVALID_STATE_ERR

This constant is an int and its value is 11.

SYNTAX_ERR

This constant is an int and its value is 12.

INVALID_MODIFICATION_ERR

This constant is an int and its value is 13.

NAMESPACE_ERR

This constant is an int and its value is 14.

INVALID_ACCESS_ERR

This constant is an int and its value is 15.

VALIDATION_ERR

This constant is an int and its value is 16.

TYPE_MISMATCH_ERR

This constant is an int and its value is 17.

Exception Class DOMException

The DOMException class has the following attributes:

code

This attribute holds a int.

Class Node

The Node class has the following attributes:

namespaceURI

This attribute holds a unicode.

localName

This attribute holds a unicode.

parentNode

This attribute holds a Node.

ownerDocument

This attribute holds a Document.

textContent

This attribute holds a unicode.

The Node class has the following methods:

appendChild(newChild)

This method returns a Node. The newChild argument is a Node.

insertBefore(newChild, refChild)

This method returns a Node. The newChild argument is a Node. The refChild argument is a Node.

removeChild(oldChild)

This method returns a Node. The oldChild argument is a Node.

cloneNode(deep)

This method returns a Node. The deep argument is a boolean.

Class Element

Element inherits from Node, ElementTraversal.

The Element class has the following methods:

getAttributeNS(namespaceURI, localName)

This method returns a unicode. The namespaceURI argument is a unicode. The localName argument is a unicode.

setAttributeNS(namespaceURI, qualifiedName, value)

This method has no return value. The namespaceURI argument is a unicode. The qualifiedName argument is a unicode. The value argument is a unicode.

getAttribute(name)

This method returns a unicode. The name argument is a unicode.

setAttribute(name, value)

This method has no return value. The name argument is a unicode. The value argument is a unicode.

Class Document

Document inherits from Node.

The Document class has the following attributes:

implementation

This attribute holds a DOMImplementation.

documentElement

This attribute holds a Element.

The Document class has the following methods:

createElementNS(namespaceURI, qualifiedName)

This method returns a Element. The namespaceURI argument is a unicode. The qualifiedName argument is a unicode.

getElementById(elementId)

This method returns a Element. The elementId argument is a unicode.

Class ElementTraversal

The ElementTraversal class has the following attributes:

firstElementChild

This attribute holds a Element.

lastElementChild

This attribute holds a Element.

nextElementSibling

This attribute holds a Element.

previousElementSibling

This attribute holds a Element.

Class DOMImplementation

R.2 Module events

Class EventTarget

The EventTarget class has the following methods:

addEventListener(type, listener, useCapture)

This method has no return value. The type argument is a unicode. The listener argument is a EventListener. The useCapture argument is a boolean.

removeEventListener(type, listener, useCapture)

This method has no return value. The type argument is a unicode. The listener argument is a EventListener. The useCapture argument is a boolean.

addEventListenerNS(namespaceURI, type, listener, useCapture, evtGroup)

This method has no return value. The namespaceURI argument is a unicode. The type argument is a unicode. The listener argument is a EventListener. The useCapture argument is a boolean. The evtGroup argument is a object.

removeEventListenerNS(namespaceURI, type, listener, useCapture)

This method has no return value. The namespaceURI argument is a unicode. The type argument is a unicode. The listener argument is a EventListener. The useCapture argument is a boolean.

Class EventListener

The EventListener class has the following methods:

handleEvent(evt)

This method has no return value. The evt argument is a Event.

Class Event

The Event class has the following attributes:

target

This attribute holds a EventTarget.

currentTarget

This attribute holds a EventTarget.

type

This attribute holds a unicode.

namespaceURI

This attribute holds a unicode.

cancelable

This attribute holds a boolean.

defaultPrevented

This attribute holds a boolean.

The Event class has the following methods:

stopPropagation()

This method has no return value.

preventDefault()

This method has no return value.

Class MouseEvent

MouseEvent inherits from UIEvent.

The MouseEvent class has the following attributes:

screenX

This attribute holds a long.

screenY

This attribute holds a long.

clientX

This attribute holds a long.

clientY

This attribute holds a long.

button

This attribute holds a int.

Class MouseWheelEvent

MouseWheelEvent inherits from MouseEvent.

The MouseWheelEvent class has the following attributes:

wheelDelta

This attribute holds a long.

Class TextEvent

TextEvent inherits from UIEvent.

The TextEvent class has the following attributes:

data

This attribute holds a unicode.

Class KeyboardEvent

KeyboardEvent inherits from UIEvent.

The KeyboardEvent class has the following attributes:

keyIdentifier

This attribute holds a unicode.

Class UIEvent

UIEvent inherits from Event.

The UIEvent class has the following attributes:

detail

This attribute holds a long.

Class ProgressEvent

ProgressEvent inherits from Event.

The ProgressEvent class has the following attributes:

lengthComputable

This attribute holds a boolean.

loaded

This attribute holds a long.

total

This attribute holds a long.

Class constants ConnectionEvent

The ConnectionEvent class has the following constants:

NO_ERR

This constant is an int and its value is 0.

NETWORK_ERR

This constant is an int and its value is 1.

Class ConnectionEvent

ConnectionEvent inherits from Event.

The ConnectionEvent class has the following attributes:

errorCode

This attribute holds a int.

receivedData

This attribute holds a Python list.

R.3 Module smil

Class ElementTimeControl

The ElementTimeControl class has the following methods:

beginElementAt(offset)

This method has no return value. The offset argument is a float.

beginElement()

This method has no return value.

endElementAt(offset)

This method has no return value. The offset argument is a float.

endElement()

This method has no return value.

Class TimeEvent

TimeEvent inherits from Event.

The TimeEvent class has the following attributes:

detail

This attribute holds a long.

R.4 Module global

Class Global

Error constants for GlobalException

The GlobalException class holds the following constants:

NOT_CONNECTED_ERR

This constant is an int and its value is 1.

ENCODING_ERR

This constant is an int and its value is 2.

DENIED_ERR

This constant is an int and its value is 3.

UNKNOWN_ERR

This constant is an int and its value is 4.

Exception Class GlobalException

The GlobalException class has the following attributes:

code

This attribute holds a int.

Class Connection

Connection inherits from EventTarget.

The Connection class has the following attributes:

connected

This attribute holds a boolean.

The Connection class has the following methods:

connect(host, port)

This method has no return value. The host argument is a unicode. The port argument is a int.

send(data)

This method has no return value. The data argument is a Python list.

close()

This method has no return value.

Class Timer

Timer inherits from events::EventTarget.

The Timer class has the following attributes:

delay

This attribute holds a long.

repeatInterval

This attribute holds a long.

running

This attribute holds a boolean.

The Timer class has the following methods:

start()

This method has no return value.

stop()

This method has no return value.

R.5 Module svg

Error constants for SVGException

The SVGException class holds the following constants:

SVG_WRONG_TYPE_ERR

This constant is an int and its value is 0.

SVG_INVALID_VALUE_ERR

This constant is an int and its value is 1.

SVG_MATRIX_NOT_INVERTABLE

This constant is an int and its value is 2.

Exception Class SVGException

The SVGException class has the following attributes:

code

This attribute holds a int.

Class SVGDocument

SVGDocument inherits from Document, EventTarget.

The SVGDocument class has the following attributes:

global

This attribute holds a SVGGlobal.

Class SVGElementInstance

SVGElementInstance inherits from EventTarget.

The SVGElementInstance class has the following attributes:

correspondingElement

This attribute holds a SVGElement.

correspondingUseElement

This attribute holds a SVGElement.

Class constants SVGSVGElement

The SVGSVGElement class has the following constants:

NAV_AUTO

This constant is an int and its value is 1.

NAV_NEXT

This constant is an int and its value is 2.

NAV_PREV

This constant is an int and its value is 3.

NAV_UP

This constant is an int and its value is 4.

NAV_UP_RIGHT

This constant is an int and its value is 5.

NAV_RIGHT

This constant is an int and its value is 6.

NAV_DOWN_RIGHT

This constant is an int and its value is 7.

NAV_DOWN

This constant is an int and its value is 8.

NAV_DOWN_LEFT

This constant is an int and its value is 9.

NAV_LEFT

This constant is an int and its value is 10.

NAV_UP_LEFT

This constant is an int and its value is 11.

Class SVGSVGElement

SVGSVGElement inherits from SVGLocatableElement, SVGTimedElement.

The SVGSVGElement class has the following attributes:

currentScale

This attribute holds a float.

currentRotate

This attribute holds a float.

currentTranslate

This attribute holds a SVGPoint.

viewport

This attribute holds a SVGRect.

The SVGSVGElement class has the following methods:

getCurrentTime()

This method returns a float.

setCurrentTime(seconds)

This method has no return value. The seconds argument is a float.

createSVGMatrixComponents(a, b, c, d, e, f)

This method returns a SVGMatrix. The a argument is a float. The b argument is a float. The c argument is a float. The d argument is a float. The e argument is a float. The f argument is a float.

createSVGRect()

This method returns a SVGRect.

createSVGPoint()

This method returns a SVGPoint.

createSVGPath()

This method returns a SVGPath.

createSVGRGBColor(red, green, blue)

This method returns a SVGRGBColor. The red argument is a float. The green argument is a float. The blue argument is a float.

moveFocus(motionType)

This method has no return value. The motionType argument is a int.

setFocus(theObject)

This method has no return value. The theObject argument is a EventTarget.

getCurrentFocusedObject()

This method returns a EventTarget.

Class SVGRGBColor

The SVGRGBColor class has the following attributes:

red

This attribute holds a long.

green

This attribute holds a long.

blue

This attribute holds a long.

Class SVGRect

The SVGRect class has the following attributes:

x

This attribute holds a float.

y

This attribute holds a float.

width

This attribute holds a float.

height

This attribute holds a float.

Class SVGPoint

The SVGPoint class has the following attributes:

x

This attribute holds a float.

y

This attribute holds a float.

The SVGPoint class has the following methods:

matrixTransform(matrix)

This method returns a SVGPoint. The matrix argument is a SVGMatrix.

Class constants SVGPath

The SVGPath class has the following constants:

MOVE_TO

This constant is an int and its value is 77.

LINE_TO

This constant is an int and its value is 76.

CURVE_TO

This constant is an int and its value is 67.

QUAD_TO

This constant is an int and its value is 81.

CLOSE

This constant is an int and its value is 90.

Class SVGPath

The SVGPath class has the following attributes:

numberOfSegments

This attribute holds a long.

The SVGPath class has the following methods:

getSegment(cmdIndex)

This method returns a int. The cmdIndex argument is a long.

getSegmentParam(cmdIndex, paramIndex)

This method returns a float. The cmdIndex argument is a long. The paramIndex argument is a long.

moveTo(x, y)

This method has no return value. The x argument is a float. The y argument is a float.

lineTo(x, y)

This method has no return value. The x argument is a float. The y argument is a float.

quadTo(x1, y1, x2, y2)

This method has no return value. The x1 argument is a float. The y1 argument is a float. The x2 argument is a float. The y2 argument is a float.

curveTo(x1, y1, x2, y2, x3, y3)

This method has no return value. The x1 argument is a float. The y1 argument is a float. The x2 argument is a float. The y2 argument is a float. The x3 argument is a float. The y3 argument is a float.

close()

This method has no return value.

Class SVGMatrix

The SVGMatrix class has the following methods:

getComponent(index)

This method returns a float. The index argument is a long.

mMultiply(secondMatrix)

This method returns a SVGMatrix. The secondMatrix argument is a SVGMatrix.

inverse()

This method returns a SVGMatrix.

mTranslate(x, y)

This method returns a SVGMatrix. The x argument is a float. The y argument is a float.

mScale(scaleFactor)

This method returns a SVGMatrix. The scaleFactor argument is a float.

mRotate(angle)

This method returns a SVGMatrix. The angle argument is a float.

Class SVGLocatable

The SVGLocatable class has the following methods:

getBBox()

This method returns a SVGRect.

getScreenCTM()

This method returns a SVGMatrix.

getScreenBBox()

This method returns a SVGRect.

Class SVGLocatableElement

SVGLocatableElement inherits from SVGElement, SVGLocatable.

Class TraitAccess

The TraitAccess class has the following methods:

getTrait(name)

This method returns a unicode. The name argument is a unicode.

getTraitNS(namespaceURI, name)

This method returns a unicode. The namespaceURI argument is a unicode. The name argument is a unicode.

getFloatTrait(name)

This method returns a float. The name argument is a unicode.

getFloatListTrait(name)

This method returns a Python list. The name argument is a unicode.

getMatrixTrait(name)

This method returns a SVGMatrix. The name argument is a unicode.

getRectTrait(name)

This method returns a SVGRect. The name argument is a unicode.

getPathTrait(name)

This method returns a SVGPath. The name argument is a unicode.

getRGBColorTrait(name)

This method returns a SVGRGBColor. The name argument is a unicode.

getPresentationTrait(name)

This method returns a unicode. The name argument is a unicode.

getPresentationTraitNS(namespaceURI, name)

This method returns a unicode. The namespaceURI argument is a unicode. The name argument is a unicode.

getFloatPresentationTrait(name)

This method returns a float. The name argument is a unicode.

getFloatListPresentationTrait(name)

This method returns a Python list. The name argument is a unicode.

getMatrixPresentationTrait(name)

This method returns a SVGMatrix. The name argument is a unicode.

getRectPresentationTrait(name)

This method returns a SVGRect. The name argument is a unicode.

getPathPresentationTrait(name)

This method returns a SVGPath. The name argument is a unicode.

getRGBColorPresentationTrait(name)

This method returns a SVGRGBColor. The name argument is a unicode.

setTrait(name, value)

This method has no return value. The name argument is a unicode. The value argument is a unicode.

setTraitNS(namespaceURI, name, value)

This method has no return value. The namespaceURI argument is a unicode. The name argument is a unicode. The value argument is a unicode.

setFloatTrait(name, value)

This method has no return value. The name argument is a unicode. The value argument is a float.

setFloatListTrait(name, value)

This method has no return value. The name argument is a unicode. The value argument is a Python list.

setMatrixTrait(name, matrix)

This method has no return value. The name argument is a unicode. The matrix argument is a SVGMatrix.

setRectTrait(name, rect)

This method has no return value. The name argument is a unicode. The rect argument is a SVGRect.

setPathTrait(name, path)

This method has no return value. The name argument is a unicode. The path argument is a SVGPath.

setRGBColorTrait(name, color)

This method has no return value. The name argument is a unicode. The color argument is a SVGRGBColor.

Class SVGElement

SVGElement inherits from Element, EventTarget, TraitAccess.

The SVGElement class has the following attributes:

id

This attribute holds a unicode.

Class SVGTimedElement

SVGTimedElement inherits from SVGElement, smil::ElementTimeControl.

The SVGTimedElement class has the following attributes:

isPaused

This attribute holds a boolean.

The SVGTimedElement class has the following methods:

pauseElement()

This method has no return value.

resumeElement()

This method has no return value.

Class SVGAnimationElement

SVGAnimationElement inherits from SVGTimedElement.

Class SVGVisualMediaElement

SVGVisualMediaElement inherits from SVGLocatableElement, SVGTimedElement.

Class SVGGlobal

SVGGlobal inherits from Global.

The SVGGlobal class has the following attributes:

document

This attribute holds a Document.

parent

This attribute holds a Global.

The SVGGlobal class has the following methods:

createConnection()

This method returns a Connection.

createTimer(initialInterval, repeatInterval)

This method returns a Timer. The initialInterval argument is a long. The repeatInterval argument is a long.

gotoLocation(newIRI)

This method has no return value. The newIRI argument is a unicode.

binaryToString(octets, encoding)

This method returns a unicode. The octets argument is a Python list. The encoding argument is a unicode.

stringToBinary(data, encoding)

This method returns a Python list. The data argument is a unicode. The encoding argument is a unicode.

getURL(iri, callback)

This method has no return value. The iri argument is a unicode. The callback argument is a AsyncStatusCallback.

postURL(iri, data, callback, type, encoding)

This method has no return value. The iri argument is a unicode. The data argument is a unicode. The callback argument is a AsyncStatusCallback. The type argument is a unicode. The encoding argument is a unicode.

parseXML(data, contextDoc)

This method returns a Node. The data argument is a unicode. The contextDoc argument is a Document.

Class AsyncStatusCallback

The AsyncStatusCallback class has the following methods:

operationComplete(status)

This method has no return value. The status argument is a AsyncURLStatus.

Class AsyncURLStatus

The AsyncURLStatus class has the following attributes:

success

This attribute holds a boolean.

contentType

This attribute holds a unicode.

content

This attribute holds a unicode.

Class EventListenerInitializer2

The EventListenerInitializer2 class has the following methods:

initializeEventListeners(scriptElement)

This method has no return value. The scriptElement argument is a Element.

createEventListener(handlerElement)

This method returns a EventListener. The handlerElement argument is a Element.