odfpy api generated by epydoc

API Documentation

API Documentation

June 4, 2009

Contents

Contents 1

1 Package odf 2

1.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2 Module odf.anim 3

2.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3 Module odf.attrconverters 4

3.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53.3 Class AttrConverters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

4 Module odf.chart 7


5 Module odf.config 9


6 Module odf.dc 10


7 Module odf.dr3d 11


8 Module odf.draw 12


9 Module odf.easyliststyle 15

9.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1

CONTENTS CONTENTS

9.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

10 Module odf.element 16

10.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1610.2 Class IllegalChild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

10.2.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1610.2.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

10.3 Class IllegalText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1710.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1710.3.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

10.4 Class Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1710.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1810.4.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1810.4.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

10.5 Class Childless . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1810.5.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1910.5.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

10.6 Class Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1910.6.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1910.6.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

10.7 Class CDATASection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2010.7.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2110.7.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

10.8 Class Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2110.8.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210.8.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2310.8.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

11 Module odf.elementtypes 24

11.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

12 Module odf.form 25


13 Module odf.grammar 27

13.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

14 Module odf.load 28

14.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2814.2 Class LoadParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

14.2.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2814.2.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

15 Module odf.manifest 30


16 Module odf.math 31


17 Module odf.meta 32

2

CONTENTS CONTENTS


18 Module odf.namespaces 33

18.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

19 Module odf.number 35


20 Module odf.odf2moinmoin 37

20.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3720.2 Class TextProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

20.2.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3720.3 Class ParagraphProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

20.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3820.4 Class ListProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

20.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3820.5 Class ODF2MoinMoin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38


21 Module odf.odf2xhtml 41

21.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4121.2 Class StyleToCSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

21.2.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4121.3 Class TagStack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

21.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4321.4 Class ODF2XHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43


22 Module odf.odfmanifest 52

22.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5222.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5222.3 Class ODFManifestHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

22.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

23 Module odf.office 54


24 Module odf.opendocument 56

24.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5624.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5624.3 Class OpaqueObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

24.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5724.4 Class OpenDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57


25 Module odf.presentation 60

25.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

3

CONTENTS CONTENTS

25.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

26 Module odf.script 62


27 Module odf.style 63


28 Module odf.svg 66


29 Module odf.table 67


30 Module odf.teletype 72

30.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7230.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7230.3 Class WhitespaceText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72


31 Module odf.text 74


32 Module odf.thumbnail 84


33 Module odf.userfield 85

33.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8533.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8533.3 Class UserFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

33.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8533.3.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8633.3.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

33.4 Class ODFContentParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8733.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

34 Module odf.xforms 89


4

Variables Package odf

1 Package odf

1.1 Modules

• anim (Section 2, p. 3)• attrconverters (Section 3, p. 4)• chart (Section 4, p. 7)• config (Section 5, p. 9)• dc (Section 6, p. 10)• dr3d (Section 7, p. 11)• draw (Section 8, p. 12)• easyliststyle (Section 9, p. 15)• element (Section 10, p. 16)• elementtypes (Section 11, p. 24)• form (Section 12, p. 25)• grammar: In principle the OpenDocument schema converted to python structures.

(Section 13, p. 27)• load (Section 14, p. 28)• manifest (Section 15, p. 30)• math (Section 16, p. 31)• meta (Section 17, p. 32)• namespaces (Section 18, p. 33)• number (Section 19, p. 35)• odf2moinmoin (Section 20, p. 37)• odf2xhtml (Section 21, p. 41)• odfmanifest (Section 22, p. 52)• office (Section 23, p. 54)• opendocument: Use OpenDocument to generate your documents.

(Section 24, p. 56)• presentation (Section 25, p. 60)• script (Section 26, p. 62)• style (Section 27, p. 63)• svg (Section 28, p. 66)• table (Section 29, p. 67)• teletype: Class for handling whitespace properly in OpenDocument.

(Section 30, p. 72)• text (Section 31, p. 74)• thumbnail (Section 32, p. 84)• userfield: Class to show and manipulate user fields in odf documents.

(Section 33, p. 85)• xforms (Section 34, p. 89)

1.2 Variables

Name Description

package Value: None

5

Variables Module odf.anim

2 Module odf.anim

2.1 Functions

Animate(**args)

Animatecolor(**args)

Animatemotion(**args)

Animatetransform(**args)

Audio(**args)

Command(**args)

Iterate(**args)

Par(**args)

Param(**args)

Seq(**args)

Set(**args)

Transitionfilter(**args)

2.2 Variables

Name Description

package Value: ’odf’

6

Module odf.attrconverters

3 Module odf.attrconverters

3.1 Functions

make NCName(arg)

cnv anyURI(attribute, arg, element)

cnv boolean(attribute, arg, element)

cnv color(attribute, arg, element)

cnv configtype(attribute, arg, element)

cnv data source has labels(attribute, arg, element)

cnv date(attribute, arg, element)

cnv dateTime(attribute, arg, element)

cnv double(attribute, arg, element)

cnv duration(attribute, arg, element)

cnv family(attribute, arg, element)

cnv ID(attribute, arg, element)

cnv IDREF(attribute, arg, element)

cnv integer(attribute, arg, element)

cnv legend position(attribute, arg, element)

cnv length(attribute, arg, element)

cnv lengthorpercent(attribute, arg, element)

cnv metavaluetype(attribute, arg, element)

cnv major minor(attribute, arg, element)

7

Variables Module odf.attrconverters

cnv namespacedToken(attribute, arg, element)

cnv NCName(attribute, arg, element)

cnv StyleNameRef(attribute, arg, element)

cnv DrawNameRef(attribute, arg, element)

cnv NCNames(attribute, arg, element)

cnv nonNegativeInteger(attribute, arg, element)

cnv percent(attribute, arg, element)

cnv points(attribute, arg, element)

cnv positiveInteger(attribute, arg, element)

cnv string(attribute, arg, element)

cnv textnoteclass(attribute, arg, element)

cnv time(attribute, arg, element)

cnv token(attribute, arg, element)

cnv viewbox(attribute, arg, element)

cnv xlinkshow(attribute, arg, element)

3.2 Variables

Name Description

pattern color Value: re.compile(r’#[0-9a-fA-F]{6}’)pattern vector3D Value: re.compile(r’\(

*-?([0-9]+(\.[0-9]*)?|\.[0-9]+)( +-?([0-9...

pattern length Value:

re.compile(r’-?([0-9]+(\.[0-9]*)?|\.[0-9]+)((cm)|(mm)|(in...pattern namespacedToken Value:

re.compile(r’[0-9a-zA-Z ]+:[0-9a-zA-Z\. -]+’)

pattern percent Value:

re.compile(r’-?([0-9]+(\.[0-9]*)?|\.[0-9]+)%’)pattern points Value: re.compile(r’-?[0-9]+,-?[0-9]+(

+-?[0-9]+,-?[0-9]+)*’)

continued on next page

8

Class AttrConverters Module odf.attrconverters

Name Description

pattern viewbox Value: re.compile(r’-?[0-9]+( +-?[0-9]+){3}$’)attrconverters Value: {((u’http://www.w3.org/1999/xlink’,

u’actuate’), None): <...


3.3 Class AttrConverters

3.3.1 Methods

convert(self, attribute, value, element)

9

Module odf.chart

4 Module odf.chart

4.1 Functions

Axis(**args)

Categories(**args)

Chart(**args)

DataPoint(**args)

Domain(**args)

ErrorIndicator(**args)

Floor(**args)

Footer(**args)

Grid(**args)

Legend(**args)

MeanValue(**args)

PlotArea(**args)

RegressionCurve(**args)

Series(**args)

StockGainMarker(**args)

StockLossMarker(**args)

StockRangeLine(**args)

Subtitle(**args)

SymbolImage(**args)

10

Variables Module odf.chart

Title(**args)

Wall(**args)

4.2 Variables

Name Description


11

Variables Module odf.config

5 Module odf.config

5.1 Functions

ConfigItem(**args)

ConfigItemMapEntry(**args)

ConfigItemMapIndexed(**args)

ConfigItemMapNamed(**args)

ConfigItemSet(**args)

5.2 Variables

Name Description


12

Variables Module odf.dc

6 Module odf.dc

6.1 Functions

Creator(**args)

Date(**args)

Description(**args)

Language(**args)

Subject(**args)

Title(**args)

6.2 Variables

Name Description


13

Variables Module odf.dr3d

7 Module odf.dr3d

7.1 Functions

Cube(**args)

Extrude(**args)

Light(Element)

Rotate(**args)

Scene(**args)

Sphere(**args)

7.2 Variables

Name Description


14

Module odf.draw

8 Module odf.draw

8.1 Functions

StyleRefElement(stylename=None, classnames=None, **args)

DrawElement(name=None, **args)

A(**args)

Applet(**args)

AreaCircle(**args)

AreaPolygon(**args)

AreaRectangle(**args)

Caption(**args)

Circle(**args)

Connector(**args)

ContourPath(**args)

ContourPolygon(**args)

Control(**args)

CustomShape(**args)

Ellipse(**args)

EnhancedGeometry(**args)

Equation(**args)

FillImage(**args)

FloatingFrame(**args)

15

Functions Module odf.draw

Frame(**args)

G(**args)

GluePoint(**args)

Gradient(**args)

Handle(**args)

Hatch(**args)

Image(**args)

ImageMap(**args)

Layer(**args)

LayerSet(**args)

Line(**args)

Marker(**args)

Measure(**args)

Object(**args)

ObjectOle(**args)

Opacity(**args)

Page(**args)

PageThumbnail(**args)

Param(**args)

Path(**args)

Plugin(**args)

16

Variables Module odf.draw

Polygon(**args)

Polyline(**args)

Rect(**args)

RegularPolygon(**args)

StrokeDash(**args)

TextBox(**args)

8.2 Variables

Name Description


17

Variables Module odf.easyliststyle

9 Module odf.easyliststyle

9.1 Functions

styleFromString(name, specifiers, delim, spacing, showAllLevels)

styleFromList(styleName, specArray, spacing, showAllLevels)

9.2 Variables

Name Description

SHOW ALL LEVELS Value: True

SHOW ONE LEVEL Value: False


18

Class IllegalChild Module odf.element

10 Module odf.element

10.1 Variables

Name Description


10.2 Class IllegalChild

object

exceptions.BaseException

exceptions.Exception

exceptions.StandardError

odf.element.IllegalChild

Complains if you add an element to a parent where it is not allowed

10.2.1 Methods

Inherited from exceptions.StandardError

init (), new ()

Inherited from exceptions.BaseException

delattr (), getattribute (), getitem (), getslice (), reduce (), repr (),setattr (), setstate (), str (), unicode ()

Inherited from object

format (), hash (), reduce ex (), sizeof (), subclasshook ()

10.2.2 Properties

Name Description

Inherited from exceptions.BaseExceptionargs, messageInherited from object

class

19

Class Node Module odf.element

10.3 Class IllegalText

object

exceptions.BaseException

exceptions.Exception

exceptions.StandardError

odf.element.IllegalText

Complains if you add text or cdata to an element where it is not allowed

10.3.1 Methods

Inherited from exceptions.StandardError

init (), new ()

Inherited from exceptions.BaseException

delattr (), getattribute (), getitem (), getslice (), reduce (), repr (),setattr (), setstate (), str (), unicode ()


format (), hash (), reduce ex (), sizeof (), subclasshook ()

10.3.2 Properties

Name Description

Inherited from exceptions.BaseExceptionargs, messageInherited from object

class

10.4 Class Node

xml.dom.Node

odf.element.Node

Known Subclasses: odf.element.Text, odf.element.Element

20

Class Childless Module odf.element

super class for more specific nodes

10.4.1 Methods

hasChildNodes(self )

Tells whether this element has any children; text nodes, subelements,whatever.

insertBefore(self, newChild, refChild)

appendChild(self, node)

removeChild(self, oldChild)

10.4.2 Properties

Name Description

firstChild First child node, or None.lastChild Last child node, or None.

10.4.3 Class Variables

Name Description

parentNode Value: None

nextSibling Value: None

previousSibling Value: None

Inherited from xml.dom.NodeATTRIBUTE NODE, CDATA SECTION NODE, COMMENT NODE,DOCUMENT FRAGMENT NODE, DOCUMENT NODE,DOCUMENT TYPE NODE, ELEMENT NODE, ENTITY NODE,ENTITY REFERENCE NODE, NOTATION NODE,PROCESSING INSTRUCTION NODE, TEXT NODE

10.5 Class Childless

Known Subclasses: odf.element.CDATASection, odf.element.Text

Mixin that makes childless-ness easy to implement and avoids the complexity of the Nodemethods that deal with children.

21

Class Text Module odf.element

10.5.1 Methods

appendChild(self, node)

hasChildNodes(self )

insertBefore(self, newChild, refChild)

removeChild(self, oldChild)

replaceChild(self, newChild, oldChild)


Name Description

attributes Value: None

childNodes Value: ()

firstChild Value: None

lastChild Value: None

10.6 Class Text

odf.element.Childless

xml.dom.Node

odf.element.Node

odf.element.Text

Known Subclasses: odf.element.CDATASection

10.6.1 Methods

init (self, data)

str (self )

22

Class CDATASection Module odf.element

toXml(self, level, f )

Write XML in UTF-8

Inherited from odf.element.Childless(Section 10.5)

appendChild(), hasChildNodes(), insertBefore(), removeChild(), replaceChild()


Name Description

nodeType Value: 3

tagName Value: ’Text’

Inherited from odf.element.Childless (Section 10.5)attributes, childNodes, firstChild, lastChildInherited from odf.element.Node (Section 10.4)nextSibling, parentNode, previousSiblingInherited from xml.dom.NodeATTRIBUTE NODE, CDATA SECTION NODE, COMMENT NODE,DOCUMENT FRAGMENT NODE, DOCUMENT NODE,DOCUMENT TYPE NODE, ELEMENT NODE, ENTITY NODE,ENTITY REFERENCE NODE, NOTATION NODE,PROCESSING INSTRUCTION NODE, TEXT NODE

10.7 Class CDATASection



xml.dom.Node

odf.element.Node

odf.element.Text

odf.element.CDATASection

23

Class Element Module odf.element

10.7.1 Methods


Write XML in UTF-8

Overrides: odf.element.Text.toXml extit(inherited documentation)

Inherited from odf.element.Childless(Section 10.5)

appendChild(), hasChildNodes(), insertBefore(), removeChild(), replaceChild()

Inherited from odf.element.Text(Section 10.6)

init (), str ()


Name Description

nodeType Value: 4

Inherited from odf.element.Childless (Section 10.5)attributes, childNodes, firstChild, lastChildInherited from odf.element.Text (Section 10.6)tagNameInherited from odf.element.Node (Section 10.4)nextSibling, parentNode, previousSiblingInherited from xml.dom.NodeATTRIBUTE NODE, CDATA SECTION NODE, COMMENT NODE,DOCUMENT FRAGMENT NODE, DOCUMENT NODE,DOCUMENT TYPE NODE, ELEMENT NODE, ENTITY NODE,ENTITY REFERENCE NODE, NOTATION NODE,PROCESSING INSTRUCTION NODE, TEXT NODE

10.8 Class Element

xml.dom.Node

odf.element.Node

odf.element.Element

Creates a arbitrary element and is intended to be subclassed not used on its own. This ele-ment is the base of every element it defines a class which resembles a xml-element. The mainadvantage of this kind of implementation is that you don’t have to create a toXML method

24


for every different object. Every element consists of an attribute, optional subelements,optional text and optional cdata.

10.8.1 Methods

init (self, attributes=None, text=None, cdata=None, qname=None,qattributes=None, check grammar=True, **args)

get nsprefix(self, namespace)

allowed attributes(self )

addElement(self, element, check grammar=True)

adds an element to an Element

Element.addElement(Element)

addText(self, text, check grammar=True)

addCDATA(self, cdata, check grammar=True)

removeAttribute(self, attr, check grammar=True)

Removes an attribute by name.

setAttribute(self, attr, value, check grammar=True)

Add an attribute to the element This is sort of a convenience method. Allattributes in ODF have namespaces. The library knows what attributes arelegal and then allows the user to provide the attribute as a keyword argumentand the library will add the correct namespace. Must overwrite, If attributealready exists.

setAttrNS(self, namespace, localpart, value)

Add an attribute to the element In case you need to add an attribute thelibrary doesn’t know about then you must provide the full qualified name Itwill not check that the attribute is legal according to the schema. Mustoverwrite, If attribute already exists.

getAttrNS(self, namespace, localpart)

25


removeAttrNS(self, namespace, localpart)

getAttribute(self, attr)

write open tag(self, level, f )

write close tag(self, level, f )


Generate XML stream out of the tree structure

getElementsByType(self, element)

Inherited from odf.element.Node(Section 10.4)

appendChild(), hasChildNodes(), insertBefore(), removeChild()

10.8.2 Properties

Name Description

Inherited from odf.element.Node (Section 10.4)firstChild, lastChild


Name Description

nodeType Value: 1

namespaces Value: {}Inherited from odf.element.Node (Section 10.4)nextSibling, parentNode, previousSiblingInherited from xml.dom.NodeATTRIBUTE NODE, CDATA SECTION NODE, COMMENT NODE,DOCUMENT FRAGMENT NODE, DOCUMENT NODE,DOCUMENT TYPE NODE, ELEMENT NODE, ENTITY NODE,ENTITY REFERENCE NODE, NOTATION NODE,PROCESSING INSTRUCTION NODE, TEXT NODE

26

Variables Module odf.elementtypes

11 Module odf.elementtypes

11.1 Variables

Name Description

inline elements Value:

((u’urn:oasis:names:tc:opendocument:xmlns:text:1.0’,

u’a’...

block elements Value:

((u’urn:oasis:names:tc:opendocument:xmlns:text:1.0’,

u’h’...

declarative elements Value:

((u’urn:oasis:names:tc:opendocument:xmlns:office:1.0’,

u’...

empty elements Value:

((u’urn:oasis:names:tc:opendocument:xmlns:animation:1.0’,...


27

Module odf.form

12 Module odf.form

12.1 Functions

Button(**args)

Checkbox(**args)

Column(**args)

Combobox(**args)

ConnectionResource(**args)

Date(**args)

File(**args)

FixedText(**args)

Form(**args)

FormattedText(**args)

Frame(**args)

GenericControl(**args)

Grid(**args)

Hidden(**args)

Image(**args)

ImageFrame(**args)

Item(**args)

ListProperty(**args)

28

Variables Module odf.form

ListValue(**args)

Listbox(**args)

Number(**args)

Option(**args)

Password(**args)

Properties(**args)

Property(**args)

Radio(**args)

Text(**args)

Textarea(**args)

Time(**args)

ValueRange(**args)

12.2 Variables

Name Description


29

Variables Module odf.grammar

13 Module odf.grammar

In principle the OpenDocument schema converted to python structures. Currently it containsthe legal child elements of a given element. To be used for validation check in the API

13.1 Variables

Name Description

doc Value: """ In principle the OpenDocument

schema converted to pyt...

allowed children Value:

{(u’http://purl.org/dc/elements/1.1/’,u’creator’): (), (...

allows text Value:

((u’urn:oasis:names:tc:opendocument:xmlns:config:1.0’,

u’...

required attributes Value:

{(u’urn:oasis:names:tc:opendocument:xmlns:animation:1.0’,...allowed attributes Value:

{(u’http://purl.org/dc/elements/1.1/’,u’creator’): (), (...


30

Class LoadParser Module odf.load

14 Module odf.load

14.1 Variables

Name Description


14.2 Class LoadParser

xml.sax.handler.ContentHandler

odf.load.LoadParser

Extract headings from content.xml of an ODT file

14.2.1 Methods

init (self, document)

Overrides: xml.sax.handler.ContentHandler. init

characters(self, data)

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAXparsers may return all contiguous character data in a single chunk, or theymay split it into several chunks; however, all of the characters in any singleevent must come from the same external entity so that the Locator providesuseful information.

Overrides: xml.sax.handler.ContentHandler.characters extit(inheriteddocumentation)

31

Class LoadParser Module odf.load

startElementNS(self, tag, qname, attrs)

Signals the start of an element in namespace mode.

The name parameter contains the name of the element type as a (uri,localname) tuple, the qname parameter the raw XML 1.0 name used in thesource document, and the attrs parameter holds an instance of the Attributesclass containing the attributes of the element.

The uri part of the name tuple is None for elements which have no namespace.

Overrides: xml.sax.handler.ContentHandler.startElementNS extit(inheriteddocumentation)

endElementNS(self, tag, qname)

Signals the end of an element in namespace mode.

The name parameter contains the name of the element type, just as with thestartElementNS event.

Overrides: xml.sax.handler.ContentHandler.endElementNS extit(inheriteddocumentation)

Inherited from xml.sax.handler.ContentHandler

endDocument(), endElement(), endPrefixMapping(), ignorableWhitespace(), pro-cessingInstruction(), setDocumentLocator(), skippedEntity(), startDocument(), startEle-ment(), startPrefixMapping()


Name Description

triggers Value:

((u’urn:oasis:names:tc:opendocument:xmlns:office:1.0’,

’a...

32

Variables Module odf.manifest

15 Module odf.manifest

15.1 Functions

Manifest(**args)

FileEntry(**args)

EncryptionData(**args)

Algorithm(**args)

KeyDerivation(**args)

15.2 Variables

Name Description


33

Variables Module odf.math

16 Module odf.math

16.1 Functions

Math(**args)

16.2 Variables

Name Description


34

Variables Module odf.meta

17 Module odf.meta

17.1 Functions

AutoReload(**args)

CreationDate(**args)

DateString(**args)

DocumentStatistic(**args)

EditingCycles(**args)

EditingDuration(**args)

Generator(**args)

HyperlinkBehaviour(**args)

InitialCreator(**args)

Keyword(**args)

PrintDate(**args)

PrintedBy(**args)

Template(**args)

UserDefined(**args)

17.2 Variables

Name Description


35

Module odf.namespaces

18 Module odf.namespaces

18.1 Variables

Name Description

TOOLSVERSION Value: u’ODFPY/0.9.1dev’

ANIMNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:animation:1.0’

DBNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:database:1.0’

CHARTNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:chart:1.0’

CONFIGNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:config:1.0’

DCNS Value:

u’http://purl.org/dc/elements/1.1/’

DOMNS Value:

u’http://www.w3.org/2001/xml-events’

DR3DNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0’

DRAWNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:drawing:1.0’

FONS Value:

u’urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible...

FORMNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:form:1.0’

KOFFICENS Value: u’http://www.koffice.org/2005/’

MANIFESTNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:manifest:1.0’

MATHNS Value:

u’http://www.w3.org/1998/Math/MathML’

METANS Value:

u’urn:oasis:names:tc:opendocument:xmlns:meta:1.0’

NUMBERNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0’

OFFICENS Value:

u’urn:oasis:names:tc:opendocument:xmlns:office:1.0’

OOONS Value:

u’http://openoffice.org/2004/office’

OOOWNS Value:

u’http://openoffice.org/2004/writer’

OOOCNS Value:

u’http://openoffice.org/2004/calc’

continued on next page

36

Variables Module odf.namespaces

Name Description

PRESENTATIONNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:presentation:1.0’

RDFANS Value:

u’http://docs.oasis-open.org/opendocument/meta/rdfa#’

SCRIPTNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:script:1.0’

SMILNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:smil-compatible:1.0’

STYLENS Value:

u’urn:oasis:names:tc:opendocument:xmlns:style:1.0’

SVGNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0’

TABLENS Value:

u’urn:oasis:names:tc:opendocument:xmlns:table:1.0’

TEXTNS Value:

u’urn:oasis:names:tc:opendocument:xmlns:text:1.0’

XFORMSNS Value: u’http://www.w3.org/2002/xforms’

XLINKNS Value: u’http://www.w3.org/1999/xlink’

XMLNS Value:

u’http://www.w3.org/XML/1998/namespace’

nsdict Value:

{u’http://docs.oasis-open.org/opendocument/meta/rdfa#’:u...

package Value: None

37

Module odf.number

19 Module odf.number

19.1 Functions

AmPm(**args)

Boolean(**args)

BooleanStyle(**args)

CurrencyStyle(**args)

CurrencySymbol(**args)

DateStyle(**args)

Day(**args)

DayOfWeek(**args)

EmbeddedText(**args)

Era(**args)

Fraction(**args)

Hours(**args)

Minutes(**args)

Month(**args)

Number(**args)

NumberStyle(**args)

PercentageStyle(**args)

Quarter(**args)

38

Variables Module odf.number

ScientificNumber(**args)

Seconds(**args)

Text(**args)

TextContent(**args)

TextStyle(**args)

TimeStyle(**args)

WeekOfYear(**args)

Year(**args)

19.2 Variables

Name Description


39

Class TextProps Module odf.odf2moinmoin

20 Module odf.odf2moinmoin

20.1 Variables

Name Description

IGNORED TAGS Value: [’draw:adraw:g’, ’draw:line’,

’draw:object-ole’, ’office:...

INLINE TAGS Value: [u’text:a’,

u’text:author-initials’,

u’text:author-name’,...


item Value:

(u’urn:oasis:names:tc:opendocument:xmlns:text:1.0’,

u’wor...

20.2 Class TextProps

Holds properties for a text style.

20.2.1 Methods

init (self )

setItalic(self, value)

setBold(self, value)

setFixed(self, value)

setUnderlined(self, value)

setStrikethrough(self, value)

setPosition(self, value)

str (self )

40

Class ParagraphProps Module odf.odf2moinmoin

20.3 Class ParagraphProps

Holds properties of a paragraph style.

20.3.1 Methods

init (self )

setIndented(self, value)

setHeading(self, level)

setTitle(self, value)

setCode(self, value)

str (self )

20.4 Class ListProperties

Holds properties for a list style.

20.4.1 Methods

init (self )

setOrdered(self, value)

20.5 Class ODF2MoinMoin

object

odf.odf2moinmoin.ODF2MoinMoin

41

Class ODF2MoinMoin Module odf.odf2moinmoin

20.5.1 Methods

init (self, filepath)

x. init (...) initializes x; see x. class . doc for signature

Overrides: object. init extit(inherited documentation)

processFontDeclarations(self, fontDecl)

Extracts necessary font information from a font-declaration element.

extractTextProperties(self, style, parent=None)

Extracts text properties from a style element.

extractParagraphProperties(self, style, parent=None)

Extracts paragraph properties from a style element.

processStyles(self, styleElements)

Runs through ”style” elements extracting necessary information.

processListStyles(self, listStyleElements)

load(self, filepath)

Loads an ODT file.

compressCodeBlocks(self, text)

Removes extra blank lines from code blocks.

do nothing(self, node)

draw image(self, node)

text a(self, node)

text line break(self, node)

text note(self, node)

text s(self, node)

42

Class ODF2MoinMoin Module odf.odf2moinmoin

text tab(self, node)

inline markup(self, node)

listToString(self, listElement, indent=0)

tableToString(self, tableElement)

MoinMoin uses || to delimit table cells

toString(self )

Converts the document to a string. FIXME: Result from second call differsfrom first call

textToString(self, element)

paragraphToString(self, paragraph, indent=0)

wrapParagraph(self, text, indent=0, blockquote=False)


delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),repr (), setattr (), sizeof (), str (), subclasshook ()

20.5.2 Properties

Name Description

Inherited from objectclass

43

Class StyleToCSS Module odf.odf2xhtml

21 Module odf.odf2xhtml

21.1 Variables

Name Description

special styles Value: {’P-Addressee’: ’address’,

’P-Heading 20 1’: ’h1’, ’P-Hea...


21.2 Class StyleToCSS

The purpose of the StyleToCSS class is to contain the rules to convert ODF styles to CSS2.Since it needs the generic fonts, it would probably make sense to also contain the Styles ina dict as well..

21.2.1 Methods

init (self )

save font(self, name, family, generic)

It is possible that the HTML browser doesn’t know how to show a particularfont. Fortunately ODF provides generic fallbacks. Unfortunately they are notthe same as CSS2. CSS2: serif, sans-serif, cursive, fantasy, monospace ODF:roman, swiss, modern, decorative, script, system This method put the font andfallback into a dictionary

c drawfillimage(self, ruleset, sdict, rule, val)

Fill a figure with an image. Since CSS doesn’t let you resize images thisshould really be implemented as an absolutely position <img> with a widthand a height

c fo(self, ruleset, sdict, rule, val)

XSL formatting attributes

c border model(self, ruleset, sdict, rule, val)

Convert to CSS2 border model

44

Class StyleToCSS Module odf.odf2xhtml

c width(self, ruleset, sdict, rule, val)

Set width of box

c text align(self, ruleset, sdict, rule, align)

Text align

c fn(self, ruleset, sdict, rule, fontstyle)

Generate the CSS font family A generic font can be found in two ways. In a<style:font-face> element or as a font-family-generic attribute intext-properties.

c text position(self, ruleset, sdict, rule, tp)

Text position. This is used e.g. to make superscript and subscript Thisattribute can have one or two values.

The first value must be present and specifies the vertical text position as apercentage that relates to the current font height or it takes one of the valuessub or super. Negative percentages or the sub value place the text below thebaseline. Positive percentages or the super value place the text above thebaseline. If sub or super is specified, the application can choose an appropriatetext position.

The second value is optional and specifies the font height as a percentage thatrelates to the current font-height. If this value is not specified, an appropriatefont height is used. Although this value may change the font height that isdisplayed, it never changes the current font height that is used for additionalcalculations.

c hp(self, ruleset, sdict, rule, hpos)

c page width(self, ruleset, sdict, rule, val)

Set width of box HTML doesn’t really have a page-width. It is always 100% ofthe browser width

c text underline style(self, ruleset, sdict, rule, val)

Set underline decoration HTML doesn’t really have a page-width. It is always100% of the browser width

45

Class TagStack Module odf.odf2xhtml

c text line through style(self, ruleset, sdict, rule, val)

Set underline decoration HTML doesn’t really have a page-width. It is always100% of the browser width

c page height(self, ruleset, sdict, rule, val)

Set height of box

convert styles(self, ruleset)

Rule is a tuple of (namespace, name). If the namespace is ” then it is alreadyCSS2

21.3 Class TagStack

21.3.1 Methods

init (self )

push(self, tag, attrs)

pop(self )

stackparent(self )

rfindattr(self, attr)

Find a tag with the given attribute

count tags(self, tag)

21.4 Class ODF2XHTML


odf.odf2xhtml.ODF2XHTML

The ODF2XHTML parses an ODF file and produces XHTML

46

Class ODF2XHTML Module odf.odf2xhtml

21.4.1 Methods

init (self, generate css=True, embedable=False)


writeout(self, s)

writedata(self )

opentag(self, tag, attrs={}, block=False)

Create an open HTML tag

closetag(self, tag, block=True)

emptytag(self, tag, attrs={})

characters(self, data)

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAXparsers may return all contiguous character data in a single chunk, or theymay split it into several chunks; however, all of the characters in any singleevent must come from the same external entity so that the Locator providesuseful information.

Overrides: xml.sax.handler.ContentHandler.characters extit(inheriteddocumentation)

handle starttag(self, tag, method, attrs)

handle endtag(self, tag, attrs, method)

47











unknown starttag(self, tag, attrs)

unknown endtag(self, tag, attrs)

s ignorexml(self, tag, attrs)

Ignore this xml element and all children of it It will automatically stop ignoring

s ignorecont(self, tag, attrs)

s processcont(self, tag, attrs)

classname(self, attrs)

Generate a class name from a style name

get anchor(self, name)

purgedata(self )

48


e dc title(self, tag, attrs)

Get the title from the meta data and create a HTML <title>

e dc metatag(self, tag, attrs)

Any other meta data is added as a <meta> element

e dc contentlanguage(self, tag, attrs)

Set the content language. Identifies the targeted audience

s draw frame(self, tag, attrs)

A <draw:frame> is made into a <div> in HTML which is then styled

e draw frame(self, tag, attrs)

End the <draw:frame>

s draw fill image(self, tag, attrs)

rewritelink(self, imghref )

Intended to be overloaded if you don’t store your pictures in a Picturessubfolder

s draw image(self, tag, attrs)

A <draw:image> becomes an <img/> element

s draw page(self, tag, attrs)

A <draw:page> is a slide in a presentation. We use a <fieldset> element inHTML. Therefore if you convert a ODP file, you get a series of <fieldset>s.Override this for your own purpose.

e draw page(self, tag, attrs)

s draw textbox(self, tag, attrs)

e draw textbox(self, tag, attrs)

End the <draw:text-box>

html body(self, tag, attrs)

49


generate stylesheet(self )

generate footnotes(self )

s office automatic styles(self, tag, attrs)

s office document content(self, tag, attrs)

First tag in the content.xml file

e office document content(self, tag, attrs)

Last tag

s office master styles(self, tag, attrs)

s office presentation(self, tag, attrs)

For some odd reason, OpenOffice Impress doesn’t define a default-style for the’paragraph’. We therefore force a standard when we see it is a presentation

e office presentation(self, tag, attrs)

s office spreadsheet(self, tag, attrs)

e office spreadsheet(self, tag, attrs)

s office styles(self, tag, attrs)

s office text(self, tag, attrs)

OpenDocument text

e office text(self, tag, attrs)

s style handle properties(self, tag, attrs)

Copy all attributes to a struct. We will later convert them to CSS2

s style default style(self, tag, attrs)

A default style is like a style on an HTML tag

50


e style default style(self, tag, attrs)

s style font face(self, tag, attrs)

It is possible that the HTML browser doesn’t know how to show a particularfont. Luckily ODF provides generic fallbacks Unluckily they are not the sameas CSS2. CSS2: serif, sans-serif, cursive, fantasy, monospace ODF: roman,swiss, modern, decorative, script, system

s style footer(self, tag, attrs)

e style footer(self, tag, attrs)

s style footer style(self, tag, attrs)

s style header(self, tag, attrs)

e style header(self, tag, attrs)

s style header style(self, tag, attrs)

s style page layout(self, tag, attrs)

Collect the formatting for the page layout style.

e style page layout(self, tag, attrs)

End this style

s style master page(self, tag, attrs)

Collect the formatting for the page layout style.

s style style(self, tag, attrs)

Collect the formatting for the style. Styles have scope. The same name can beused for both paragraph and character styles Since CSS has no scope we use aprefix. (Not elegant) In ODF a style can have a parent, these parents can bechained. We may not have encountered the parent yet, but if we have, weresolve it.

e style style(self, tag, attrs)

End this style

51


s table table(self, tag, attrs)

Start a table

e table table(self, tag, attrs)

End a table

s table table cell(self, tag, attrs)

e table table cell(self, tag, attrs)

s table table column(self, tag, attrs)

s table table row(self, tag, attrs)

e table table row(self, tag, attrs)

s text a(self, tag, attrs)

Anchors start

e text a(self, tag, attrs)

s text h(self, tag, attrs)

Headings start

e text h(self, tag, attrs)

Headings end

s text line break(self, tag, attrs)

s text list(self, tag, attrs)

To know which level we’re at, we have to count the number of <text:list>elements on the tagstack.

e text list(self, tag, attrs)

s text list item(self, tag, attrs)

e text list item(self, tag, attrs)

52


s text list level style bullet(self, tag, attrs)

CSS doesn’t have the ability to set the glyph to a particular character, so wejust go through the available glyphs

e text list level style bullet(self, tag, attrs)

s text list level style number(self, tag, attrs)

e text list level style number(self, tag, attrs)

s text note(self, tag, attrs)

e text note(self, tag, attrs)

collectnote(self, s)

s text note body(self, tag, attrs)

e text note body(self, tag, attrs)

e text note citation(self, tag, attrs)

s text p(self, tag, attrs)

Paragraph

e text p(self, tag, attrs)

End Paragraph

s text s(self, tag, attrs)

Generate a number of spaces. ODF has an element; HTML uses Weuse so we can send the output through an XML parser if we desire to

s text span(self, tag, attrs)

The <text:span> element matches the <span> element in HTML. It istypically used to properties of the text.

e text span(self, tag, attrs)

End the <text:span>

53


s text tab(self, tag, attrs)

Move to the next tabstop. We ignore this in HTML

s text x source(self, tag, attrs)

Various indexes and tables of contents. We ignore those.

e text x source(self, tag, attrs)

Various indexes and tables of contents. We ignore those.

load(self, odffile)

parseodf(self )

odf2xhtml(self, odffile)

Load a file and return XHTML

xhtml(self )

css(self )


endDocument(), endElement(), endPrefixMapping(), ignorableWhitespace(), pro-cessingInstruction(), setDocumentLocator(), skippedEntity(), startDocument(), startEle-ment(), startPrefixMapping()


Name Description

familymap Value: {’frame’: ’frame’, ’graphic’:

’graphic’, ’paragraph’: ’p’...

familyshort Value: {’drawing-page’: ’DP’,

’graphic’: ’G’, ’paragraph’: ’P’, ...

54

Class ODFManifestHandler Module odf.odfmanifest

22 Module odf.odfmanifest

22.1 Functions

manifestlist(manifestxml)

odfmanifest(odtfile)

22.2 Variables

Name Description

MANIFESTNS Value:

’urn:oasis:names:tc:opendocument:xmlns:manifest:1.0’


22.3 Class ODFManifestHandler


odf.odfmanifest.ODFManifestHandler

The ODFManifestHandler parses a manifest file and produces a list of content

22.3.1 Methods

init (self )


handle starttag(self, tag, method, attrs)

handle endtag(self, tag, method)

55

Class ODFManifestHandler Module odf.odfmanifest










unknown starttag(self, tag, attrs)

unknown endtag(self, tag)

donothing(self, tag, attrs=None)

s file entry(self, tag, attrs)


characters(), endDocument(), endElement(), endPrefixMapping(), ignorableWhites-pace(), processingInstruction(), setDocumentLocator(), skippedEntity(), startDoc-ument(), startElement(), startPrefixMapping()

56

Module odf.office

23 Module odf.office

23.1 Functions

Annotation(**args)

AutomaticStyles(**args)

BinaryData(**args)

Body(**args)

ChangeInfo(**args)

Chart(**args)

DdeSource(**args)

Document(version=’1.1’, **args)

DocumentContent(version=’1.1’, **args)

DocumentMeta(version=’1.1’, **args)

DocumentSettings(version=’1.1’, **args)

DocumentStyles(version=’1.1’, **args)

Drawing(**args)

EventListeners(**args)

FontFaceDecls(**args)

Forms(**args)

Image(**args)

MasterStyles(**args)

57

Variables Module odf.office

Meta(**args)

Presentation(**args)

Script(**args)

Scripts(**args)

Settings(**args)

Spreadsheet(**args)

Styles(**args)

Text(**args)

23.2 Variables

Name Description


58

Variables Module odf.opendocument

24 Module odf.opendocument

Use OpenDocument to generate your documents.

Version: ODFPY/0.9.1dev

24.1 Functions

OpenDocumentChart()

OpenDocumentDrawing()

OpenDocumentImage()

OpenDocumentPresentation()

OpenDocumentSpreadsheet()

OpenDocumentText()

load(odffile)

24.2 Variables

Name Description

doc Value: """Use OpenDocument to generate

your documents."""

UNIXPERMS Value: 2175008768

IS FILENAME Value: 0

IS IMAGE Value: 1

odmimetypes Value:

{’application/vnd.oasis.opendocument.chart’:’.odc’, ’app...


59

Class OpaqueObject Module odf.opendocument

24.3 Class OpaqueObject

24.3.1 Methods

init (self, filename, mediatype, content=None)

24.4 Class OpenDocument

A class to hold the content of an OpenDocument document Use the xml method to writethe XML source to the screen or to a file d = OpenDocument(mimetype) fd.write(d.xml())

24.4.1 Methods

init (self, mimetype, add generator=True)

rebuild caches(self, node=None)

clear caches(self )

build caches(self, element)

Called from element.py

toXml(self, filename=’’)

xml(self )

Generates the full document as an XML file Always written as a bytestream inUTF-8 encoding

contentxml(self )

Generates the content.xml file Always written as a bytestream in UTF-8encoding

manifestxml(self )

Generates the manifest.xml file

metaxml(self )

Generates the meta.xml file

60

Class OpenDocument Module odf.opendocument

settingsxml(self )

Generates the settings.xml file

stylesxml(self )

Generates the styles.xml file

addPicture(self, filename, mediatype=None, content=None)

Add a picture It uses the same convention as OOo, in that it saves the picturein the zipfile in the subdirectory ’Pictures’ If passed a file ptr, mediatype mustbe set

addPictureFromFile(self, filename, mediatype=None)

Add a picture It uses the same convention as OOo, in that it saves the picturein the zipfile in the subdirectory ’Pictures’. If mediatype is not given, it willbe guessed from the filename extension.

addPictureFromString(self, content, mediatype)

Add a picture It uses the same convention as OOo, in that it saves the picturein the zipfile in the subdirectory ’Pictures’. The content variable is a stringthat contains the binary image data. The mediatype indicates the imageformat.

addThumbnail(self, filecontent=None)

Add a fixed thumbnail The thumbnail in the library is big, so this is prettyuseless.

addObject(self, document, objectname=None)

Add an object. The object must be an OpenDocument class The return valuewill be the folder in the zipfile the object is stored in

save(self, outputfile, addsuffix=False)

Save the document under the filename

write(self, outputfp)

createElement(self, element)

Inconvenient interface to create an element, but follows XML-DOM. Does notallow attributes as argument, therefore can’t check grammar.

61

Class OpenDocument Module odf.opendocument

createTextNode(self, data)

Method to create a text node

createCDATASection(self, data)

getMediaType(self )

Returns the media type

getStyleByName(self, name)

getElementsByType(self, element)


Name Description

thumbnail Value: None

62

Module odf.presentation

25 Module odf.presentation

25.1 Functions

AnimationGroup(**args)

Animations(**args)

DateTime(**args)

DateTimeDecl(**args)

Dim(**args)

EventListener(**args)

Footer(**args)

FooterDecl(**args)

Header(**args)

HeaderDecl(**args)

HideShape(**args)

HideText(**args)

Notes(**args)

Placeholder(**args)

Play(**args)

Settings(**args)

Show(**args)

ShowShape(**args)

63

Variables Module odf.presentation

ShowText(**args)

Sound(**args)

25.2 Variables

Name Description


64

Variables Module odf.script

26 Module odf.script

26.1 Functions

EventListener(**args)

26.2 Variables

Name Description


65

Module odf.style

27 Module odf.style

27.1 Functions

StyleElement(**args)

BackgroundImage(**args)

ChartProperties(**args)

Column(**args)

ColumnSep(**args)

Columns(**args)

DefaultStyle(**args)

DrawingPageProperties(**args)

DropCap(**args)

FontFace(**args)

Footer(**args)

FooterLeft(**args)

FooterStyle(**args)

FootnoteSep(**args)

GraphicProperties(**args)

HandoutMaster(**args)

Header(**args)

HeaderFooterProperties(**args)

66

Functions Module odf.style

HeaderLeft(**args)

HeaderStyle(**args)

ListLevelProperties(**args)

Map(**args)

MasterPage(**args)

PageLayout(**args)

PageLayoutProperties(**args)

ParagraphProperties(**args)

PresentationPageLayout(**args)

RegionCenter(**args)

RegionLeft(**args)

RegionRight(**args)

RubyProperties(**args)

SectionProperties(**args)

Style(**args)

TabStop(**args)

TabStops(**args)

TableCellProperties(**args)

TableColumnProperties(**args)

TableProperties(**args)

67

Variables Module odf.style

TableRowProperties(**args)

TextProperties(**args)

27.2 Variables

Name Description


68

Variables Module odf.svg

28 Module odf.svg

28.1 Functions

DefinitionSrc(**args)

Desc(**args)

FontFaceFormat(**args)

FontFaceName(**args)

FontFaceSrc(**args)

FontFaceUri(**args)

Lineargradient(**args)

Radialgradient(**args)

Stop(**args)

28.2 Variables

Name Description


69

Module odf.table

29 Module odf.table

29.1 Functions

Body(**args)

CalculationSettings(**args)

CellAddress(**args)

CellContentChange(**args)

CellContentDeletion(**args)

CellRangeSource(**args)

ChangeDeletion(**args)

ChangeTrackTableCell(**args)

Consolidation(**args)

ContentValidation(**args)

ContentValidations(**args)

CoveredTableCell(**args)

CutOffs(**args)

DataPilotDisplayInfo(**args)

DataPilotField(**args)

DataPilotFieldReference(**args)

DataPilotGroup(**args)

DataPilotGroupMember(**args)

70

Functions Module odf.table

DataPilotGroups(**args)

DataPilotLayoutInfo(**args)

DataPilotLevel(**args)

DataPilotMember(**args)

DataPilotMembers(**args)

DataPilotSortInfo(**args)

DataPilotSubtotal(**args)

DataPilotSubtotals(**args)

DataPilotTable(**args)

DataPilotTables(**args)

DatabaseRange(**args)

DatabaseRanges(**args)

DatabaseSourceQuery(**args)

DatabaseSourceSql(**args)

DatabaseSourceTable(**args)

DdeLink(**args)

DdeLinks(**args)

Deletion(**args)

Deletions(**args)

Dependencies(**args)

71


Dependency(**args)

Detective(**args)

ErrorMacro(**args)

ErrorMessage(**args)

EvenColumns(**args)

EvenRows(**args)

Filter(**args)

FilterAnd(**args)

FilterCondition(**args)

FilterOr(**args)

FirstColumn(**args)

FirstRow(**args)

HelpMessage(**args)

HighlightedRange(**args)

Insertion(**args)

InsertionCutOff(**args)

Iteration(**args)

LabelRange(**args)

LabelRanges(**args)

LastColumn(**args)

72


LastRow(**args)

Movement(**args)

MovementCutOff(**args)

NamedExpression(**args)

NamedExpressions(**args)

NamedRange(**args)

NullDate(**args)

OddColumns(**args)

OddRows(**args)

Operation(**args)

Previous(**args)

Scenario(**args)

Shapes(**args)

Sort(**args)

SortBy(**args)

SortGroups(**args)

SourceCellRange(**args)

SourceRangeAddress(**args)

SourceService(**args)

SubtotalField(**args)

73

Variables Module odf.table

SubtotalRule(**args)

SubtotalRules(**args)

Table(**args)

TableCell(**args)

TableColumn(**args)

TableColumnGroup(**args)

TableColumns(**args)

TableHeaderColumns(**args)

TableHeaderRows(**args)

TableRow(**args)

TableRowGroup(**args)

TableRows(**args)

TableSource(**args)

TableTemplate(**args)

TargetRangeAddress(**args)

TrackedChanges(**args)

29.2 Variables

Name Description


74

Class WhitespaceText Module odf.teletype

30 Module odf.teletype

Class for handling whitespace properly in OpenDocument.

While it is possible to use getTextContent() and setTextContent() to extract or create ODFcontent, these won’t extract or create the appropriate <text:s>, <text:tab>, or <text:line-break> elements. This module takes care of that problem.

30.1 Functions

addTextToElement(odfElement, s)

extractText(odfElement)

Extract text content from an Element, with whitespace represented properly.Returns the text, with tabs, spaces, and newlines correctly evaluated. Thismethod recursively descends through the children of the given element,accumulating text and ”unwrapping” <text:s>, <text:tab>, and<text:line-break> elements along the way.

30.2 Variables

Name Description


30.3 Class WhitespaceText

object

odf.teletype.WhitespaceText

30.3.1 Methods

init (self )

x. init (...) initializes x; see x. class . doc for signature

Overrides: object. init extit(inherited documentation)

75

Class WhitespaceText Module odf.teletype

addTextToElement(self, odfElement, s)

Process an input string, inserting

<text:tab> elements for ’ ’,

<text:line-break> elements for ’

’, and

<text:s> elements for runs of more than one blank.

These will be added to the given element.



30.3.2 Properties

Name Description


76

Module odf.text

31 Module odf.text

31.1 Functions

A(**args)

AlphabeticalIndex(**args)

AlphabeticalIndexAutoMarkFile(**args)

AlphabeticalIndexEntryTemplate(**args)

AlphabeticalIndexMark(**args)

AlphabeticalIndexMarkEnd(**args)

AlphabeticalIndexMarkStart(**args)

AlphabeticalIndexSource(**args)

AuthorInitials(**args)

AuthorName(**args)

Bibliography(**args)

BibliographyConfiguration(**args)

BibliographyEntryTemplate(**args)

BibliographyMark(**args)

BibliographySource(**args)

Bookmark(**args)

BookmarkEnd(**args)

BookmarkRef(**args)

77

Functions Module odf.text

BookmarkStart(**args)

Change(**args)

ChangeEnd(**args)

ChangeStart(**args)

ChangedRegion(**args)

Chapter(**args)

CharacterCount(**args)

ConditionalText(**args)

CreationDate(**args)

CreationTime(**args)

Creator(**args)

DatabaseDisplay(**args)

DatabaseName(**args)

DatabaseNext(**args)

DatabaseRowNumber(**args)

DatabaseRowSelect(**args)

Date(**args)

DdeConnection(**args)

DdeConnectionDecl(**args)

DdeConnectionDecls(**args)

78


Deletion(**args)

Description(**args)

EditingCycles(**args)

EditingDuration(**args)

ExecuteMacro(**args)

Expression(**args)

FileName(**args)

FormatChange(**args)

H(**args)

HiddenParagraph(**args)

HiddenText(**args)

IllustrationIndex(**args)

IllustrationIndexEntryTemplate(**args)

IllustrationIndexSource(**args)

ImageCount(**args)

IndexBody(**args)

IndexEntryBibliography(**args)

IndexEntryChapter(**args)

IndexEntryLinkEnd(**args)

IndexEntryLinkStart(**args)

79


IndexEntryPageNumber(**args)

IndexEntrySpan(**args)

IndexEntryTabStop(**args)

IndexEntryText(**args)

IndexSourceStyle(**args)

IndexSourceStyles(**args)

IndexTitle(**args)

IndexTitleTemplate(**args)

InitialCreator(**args)

Insertion(**args)

Keywords(**args)

LineBreak(**args)

LinenumberingConfiguration(**args)

LinenumberingSeparator(**args)

List(**args)

ListHeader(**args)

ListItem(**args)

ListLevelStyleBullet(**args)

ListLevelStyleImage(**args)

ListLevelStyleNumber(**args)

80


ListStyle(**args)

Measure(**args)

ModificationDate(**args)

ModificationTime(**args)

Note(**args)

NoteBody(**args)

NoteCitation(**args)

NoteContinuationNoticeBackward(**args)

NoteContinuationNoticeForward(**args)

NoteRef(**args)

NotesConfiguration(**args)

Number(**args)

NumberedParagraph(**args)

ObjectCount(**args)

ObjectIndex(**args)

ObjectIndexEntryTemplate(**args)

ObjectIndexSource(**args)

OutlineLevelStyle(**args)

OutlineStyle(**args)

P(**args)

81


Page(**args)

PageContinuation(**args)

PageCount(**args)

PageNumber(**args)

PageSequence(**args)

PageVariableGet(**args)

PageVariableSet(**args)

ParagraphCount(**args)

Placeholder(**args)

PrintDate(**args)

PrintTime(**args)

PrintedBy(**args)

ReferenceMark(**args)

ReferenceMarkEnd(**args)

ReferenceMarkStart(**args)

ReferenceRef(**args)

Ruby(**args)

RubyBase(**args)

RubyText(**args)

S(**args)

82


Script(**args)

Section(**args)

SectionSource(**args)

SenderCity(**args)

SenderCompany(**args)

SenderCountry(**args)

SenderEmail(**args)

SenderFax(**args)

SenderFirstname(**args)

SenderInitials(**args)

SenderLastname(**args)

SenderPhonePrivate(**args)

SenderPhoneWork(**args)

SenderPosition(**args)

SenderPostalCode(**args)

SenderStateOrProvince(**args)

SenderStreet(**args)

SenderTitle(**args)

Sequence(**args)

SequenceDecl(**args)

83


SequenceDecls(**args)

SequenceRef(**args)

SheetName(**args)

SortKey(**args)

Span(**args)

Subject(**args)

Tab(**args)

TableCount(**args)

TableFormula(**args)

TableIndex(**args)

TableIndexEntryTemplate(**args)

TableIndexSource(**args)

TableOfContent(**args)

TableOfContentEntryTemplate(**args)

TableOfContentSource(**args)

TemplateName(**args)

TextInput(**args)

Time(**args)

Title(**args)

TocMark(**args)

84


TocMarkEnd(**args)

TocMarkStart(**args)

TrackedChanges(**args)

UserDefined(**args)

UserFieldDecl(**args)

UserFieldDecls(**args)

UserFieldGet(**args)

UserFieldInput(**args)

UserIndex(**args)

UserIndexEntryTemplate(**args)

UserIndexMark(**args)

UserIndexMarkEnd(**args)

UserIndexMarkStart(**args)

UserIndexSource(**args)

VariableDecl(**args)

VariableDecls(**args)

VariableGet(**args)

VariableInput(**args)

VariableSet(**args)

WordCount(**args)

85

Variables Module odf.text

31.2 Variables

Name Description


86

Variables Module odf.thumbnail

32 Module odf.thumbnail

32.1 Functions

thumbnail()

32.2 Variables

Name Description

iconstr Value:

’iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAAG0OVFdAAAABGdBTUEA...


87

Class UserFields Module odf.userfield

33 Module odf.userfield

Class to show and manipulate user fields in odf documents.

33.1 Functions

writetext(stream, text, entities={})

writeattr(stream, text)

33.2 Variables

Name Description

OUTENCODING Value: ’utf-8’

VALUE TYPES Value: {’boolean’:(u’urn:oasis:names:tc:opendocument:xmlns:offi...

ATTR ENTITIES Value: {’\n’: ’
’}package Value: ’odf’

33.3 Class UserFields

object

odf.userfield.UserFields

List, view and manipulate user fields.

33.3.1 Methods

init (self, src=None, dest=None)

Constructor

src ... source document name, file like object or None for stdin dest ...destination document name, file like object or None for stdout

Overrides: object. init

88

Class UserFields Module odf.userfield

list fields(self )

List (extract) all known user-fields.

Returns list of user-field names.

list fields and values(self, field names=None)

List (extract) user-fields with type and value.

field names ... list of field names to show or None for all.

Returns list of tuples (<field name>, <field type>, <value>).

list values(self, field names)

Extract the contents of given field names from the file.

field names ... list of field names

Returns list of field values.

get(self, field name)

Extract the contents of this field from the file.

Returns field value or None if field does not exist.

get type and value(self, field name)

Extract the type and contents of this field from the file.

Returns tuple (<type>, <field-value>) or None if field does not exist.

update(self, data)

Set the value of user fields. The field types will be the same.

data ... dict, with field name as key, field value as value

Returns None



33.3.2 Properties

89

Class ODFContentParser Module odf.userfield

Name Description



Name Description

src file Value: None

dest file Value: None

33.4 Class ODFContentParser


xml.sax.saxutils.XMLGenerator

odf.userfield.ODFContentParser

33.4.1 Methods

init (self, callback func, out=None, encoding=’utf-8’)

Constructor.

callback func ... function called for each field found in odf document

signature: field name ... name of current field

value type ... type of current field

value ... value of current field

attrs ... tuple of attrs of current field

returns: tuple or dict of attrs

out ... file like object for output

encoding ... encoding for output


90

Class ODFContentParser Module odf.userfield

startElementNS(self, name, qname, attrs)





content(self )

Inherited from xml.sax.saxutils.XMLGenerator

characters(), endElement(), endElementNS(), endPrefixMapping(), ignorableWhites-pace(), processingInstruction(), startDocument(), startElement(), startPrefixMap-ping()


endDocument(), setDocumentLocator(), skippedEntity()

91

Variables Module odf.xforms

34 Module odf.xforms

34.1 Functions

Model(**args)

Instance(**args)

Bind(**args)

34.2 Variables

Name Description


92

Index

odf (package), 2odf.anim (module), 3

odf.anim.Animate (function), 3odf.anim.Animatecolor (function), 3odf.anim.Animatemotion (function), 3odf.anim.Animatetransform (function),

3odf.anim.Audio (function), 3odf.anim.Command (function), 3odf.anim.Iterate (function), 3odf.anim.Par (function), 3odf.anim.Param (function), 3odf.anim.Seq (function), 3odf.anim.Set (function), 3odf.anim.Transitionfilter (function), 3

odf.attrconverters (module), 4–6odf.attrconverters.AttrConverters (class),

6odf.attrconverters.cnv anyURI (function),

4odf.attrconverters.cnv boolean (function),

4odf.attrconverters.cnv color (function),

4odf.attrconverters.cnv configtype (func-

tion), 4odf.attrconverters.cnv data source has labels

(function), 4odf.attrconverters.cnv date (function), 4odf.attrconverters.cnv dateTime (func-

tion), 4odf.attrconverters.cnv double (function),

4odf.attrconverters.cnv DrawNameRef (func-

tion), 5odf.attrconverters.cnv duration (function),

4odf.attrconverters.cnv family (function),

4odf.attrconverters.cnv ID (function), 4odf.attrconverters.cnv IDREF (function),

4

odf.attrconverters.cnv integer (function),4

odf.attrconverters.cnv legend position (func-tion), 4

odf.attrconverters.cnv length (function),4

odf.attrconverters.cnv lengthorpercent (func-tion), 4

odf.attrconverters.cnv major minor (func-tion), 4

odf.attrconverters.cnv metavaluetype (func-tion), 4

odf.attrconverters.cnv namespacedToken(function), 4

odf.attrconverters.cnv NCName (func-tion), 5

odf.attrconverters.cnv NCNames (func-tion), 5

odf.attrconverters.cnv nonNegativeInteger(function), 5

odf.attrconverters.cnv percent (function),5

odf.attrconverters.cnv points (function),5

odf.attrconverters.cnv positiveInteger (func-tion), 5

odf.attrconverters.cnv string (function),5

odf.attrconverters.cnv StyleNameRef (func-tion), 5

odf.attrconverters.cnv textnoteclass (func-tion), 5

odf.attrconverters.cnv time (function),5

odf.attrconverters.cnv token (function),5

odf.attrconverters.cnv viewbox (function),5

odf.attrconverters.cnv xlinkshow (func-tion), 5

odf.attrconverters.make NCName (func-tion), 4

93

INDEX INDEX

odf.chart (module), 7–8odf.chart.Axis (function), 7odf.chart.Categories (function), 7odf.chart.Chart (function), 7odf.chart.DataPoint (function), 7odf.chart.Domain (function), 7odf.chart.ErrorIndicator (function), 7odf.chart.Floor (function), 7odf.chart.Footer (function), 7odf.chart.Grid (function), 7odf.chart.Legend (function), 7odf.chart.MeanValue (function), 7odf.chart.PlotArea (function), 7odf.chart.RegressionCurve (function), 7odf.chart.Series (function), 7odf.chart.StockGainMarker (function),

7odf.chart.StockLossMarker (function), 7odf.chart.StockRangeLine (function), 7odf.chart.Subtitle (function), 7odf.chart.SymbolImage (function), 7odf.chart.Title (function), 7odf.chart.Wall (function), 8

odf.config (module), 9odf.config.ConfigItem (function), 9odf.config.ConfigItemMapEntry (func-

tion), 9odf.config.ConfigItemMapIndexed (func-

tion), 9odf.config.ConfigItemMapNamed (func-

tion), 9odf.config.ConfigItemSet (function), 9

odf.dc (module), 10odf.dc.Creator (function), 10odf.dc.Date (function), 10odf.dc.Description (function), 10odf.dc.Language (function), 10odf.dc.Subject (function), 10odf.dc.Title (function), 10

odf.dr3d (module), 11odf.dr3d.Cube (function), 11odf.dr3d.Extrude (function), 11odf.dr3d.Light (function), 11odf.dr3d.Rotate (function), 11

odf.dr3d.Scene (function), 11odf.dr3d.Sphere (function), 11

odf.draw (module), 12–14odf.draw.A (function), 12odf.draw.Applet (function), 12odf.draw.AreaCircle (function), 12odf.draw.AreaPolygon (function), 12odf.draw.AreaRectangle (function), 12odf.draw.Caption (function), 12odf.draw.Circle (function), 12odf.draw.Connector (function), 12odf.draw.ContourPath (function), 12odf.draw.ContourPolygon (function), 12odf.draw.Control (function), 12odf.draw.CustomShape (function), 12odf.draw.DrawElement (function), 12odf.draw.Ellipse (function), 12odf.draw.EnhancedGeometry (function),

12odf.draw.Equation (function), 12odf.draw.FillImage (function), 12odf.draw.FloatingFrame (function), 12odf.draw.Frame (function), 12odf.draw.G (function), 13odf.draw.GluePoint (function), 13odf.draw.Gradient (function), 13odf.draw.Handle (function), 13odf.draw.Hatch (function), 13odf.draw.Image (function), 13odf.draw.ImageMap (function), 13odf.draw.Layer (function), 13odf.draw.LayerSet (function), 13odf.draw.Line (function), 13odf.draw.Marker (function), 13odf.draw.Measure (function), 13odf.draw.Object (function), 13odf.draw.ObjectOle (function), 13odf.draw.Opacity (function), 13odf.draw.Page (function), 13odf.draw.PageThumbnail (function), 13odf.draw.Param (function), 13odf.draw.Path (function), 13odf.draw.Plugin (function), 13odf.draw.Polygon (function), 13

94

INDEX INDEX

odf.draw.Polyline (function), 14odf.draw.Rect (function), 14odf.draw.RegularPolygon (function), 14odf.draw.StrokeDash (function), 14odf.draw.StyleRefElement (function), 12odf.draw.TextBox (function), 14

odf.easyliststyle (module), 15odf.easyliststyle.styleFromList (function),

15odf.easyliststyle.styleFromString (func-

tion), 15odf.element (module), 16–23

odf.element.CDATASection (class), 20–21

odf.element.Childless (class), 18–19odf.element.Element (class), 21–23odf.element.IllegalChild (class), 16odf.element.IllegalText (class), 16–17odf.element.Node (class), 17–18odf.element.Text (class), 19–20

odf.elementtypes (module), 24odf.form (module), 25–26

odf.form.Button (function), 25odf.form.Checkbox (function), 25odf.form.Column (function), 25odf.form.Combobox (function), 25odf.form.ConnectionResource (function),

25odf.form.Date (function), 25odf.form.File (function), 25odf.form.FixedText (function), 25odf.form.Form (function), 25odf.form.FormattedText (function), 25odf.form.Frame (function), 25odf.form.GenericControl (function), 25odf.form.Grid (function), 25odf.form.Hidden (function), 25odf.form.Image (function), 25odf.form.ImageFrame (function), 25odf.form.Item (function), 25odf.form.Listbox (function), 26odf.form.ListProperty (function), 25odf.form.ListValue (function), 25odf.form.Number (function), 26

odf.form.Option (function), 26odf.form.Password (function), 26odf.form.Properties (function), 26odf.form.Property (function), 26odf.form.Radio (function), 26odf.form.Text (function), 26odf.form.Textarea (function), 26odf.form.Time (function), 26odf.form.ValueRange (function), 26

odf.grammar (module), 27odf.load (module), 28–29

odf.load.LoadParser (class), 28–29odf.manifest (module), 30

odf.manifest.Algorithm (function), 30odf.manifest.EncryptionData (function),

30odf.manifest.FileEntry (function), 30odf.manifest.KeyDerivation (function),

30odf.manifest.Manifest (function), 30

odf.math (module), 31odf.math.Math (function), 31

odf.meta (module), 32odf.meta.AutoReload (function), 32odf.meta.CreationDate (function), 32odf.meta.DateString (function), 32odf.meta.DocumentStatistic (function),

32odf.meta.EditingCycles (function), 32odf.meta.EditingDuration (function), 32odf.meta.Generator (function), 32odf.meta.HyperlinkBehaviour (function),

32odf.meta.InitialCreator (function), 32odf.meta.Keyword (function), 32odf.meta.PrintDate (function), 32odf.meta.PrintedBy (function), 32odf.meta.Template (function), 32odf.meta.UserDefined (function), 32

odf.namespaces (module), 33–34odf.number (module), 35–36

odf.number.AmPm (function), 35odf.number.Boolean (function), 35odf.number.BooleanStyle (function), 35

95

INDEX INDEX

odf.number.CurrencyStyle (function), 35odf.number.CurrencySymbol (function),

35odf.number.DateStyle (function), 35odf.number.Day (function), 35odf.number.DayOfWeek (function), 35odf.number.EmbeddedText (function),

35odf.number.Era (function), 35odf.number.Fraction (function), 35odf.number.Hours (function), 35odf.number.Minutes (function), 35odf.number.Month (function), 35odf.number.Number (function), 35odf.number.NumberStyle (function), 35odf.number.PercentageStyle (function),

35odf.number.Quarter (function), 35odf.number.ScientificNumber (function),

35odf.number.Seconds (function), 36odf.number.Text (function), 36odf.number.TextContent (function), 36odf.number.TextStyle (function), 36odf.number.TimeStyle (function), 36odf.number.WeekOfYear (function), 36odf.number.Year (function), 36

odf.odf2moinmoin (module), 37–40odf.odf2moinmoin.ListProperties (class),

38odf.odf2moinmoin.ODF2MoinMoin (class),

38–40odf.odf2moinmoin.ParagraphProps (class),

37–38odf.odf2moinmoin.TextProps (class), 37

odf.odf2xhtml (module), 41–51odf.odf2xhtml.ODF2XHTML (class), 43–

51odf.odf2xhtml.StyleToCSS (class), 41–

43odf.odf2xhtml.TagStack (class), 43

odf.odfmanifest (module), 52–53odf.odfmanifest.manifestlist (function),

52

odf.odfmanifest.odfmanifest (function),52

odf.odfmanifest.ODFManifestHandler (class),52–53

odf.office (module), 54–55odf.office.Annotation (function), 54odf.office.AutomaticStyles (function), 54odf.office.BinaryData (function), 54odf.office.Body (function), 54odf.office.ChangeInfo (function), 54odf.office.Chart (function), 54odf.office.DdeSource (function), 54odf.office.Document (function), 54odf.office.DocumentContent (function),

54odf.office.DocumentMeta (function), 54odf.office.DocumentSettings (function),

54odf.office.DocumentStyles (function), 54odf.office.Drawing (function), 54odf.office.EventListeners (function), 54odf.office.FontFaceDecls (function), 54odf.office.Forms (function), 54odf.office.Image (function), 54odf.office.MasterStyles (function), 54odf.office.Meta (function), 54odf.office.Presentation (function), 55odf.office.Script (function), 55odf.office.Scripts (function), 55odf.office.Settings (function), 55odf.office.Spreadsheet (function), 55odf.office.Styles (function), 55odf.office.Text (function), 55

odf.opendocument (module), 56–59odf.presentation (module), 60–61

odf.presentation.AnimationGroup (func-tion), 60

odf.presentation.Animations (function),60

odf.presentation.DateTime (function), 60odf.presentation.DateTimeDecl (function),

60odf.presentation.Dim (function), 60odf.presentation.EventListener (function),

96

INDEX INDEX

60odf.presentation.Footer (function), 60odf.presentation.FooterDecl (function),

60odf.presentation.Header (function), 60odf.presentation.HeaderDecl (function),

60odf.presentation.HideShape (function),

60odf.presentation.HideText (function), 60odf.presentation.Notes (function), 60odf.presentation.Placeholder (function),

60odf.presentation.Play (function), 60odf.presentation.Settings (function), 60odf.presentation.Show (function), 60odf.presentation.ShowShape (function),

60odf.presentation.ShowText (function), 60odf.presentation.Sound (function), 61

odf.script (module), 62odf.script.EventListener (function), 62

odf.style (module), 63–65odf.style.BackgroundImage (function), 63odf.style.ChartProperties (function), 63odf.style.Column (function), 63odf.style.Columns (function), 63odf.style.ColumnSep (function), 63odf.style.DefaultStyle (function), 63odf.style.DrawingPageProperties (func-

tion), 63odf.style.DropCap (function), 63odf.style.FontFace (function), 63odf.style.Footer (function), 63odf.style.FooterLeft (function), 63odf.style.FooterStyle (function), 63odf.style.FootnoteSep (function), 63odf.style.GraphicProperties (function),

63odf.style.HandoutMaster (function), 63odf.style.Header (function), 63odf.style.HeaderFooterProperties (func-

tion), 63odf.style.HeaderLeft (function), 63

odf.style.HeaderStyle (function), 64odf.style.ListLevelProperties (function),

64odf.style.Map (function), 64odf.style.MasterPage (function), 64odf.style.PageLayout (function), 64odf.style.PageLayoutProperties (function),

64odf.style.ParagraphProperties (function),

64odf.style.PresentationPageLayout (func-

tion), 64odf.style.RegionCenter (function), 64odf.style.RegionLeft (function), 64odf.style.RegionRight (function), 64odf.style.RubyProperties (function), 64odf.style.SectionProperties (function), 64odf.style.Style (function), 64odf.style.StyleElement (function), 63odf.style.TableCellProperties (function),

64odf.style.TableColumnProperties (func-

tion), 64odf.style.TableProperties (function), 64odf.style.TableRowProperties (function),

64odf.style.TabStop (function), 64odf.style.TabStops (function), 64odf.style.TextProperties (function), 65

odf.svg (module), 66odf.svg.DefinitionSrc (function), 66odf.svg.Desc (function), 66odf.svg.FontFaceFormat (function), 66odf.svg.FontFaceName (function), 66odf.svg.FontFaceSrc (function), 66odf.svg.FontFaceUri (function), 66odf.svg.Lineargradient (function), 66odf.svg.Radialgradient (function), 66odf.svg.Stop (function), 66

odf.table (module), 67–71odf.table.Body (function), 67odf.table.CalculationSettings (function),

67odf.table.CellAddress (function), 67

97

INDEX INDEX

odf.table.CellContentChange (function),67

odf.table.CellContentDeletion (function),67

odf.table.CellRangeSource (function), 67odf.table.ChangeDeletion (function), 67odf.table.ChangeTrackTableCell (func-

tion), 67odf.table.Consolidation (function), 67odf.table.ContentValidation (function),

67odf.table.ContentValidations (function),

67odf.table.CoveredTableCell (function), 67odf.table.CutOffs (function), 67odf.table.DatabaseRange (function), 68odf.table.DatabaseRanges (function), 68odf.table.DatabaseSourceQuery (function),

68odf.table.DatabaseSourceSql (function),

68odf.table.DatabaseSourceTable (function),

68odf.table.DataPilotDisplayInfo (function),

67odf.table.DataPilotField (function), 67odf.table.DataPilotFieldReference (func-

tion), 67odf.table.DataPilotGroup (function), 67odf.table.DataPilotGroupMember (func-

tion), 67odf.table.DataPilotGroups (function), 67odf.table.DataPilotLayoutInfo (function),

68odf.table.DataPilotLevel (function), 68odf.table.DataPilotMember (function),

68odf.table.DataPilotMembers (function),

68odf.table.DataPilotSortInfo (function),

68odf.table.DataPilotSubtotal (function),

68odf.table.DataPilotSubtotals (function),

68odf.table.DataPilotTable (function), 68odf.table.DataPilotTables (function), 68odf.table.DdeLink (function), 68odf.table.DdeLinks (function), 68odf.table.Deletion (function), 68odf.table.Deletions (function), 68odf.table.Dependencies (function), 68odf.table.Dependency (function), 68odf.table.Detective (function), 69odf.table.ErrorMacro (function), 69odf.table.ErrorMessage (function), 69odf.table.EvenColumns (function), 69odf.table.EvenRows (function), 69odf.table.Filter (function), 69odf.table.FilterAnd (function), 69odf.table.FilterCondition (function), 69odf.table.FilterOr (function), 69odf.table.FirstColumn (function), 69odf.table.FirstRow (function), 69odf.table.HelpMessage (function), 69odf.table.HighlightedRange (function),

69odf.table.Insertion (function), 69odf.table.InsertionCutOff (function), 69odf.table.Iteration (function), 69odf.table.LabelRange (function), 69odf.table.LabelRanges (function), 69odf.table.LastColumn (function), 69odf.table.LastRow (function), 69odf.table.Movement (function), 70odf.table.MovementCutOff (function), 70odf.table.NamedExpression (function),

70odf.table.NamedExpressions (function),

70odf.table.NamedRange (function), 70odf.table.NullDate (function), 70odf.table.OddColumns (function), 70odf.table.OddRows (function), 70odf.table.Operation (function), 70odf.table.Previous (function), 70odf.table.Scenario (function), 70odf.table.Shapes (function), 70

98

INDEX INDEX

odf.table.Sort (function), 70odf.table.SortBy (function), 70odf.table.SortGroups (function), 70odf.table.SourceCellRange (function), 70odf.table.SourceRangeAddress (function),

70odf.table.SourceService (function), 70odf.table.SubtotalField (function), 70odf.table.SubtotalRule (function), 70odf.table.SubtotalRules (function), 71odf.table.Table (function), 71odf.table.TableCell (function), 71odf.table.TableColumn (function), 71odf.table.TableColumnGroup (function),

71odf.table.TableColumns (function), 71odf.table.TableHeaderColumns (function),

71odf.table.TableHeaderRows (function),

71odf.table.TableRow (function), 71odf.table.TableRowGroup (function), 71odf.table.TableRows (function), 71odf.table.TableSource (function), 71odf.table.TableTemplate (function), 71odf.table.TargetRangeAddress (function),

71odf.table.TrackedChanges (function), 71

odf.teletype (module), 72–73odf.teletype.addTextToElement (function),

72odf.teletype.extractText (function), 72odf.teletype.WhitespaceText (class), 72–

73odf.text (module), 74–83

odf.text.A (function), 74odf.text.AlphabeticalIndex (function), 74odf.text.AlphabeticalIndexAutoMarkFile

(function), 74odf.text.AlphabeticalIndexEntryTemplate

(function), 74odf.text.AlphabeticalIndexMark (func-

tion), 74odf.text.AlphabeticalIndexMarkEnd (func-

tion), 74odf.text.AlphabeticalIndexMarkStart (func-

tion), 74odf.text.AlphabeticalIndexSource (func-

tion), 74odf.text.AuthorInitials (function), 74odf.text.AuthorName (function), 74odf.text.Bibliography (function), 74odf.text.BibliographyConfiguration (func-

tion), 74odf.text.BibliographyEntryTemplate (func-

tion), 74odf.text.BibliographyMark (function), 74odf.text.BibliographySource (function),

74odf.text.Bookmark (function), 74odf.text.BookmarkEnd (function), 74odf.text.BookmarkRef (function), 74odf.text.BookmarkStart (function), 74odf.text.Change (function), 75odf.text.ChangedRegion (function), 75odf.text.ChangeEnd (function), 75odf.text.ChangeStart (function), 75odf.text.Chapter (function), 75odf.text.CharacterCount (function), 75odf.text.ConditionalText (function), 75odf.text.CreationDate (function), 75odf.text.CreationTime (function), 75odf.text.Creator (function), 75odf.text.DatabaseDisplay (function), 75odf.text.DatabaseName (function), 75odf.text.DatabaseNext (function), 75odf.text.DatabaseRowNumber (function),

75odf.text.DatabaseRowSelect (function),

75odf.text.Date (function), 75odf.text.DdeConnection (function), 75odf.text.DdeConnectionDecl (function),

75odf.text.DdeConnectionDecls (function),

75odf.text.Deletion (function), 75odf.text.Description (function), 76

99

INDEX INDEX

odf.text.EditingCycles (function), 76odf.text.EditingDuration (function), 76odf.text.ExecuteMacro (function), 76odf.text.Expression (function), 76odf.text.FileName (function), 76odf.text.FormatChange (function), 76odf.text.H (function), 76odf.text.HiddenParagraph (function), 76odf.text.HiddenText (function), 76odf.text.IllustrationIndex (function), 76odf.text.IllustrationIndexEntryTemplate

(function), 76odf.text.IllustrationIndexSource (func-

tion), 76odf.text.ImageCount (function), 76odf.text.IndexBody (function), 76odf.text.IndexEntryBibliography (func-

tion), 76odf.text.IndexEntryChapter (function),

76odf.text.IndexEntryLinkEnd (function),

76odf.text.IndexEntryLinkStart (function),

76odf.text.IndexEntryPageNumber (func-

tion), 76odf.text.IndexEntrySpan (function), 77odf.text.IndexEntryTabStop (function),

77odf.text.IndexEntryText (function), 77odf.text.IndexSourceStyle (function), 77odf.text.IndexSourceStyles (function), 77odf.text.IndexTitle (function), 77odf.text.IndexTitleTemplate (function),

77odf.text.InitialCreator (function), 77odf.text.Insertion (function), 77odf.text.Keywords (function), 77odf.text.LineBreak (function), 77odf.text.LinenumberingConfiguration (func-

tion), 77odf.text.LinenumberingSeparator (func-

tion), 77odf.text.List (function), 77

odf.text.ListHeader (function), 77odf.text.ListItem (function), 77odf.text.ListLevelStyleBullet (function),

77odf.text.ListLevelStyleImage (function),

77odf.text.ListLevelStyleNumber (function),

77odf.text.ListStyle (function), 77odf.text.Measure (function), 78odf.text.ModificationDate (function), 78odf.text.ModificationTime (function), 78odf.text.Note (function), 78odf.text.NoteBody (function), 78odf.text.NoteCitation (function), 78odf.text.NoteContinuationNoticeBackward

(function), 78odf.text.NoteContinuationNoticeForward

(function), 78odf.text.NoteRef (function), 78odf.text.NotesConfiguration (function),

78odf.text.Number (function), 78odf.text.NumberedParagraph (function),

78odf.text.ObjectCount (function), 78odf.text.ObjectIndex (function), 78odf.text.ObjectIndexEntryTemplate (func-

tion), 78odf.text.ObjectIndexSource (function),

78odf.text.OutlineLevelStyle (function), 78odf.text.OutlineStyle (function), 78odf.text.P (function), 78odf.text.Page (function), 78odf.text.PageContinuation (function), 79odf.text.PageCount (function), 79odf.text.PageNumber (function), 79odf.text.PageSequence (function), 79odf.text.PageVariableGet (function), 79odf.text.PageVariableSet (function), 79odf.text.ParagraphCount (function), 79odf.text.Placeholder (function), 79odf.text.PrintDate (function), 79

100

INDEX INDEX

odf.text.PrintedBy (function), 79odf.text.PrintTime (function), 79odf.text.ReferenceMark (function), 79odf.text.ReferenceMarkEnd (function),

79odf.text.ReferenceMarkStart (function),

79odf.text.ReferenceRef (function), 79odf.text.Ruby (function), 79odf.text.RubyBase (function), 79odf.text.RubyText (function), 79odf.text.S (function), 79odf.text.Script (function), 79odf.text.Section (function), 80odf.text.SectionSource (function), 80odf.text.SenderCity (function), 80odf.text.SenderCompany (function), 80odf.text.SenderCountry (function), 80odf.text.SenderEmail (function), 80odf.text.SenderFax (function), 80odf.text.SenderFirstname (function), 80odf.text.SenderInitials (function), 80odf.text.SenderLastname (function), 80odf.text.SenderPhonePrivate (function),

80odf.text.SenderPhoneWork (function), 80odf.text.SenderPosition (function), 80odf.text.SenderPostalCode (function), 80odf.text.SenderStateOrProvince (func-

tion), 80odf.text.SenderStreet (function), 80odf.text.SenderTitle (function), 80odf.text.Sequence (function), 80odf.text.SequenceDecl (function), 80odf.text.SequenceDecls (function), 80odf.text.SequenceRef (function), 81odf.text.SheetName (function), 81odf.text.SortKey (function), 81odf.text.Span (function), 81odf.text.Subject (function), 81odf.text.Tab (function), 81odf.text.TableCount (function), 81odf.text.TableFormula (function), 81odf.text.TableIndex (function), 81

odf.text.TableIndexEntryTemplate (func-tion), 81

odf.text.TableIndexSource (function), 81odf.text.TableOfContent (function), 81odf.text.TableOfContentEntryTemplate

(function), 81odf.text.TableOfContentSource (function),

81odf.text.TemplateName (function), 81odf.text.TextInput (function), 81odf.text.Time (function), 81odf.text.Title (function), 81odf.text.TocMark (function), 81odf.text.TocMarkEnd (function), 81odf.text.TocMarkStart (function), 82odf.text.TrackedChanges (function), 82odf.text.UserDefined (function), 82odf.text.UserFieldDecl (function), 82odf.text.UserFieldDecls (function), 82odf.text.UserFieldGet (function), 82odf.text.UserFieldInput (function), 82odf.text.UserIndex (function), 82odf.text.UserIndexEntryTemplate (func-

tion), 82odf.text.UserIndexMark (function), 82odf.text.UserIndexMarkEnd (function),

82odf.text.UserIndexMarkStart (function),

82odf.text.UserIndexSource (function), 82odf.text.VariableDecl (function), 82odf.text.VariableDecls (function), 82odf.text.VariableGet (function), 82odf.text.VariableInput (function), 82odf.text.VariableSet (function), 82odf.text.WordCount (function), 82

odf.thumbnail (module), 84odf.thumbnail.thumbnail (function), 84

odf.userfield (module), 85–88odf.userfield.ODFContentParser (class),

87–88odf.userfield.UserFields (class), 85–87odf.userfield.writeattr (function), 85odf.userfield.writetext (function), 85

101

INDEX INDEX

odf.xforms (module), 89odf.xforms.Bind (function), 89odf.xforms.Instance (function), 89odf.xforms.Model (function), 89

odf.opendocument.load (function), 56odf.opendocument.OpaqueObject (class), 56–

57odf.opendocument.OpaqueObject. init (method),

57odf.opendocument.OpenDocument (class), 57–

59odf.opendocument.OpenDocument. init

(method), 57odf.opendocument.OpenDocument.addObject

(method), 58odf.opendocument.OpenDocument.addPicture

(method), 58odf.opendocument.OpenDocument.addPictureFromFile

(method), 58odf.opendocument.OpenDocument.addPictureFromString

(method), 58odf.opendocument.OpenDocument.addThumbnail

(method), 58odf.opendocument.OpenDocument.build caches

(method), 57odf.opendocument.OpenDocument.clear caches

(method), 57odf.opendocument.OpenDocument.contentxml

(method), 57odf.opendocument.OpenDocument.createCDATASection

(method), 59odf.opendocument.OpenDocument.createElement

(method), 58odf.opendocument.OpenDocument.createTextNode

(method), 58odf.opendocument.OpenDocument.getElementsByType

(method), 59odf.opendocument.OpenDocument.getMediaType

(method), 59odf.opendocument.OpenDocument.getStyleByName

(method), 59odf.opendocument.OpenDocument.manifestxml

(method), 57odf.opendocument.OpenDocument.metaxml

(method), 57odf.opendocument.OpenDocument.rebuild caches

(method), 57odf.opendocument.OpenDocument.save (method),

58odf.opendocument.OpenDocument.settingsxml

(method), 57odf.opendocument.OpenDocument.stylesxml

(method), 58odf.opendocument.OpenDocument.toXml

(method), 57odf.opendocument.OpenDocument.write (method),

58odf.opendocument.OpenDocument.xml (method),

57odf.opendocument.OpenDocumentChart (func-

tion), 56odf.opendocument.OpenDocumentDrawing (func-

tion), 56odf.opendocument.OpenDocumentImage (func-

tion), 56odf.opendocument.OpenDocumentPresentation

(function), 56odf.opendocument.OpenDocumentSpreadsheet

(function), 56odf.opendocument.OpenDocumentText (func-

tion), 56

102

odfpy api generated by epydoc

Documents