Sei sulla pagina 1di 102

API Documentation

API Documentation

June 4, 2009

Contents

Contents 1

1 Package odf 2
1.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2 Module odf.anim 3
2.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3 Module odf.attrconverters 4
3.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.3 Class AttrConverters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

4 Module odf.chart 7
4.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

5 Module odf.config 9
5.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

6 Module odf.dc 10
6.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
6.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

7 Module odf.dr3d 11
7.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
7.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

8 Module odf.draw 12
8.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
8.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

9 Module odf.easyliststyle 15
9.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1
CONTENTS CONTENTS

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

10 Module odf.element 16
10.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.2 Class IllegalChild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.2.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.2.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.3 Class IllegalText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
10.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
10.3.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
10.4 Class Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
10.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
10.4.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
10.4.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
10.5 Class Childless . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
10.5.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
10.5.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
10.6 Class Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
10.6.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
10.6.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
10.7 Class CDATASection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
10.7.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
10.7.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
10.8 Class Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
10.8.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
10.8.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
10.8.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

11 Module odf.elementtypes 24
11.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

12 Module odf.form 25
12.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
12.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

13 Module odf.grammar 27
13.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

14 Module odf.load 28
14.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
14.2 Class LoadParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
14.2.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
14.2.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

15 Module odf.manifest 30
15.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
15.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

16 Module odf.math 31
16.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
16.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

17 Module odf.meta 32

2
CONTENTS CONTENTS

17.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
17.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

18 Module odf.namespaces 33
18.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

19 Module odf.number 35
19.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
19.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

20 Module odf.odf2moinmoin 37
20.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
20.2 Class TextProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
20.2.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
20.3 Class ParagraphProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
20.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
20.4 Class ListProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
20.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
20.5 Class ODF2MoinMoin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
20.5.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
20.5.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

21 Module odf.odf2xhtml 41
21.1 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
21.2 Class StyleToCSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
21.2.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
21.3 Class TagStack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
21.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
21.4 Class ODF2XHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
21.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
21.4.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

22 Module odf.odfmanifest 52
22.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
22.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
22.3 Class ODFManifestHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
22.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

23 Module odf.office 54
23.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
23.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

24 Module odf.opendocument 56
24.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
24.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
24.3 Class OpaqueObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
24.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
24.4 Class OpenDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
24.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
24.4.2 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

25 Module odf.presentation 60
25.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

3
CONTENTS CONTENTS

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

26 Module odf.script 62
26.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
26.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

27 Module odf.style 63
27.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
27.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

28 Module odf.svg 66
28.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
28.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

29 Module odf.table 67
29.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
29.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

30 Module odf.teletype 72
30.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
30.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
30.3 Class WhitespaceText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
30.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
30.3.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

31 Module odf.text 74
31.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
31.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

32 Module odf.thumbnail 84
32.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
32.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

33 Module odf.userfield 85
33.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
33.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
33.3 Class UserFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
33.3.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
33.3.2 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
33.3.3 Class Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
33.4 Class ODFContentParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
33.4.1 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

34 Module odf.xforms 89
34.1 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
34.2 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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): <...
package Value: ’odf’

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
package Value: ’odf’

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
package Value: ’odf’

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
package Value: ’odf’

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
package Value: ’odf’

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
package Value: ’odf’

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
package Value: ’odf’

18
Class IllegalChild Module odf.element

10 Module odf.element

10.1 Variables
Name Description
package Value: ’odf’

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.BaseException
args, message
Inherited 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 ()
Inherited from object
format (), hash (), reduce ex (), sizeof (), subclasshook ()

10.3.2 Properties

Name Description
Inherited from exceptions.BaseException
args, message
Inherited 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.Node
ATTRIBUTE 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 Node
methods 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 )

10.5.2 Class Variables

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()

10.6.2 Class Variables

Name Description
nodeType Value: 3
tagName Value: ’Text’
Inherited from odf.element.Childless (Section 10.5)
attributes, childNodes, firstChild, lastChild
Inherited from odf.element.Node (Section 10.4)
nextSibling, parentNode, previousSibling
Inherited from xml.dom.Node
ATTRIBUTE 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

odf.element.Childless

odf.element.Childless

xml.dom.Node

odf.element.Node

odf.element.Text
odf.element.CDATASection

23
Class Element Module odf.element

10.7.1 Methods

toXml(self, level, f )

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 ()

10.7.2 Class Variables

Name Description
nodeType Value: 4
Inherited from odf.element.Childless (Section 10.5)
attributes, childNodes, firstChild, lastChild
Inherited from odf.element.Text (Section 10.6)
tagName
Inherited from odf.element.Node (Section 10.4)
nextSibling, parentNode, previousSibling
Inherited from xml.dom.Node
ATTRIBUTE 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 main
advantage of this kind of implementation is that you don’t have to create a toXML method

24
Class Element Module odf.element

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. All
attributes in ODF have namespaces. The library knows what attributes are
legal and then allows the user to provide the attribute as a keyword argument
and the library will add the correct namespace. Must overwrite, If attribute
already exists.

setAttrNS(self, namespace, localpart, value)


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

getAttrNS(self, namespace, localpart)

25
Class Element Module odf.element

removeAttrNS(self, namespace, localpart)

getAttribute(self, attr )

write open tag(self, level, f )

write close tag(self, level, f )

toXml(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

10.8.3 Class Variables

Name Description
nodeType Value: 1
namespaces Value: {}
Inherited from odf.element.Node (Section 10.4)
nextSibling, parentNode, previousSibling
Inherited from xml.dom.Node
ATTRIBUTE 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’,..
package Value: ’odf’

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
package Value: ’odf’

29
Variables Module odf.grammar

13 Module odf.grammar

In principle the OpenDocument schema converted to python structures. Currently it contains


the 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’): (), (...
package Value: ’odf’

30
Class LoadParser Module odf.load

14 Module odf.load

14.1 Variables
Name Description
package Value: ’odf’

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. SAX
parsers may return all contiguous character data in a single chunk, or they
may split it into several chunks; however, all of the characters in any single
event must come from the same external entity so that the Locator provides
useful information.
Overrides: xml.sax.handler.ContentHandler.characters extit(inherited
documentation)

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 the
source document, and the attrs parameter holds an instance of the Attributes
class 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(inherited
documentation)

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 the
startElementNS event.
Overrides: xml.sax.handler.ContentHandler.endElementNS extit(inherited
documentation)

Inherited from xml.sax.handler.ContentHandler


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

14.2.2 Class Variables

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
package Value: ’odf’

33
Variables Module odf.math

16 Module odf.math

16.1 Functions

Math(**args)

16.2 Variables
Name Description
package Value: ’odf’

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
package Value: ’odf’

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
package Value: ’odf’

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’,...
package Value: ’odf’
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 differs
from first call

textToString(self, element)

paragraphToString(self, paragraph, indent=0)

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

Inherited from object


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

20.5.2 Properties

Name Description
Inherited from object
class

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...
package Value: ’odf’

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 in
a 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 particular
font. Fortunately ODF provides generic fallbacks. Unfortunately they are not
the same as CSS2. CSS2: serif, sans-serif, cursive, fantasy, monospace ODF:
roman, swiss, modern, decorative, script, system This method put the font and
fallback into a dictionary

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


Fill a figure with an image. Since CSS doesn’t let you resize images this
should really be implemented as an absolutely position <img> with a width
and 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 in
text-properties.

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


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

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

The second value is optional and specifies the font height as a percentage that
relates to the current font-height. If this value is not specified, an appropriate
font height is used. Although this value may change the font height that is
displayed, it never changes the current font height that is used for additional
calculations.

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% of
the browser width

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


Set underline decoration HTML doesn’t really have a page-width. It is always
100% 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 always
100% 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 already
CSS2

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

xml.sax.handler.ContentHandler
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)


Overrides: xml.sax.handler.ContentHandler. init

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. SAX
parsers may return all contiguous character data in a single chunk, or they
may split it into several chunks; however, all of the characters in any single
event must come from the same external entity so that the Locator provides
useful information.
Overrides: xml.sax.handler.ContentHandler.characters extit(inherited
documentation)

handle starttag(self, tag, method, attrs)

handle endtag(self, tag, attrs, method )

47
Class ODF2XHTML Module odf.odf2xhtml

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 the
source document, and the attrs parameter holds an instance of the Attributes
class 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(inherited
documentation)

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 the
startElementNS event.
Overrides: xml.sax.handler.ContentHandler.endElementNS extit(inherited
documentation)

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
Class ODF2XHTML Module odf.odf2xhtml

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 Pictures
subfolder

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 in
HTML. 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
Class ODF2XHTML Module odf.odf2xhtml

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
Class ODF2XHTML Module odf.odf2xhtml

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 particular
font. Luckily ODF provides generic fallbacks Unluckily they are not the same
as 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 be
used for both paragraph and character styles Since CSS has no scope we use a
prefix. (Not elegant) In ODF a style can have a parent, these parents can be
chained. We may not have encountered the parent yet, but if we have, we
resolve it.

e style style(self, tag, attrs)


End this style

51
Class ODF2XHTML Module odf.odf2xhtml

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
Class ODF2XHTML Module odf.odf2xhtml

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


CSS doesn’t have the ability to set the glyph to a particular character, so we
just 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 &nbsp; We
use &#160; 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 is
typically used to properties of the text.

e text span(self, tag, attrs)


End the <text:span>

53
Class ODF2XHTML Module odf.odf2xhtml

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 )

Inherited from xml.sax.handler.ContentHandler


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

21.4.2 Class Variables

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’
package Value: ’odf’

22.3 Class ODFManifestHandler

xml.sax.handler.ContentHandler
odf.odfmanifest.ODFManifestHandler
The ODFManifestHandler parses a manifest file and produces a list of content

22.3.1 Methods

init (self )
Overrides: xml.sax.handler.ContentHandler. init

handle starttag(self, tag, method, attrs)

handle endtag(self, tag, method )

55
Class ODFManifestHandler Module odf.odfmanifest

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 the
source document, and the attrs parameter holds an instance of the Attributes
class 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(inherited
documentation)

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 the
startElementNS event.
Overrides: xml.sax.handler.ContentHandler.endElementNS extit(inherited
documentation)

unknown starttag(self, tag, attrs)

unknown endtag(self, tag)

donothing(self, tag, attrs=None)

s file entry(self, tag, attrs)

Inherited from xml.sax.handler.ContentHandler


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
package Value: ’odf’

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...
package Value: ’odf’

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 write
the 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 in
UTF-8 encoding

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

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 picture
in the zipfile in the subdirectory ’Pictures’ If passed a file ptr, mediatype must
be set

addPictureFromFile(self, filename, mediatype=None)


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

addPictureFromString(self, content, mediatype)


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

addThumbnail(self, filecontent=None)
Add a fixed thumbnail The thumbnail in the library is big, so this is pretty
useless.

addObject(self, document, objectname=None)


Add an object. The object must be an OpenDocument class The return value
will 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 not
allow 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)

24.4.2 Class Variables

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
package Value: ’odf’

64
Variables Module odf.script

26 Module odf.script

26.1 Functions

EventListener(**args)

26.2 Variables
Name Description
package Value: ’odf’

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
package Value: ’odf’

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
package Value: ’odf’

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
Functions Module odf.table

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
Functions Module odf.table

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
package Value: ’odf’

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 ODF
content, 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. This
method 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
package Value: ’odf’

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.

Inherited from object


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

30.3.2 Properties

Name Description
Inherited from object
class

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
Functions Module odf.text

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
Functions Module odf.text

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
Functions Module odf.text

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
Functions Module odf.text

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
Functions Module odf.text

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
Functions Module odf.text

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
Functions Module odf.text

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
package Value: ’odf’

86
Variables Module odf.thumbnail

32 Module odf.thumbnail

32.1 Functions

thumbnail()

32.2 Variables
Name Description
iconstr Value:
’iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAAG0OVFdAAAABGdBTUEA..
package Value: ’odf’

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’: ’&#x0a;’}
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
Inherited from object
delattr (), format (), getattribute (), hash (), new (), reduce (), reduce ex (),
repr (), setattr (), sizeof (), str (), subclasshook ()

33.3.2 Properties

89
Class ODFContentParser Module odf.userfield

Name Description
Inherited from object
class

33.3.3 Class Variables

Name Description
src file Value: None
dest file Value: None

33.4 Class ODFContentParser

xml.sax.handler.ContentHandler

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
Overrides: xml.sax.handler.ContentHandler. init

90
Class ODFContentParser Module odf.userfield

startElementNS(self, name, 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 the
source document, and the attrs parameter holds an instance of the Attributes
class 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(inherited
documentation)

content(self )

Inherited from xml.sax.saxutils.XMLGenerator


characters(), endElement(), endElementNS(), endPrefixMapping(), ignorableWhites-
pace(), processingInstruction(), startDocument(), startElement(), startPrefixMap-
ping()
Inherited from xml.sax.handler.ContentHandler
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
package Value: ’odf’

92
Index
odf (package), 2 odf.attrconverters.cnv integer (function),
odf.anim (module), 3 4
odf.anim.Animate (function), 3 odf.attrconverters.cnv legend position (func-
odf.anim.Animatecolor (function), 3 tion), 4
odf.anim.Animatemotion (function), 3 odf.attrconverters.cnv length (function),
odf.anim.Animatetransform (function), 4
3 odf.attrconverters.cnv lengthorpercent (func-
odf.anim.Audio (function), 3 tion), 4
odf.anim.Command (function), 3 odf.attrconverters.cnv major minor (func-
odf.anim.Iterate (function), 3 tion), 4
odf.anim.Par (function), 3 odf.attrconverters.cnv metavaluetype (func-
odf.anim.Param (function), 3 tion), 4
odf.anim.Seq (function), 3 odf.attrconverters.cnv namespacedToken
odf.anim.Set (function), 3 (function), 4
odf.anim.Transitionfilter (function), 3 odf.attrconverters.cnv NCName (func-
odf.attrconverters (module), 4–6 tion), 5
odf.attrconverters.AttrConverters (class), odf.attrconverters.cnv NCNames (func-
6 tion), 5
odf.attrconverters.cnv anyURI (function), odf.attrconverters.cnv nonNegativeInteger
4 (function), 5
odf.attrconverters.cnv boolean (function), odf.attrconverters.cnv percent (function),
4 5
odf.attrconverters.cnv color (function), odf.attrconverters.cnv points (function),
4 5
odf.attrconverters.cnv configtype (func- odf.attrconverters.cnv positiveInteger (func-
tion), 4 tion), 5
odf.attrconverters.cnv data source has labels odf.attrconverters.cnv string (function),
(function), 4 5
odf.attrconverters.cnv date (function), 4 odf.attrconverters.cnv StyleNameRef (func-
odf.attrconverters.cnv dateTime (func- tion), 5
tion), 4 odf.attrconverters.cnv textnoteclass (func-
odf.attrconverters.cnv double (function), tion), 5
4 odf.attrconverters.cnv time (function),
odf.attrconverters.cnv DrawNameRef (func- 5
tion), 5 odf.attrconverters.cnv token (function),
odf.attrconverters.cnv duration (function), 5
4 odf.attrconverters.cnv viewbox (function),
odf.attrconverters.cnv family (function), 5
4 odf.attrconverters.cnv xlinkshow (func-
odf.attrconverters.cnv ID (function), 4 tion), 5
odf.attrconverters.cnv IDREF (function), odf.attrconverters.make NCName (func-
4 tion), 4

93
INDEX INDEX

odf.chart (module), 7–8 odf.dr3d.Scene (function), 11


odf.chart.Axis (function), 7 odf.dr3d.Sphere (function), 11
odf.chart.Categories (function), 7 odf.draw (module), 12–14
odf.chart.Chart (function), 7 odf.draw.A (function), 12
odf.chart.DataPoint (function), 7 odf.draw.Applet (function), 12
odf.chart.Domain (function), 7 odf.draw.AreaCircle (function), 12
odf.chart.ErrorIndicator (function), 7 odf.draw.AreaPolygon (function), 12
odf.chart.Floor (function), 7 odf.draw.AreaRectangle (function), 12
odf.chart.Footer (function), 7 odf.draw.Caption (function), 12
odf.chart.Grid (function), 7 odf.draw.Circle (function), 12
odf.chart.Legend (function), 7 odf.draw.Connector (function), 12
odf.chart.MeanValue (function), 7 odf.draw.ContourPath (function), 12
odf.chart.PlotArea (function), 7 odf.draw.ContourPolygon (function), 12
odf.chart.RegressionCurve (function), 7 odf.draw.Control (function), 12
odf.chart.Series (function), 7 odf.draw.CustomShape (function), 12
odf.chart.StockGainMarker (function), odf.draw.DrawElement (function), 12
7 odf.draw.Ellipse (function), 12
odf.chart.StockLossMarker (function), 7 odf.draw.EnhancedGeometry (function),
odf.chart.StockRangeLine (function), 7 12
odf.chart.Subtitle (function), 7 odf.draw.Equation (function), 12
odf.chart.SymbolImage (function), 7 odf.draw.FillImage (function), 12
odf.chart.Title (function), 7 odf.draw.FloatingFrame (function), 12
odf.chart.Wall (function), 8 odf.draw.Frame (function), 12
odf.config (module), 9 odf.draw.G (function), 13
odf.config.ConfigItem (function), 9 odf.draw.GluePoint (function), 13
odf.config.ConfigItemMapEntry (func- odf.draw.Gradient (function), 13
tion), 9 odf.draw.Handle (function), 13
odf.config.ConfigItemMapIndexed (func- odf.draw.Hatch (function), 13
tion), 9 odf.draw.Image (function), 13
odf.config.ConfigItemMapNamed (func- odf.draw.ImageMap (function), 13
tion), 9 odf.draw.Layer (function), 13
odf.config.ConfigItemSet (function), 9 odf.draw.LayerSet (function), 13
odf.dc (module), 10 odf.draw.Line (function), 13
odf.dc.Creator (function), 10 odf.draw.Marker (function), 13
odf.dc.Date (function), 10 odf.draw.Measure (function), 13
odf.dc.Description (function), 10 odf.draw.Object (function), 13
odf.dc.Language (function), 10 odf.draw.ObjectOle (function), 13
odf.dc.Subject (function), 10 odf.draw.Opacity (function), 13
odf.dc.Title (function), 10 odf.draw.Page (function), 13
odf.dr3d (module), 11 odf.draw.PageThumbnail (function), 13
odf.dr3d.Cube (function), 11 odf.draw.Param (function), 13
odf.dr3d.Extrude (function), 11 odf.draw.Path (function), 13
odf.dr3d.Light (function), 11 odf.draw.Plugin (function), 13
odf.dr3d.Rotate (function), 11 odf.draw.Polygon (function), 13

94
INDEX INDEX

odf.draw.Polyline (function), 14 odf.form.Option (function), 26


odf.draw.Rect (function), 14 odf.form.Password (function), 26
odf.draw.RegularPolygon (function), 14 odf.form.Properties (function), 26
odf.draw.StrokeDash (function), 14 odf.form.Property (function), 26
odf.draw.StyleRefElement (function), 12 odf.form.Radio (function), 26
odf.draw.TextBox (function), 14 odf.form.Text (function), 26
odf.easyliststyle (module), 15 odf.form.Textarea (function), 26
odf.easyliststyle.styleFromList (function), odf.form.Time (function), 26
15 odf.form.ValueRange (function), 26
odf.easyliststyle.styleFromString (func- odf.grammar (module), 27
tion), 15 odf.load (module), 28–29
odf.element (module), 16–23 odf.load.LoadParser (class), 28–29
odf.element.CDATASection (class), 20– odf.manifest (module), 30
21 odf.manifest.Algorithm (function), 30
odf.element.Childless (class), 18–19 odf.manifest.EncryptionData (function),
odf.element.Element (class), 21–23 30
odf.element.IllegalChild (class), 16 odf.manifest.FileEntry (function), 30
odf.element.IllegalText (class), 16–17 odf.manifest.KeyDerivation (function),
odf.element.Node (class), 17–18 30
odf.element.Text (class), 19–20 odf.manifest.Manifest (function), 30
odf.elementtypes (module), 24 odf.math (module), 31
odf.form (module), 25–26 odf.math.Math (function), 31
odf.form.Button (function), 25 odf.meta (module), 32
odf.form.Checkbox (function), 25 odf.meta.AutoReload (function), 32
odf.form.Column (function), 25 odf.meta.CreationDate (function), 32
odf.form.Combobox (function), 25 odf.meta.DateString (function), 32
odf.form.ConnectionResource (function), odf.meta.DocumentStatistic (function),
25 32
odf.form.Date (function), 25 odf.meta.EditingCycles (function), 32
odf.form.File (function), 25 odf.meta.EditingDuration (function), 32
odf.form.FixedText (function), 25 odf.meta.Generator (function), 32
odf.form.Form (function), 25 odf.meta.HyperlinkBehaviour (function),
odf.form.FormattedText (function), 25 32
odf.form.Frame (function), 25 odf.meta.InitialCreator (function), 32
odf.form.GenericControl (function), 25 odf.meta.Keyword (function), 32
odf.form.Grid (function), 25 odf.meta.PrintDate (function), 32
odf.form.Hidden (function), 25 odf.meta.PrintedBy (function), 32
odf.form.Image (function), 25 odf.meta.Template (function), 32
odf.form.ImageFrame (function), 25 odf.meta.UserDefined (function), 32
odf.form.Item (function), 25 odf.namespaces (module), 33–34
odf.form.Listbox (function), 26 odf.number (module), 35–36
odf.form.ListProperty (function), 25 odf.number.AmPm (function), 35
odf.form.ListValue (function), 25 odf.number.Boolean (function), 35
odf.form.Number (function), 26 odf.number.BooleanStyle (function), 35

95
INDEX INDEX

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


odf.number.CurrencySymbol (function), 52
35 odf.odfmanifest.ODFManifestHandler (class),
odf.number.DateStyle (function), 35 52–53
odf.number.Day (function), 35 odf.office (module), 54–55
odf.number.DayOfWeek (function), 35 odf.office.Annotation (function), 54
odf.number.EmbeddedText (function), odf.office.AutomaticStyles (function), 54
35 odf.office.BinaryData (function), 54
odf.number.Era (function), 35 odf.office.Body (function), 54
odf.number.Fraction (function), 35 odf.office.ChangeInfo (function), 54
odf.number.Hours (function), 35 odf.office.Chart (function), 54
odf.number.Minutes (function), 35 odf.office.DdeSource (function), 54
odf.number.Month (function), 35 odf.office.Document (function), 54
odf.number.Number (function), 35 odf.office.DocumentContent (function),
odf.number.NumberStyle (function), 35 54
odf.number.PercentageStyle (function), odf.office.DocumentMeta (function), 54
35 odf.office.DocumentSettings (function),
odf.number.Quarter (function), 35 54
odf.number.ScientificNumber (function), odf.office.DocumentStyles (function), 54
35 odf.office.Drawing (function), 54
odf.number.Seconds (function), 36 odf.office.EventListeners (function), 54
odf.number.Text (function), 36 odf.office.FontFaceDecls (function), 54
odf.number.TextContent (function), 36 odf.office.Forms (function), 54
odf.number.TextStyle (function), 36 odf.office.Image (function), 54
odf.number.TimeStyle (function), 36 odf.office.MasterStyles (function), 54
odf.number.WeekOfYear (function), 36 odf.office.Meta (function), 54
odf.number.Year (function), 36 odf.office.Presentation (function), 55
odf.odf2moinmoin (module), 37–40 odf.office.Script (function), 55
odf.odf2moinmoin.ListProperties (class), odf.office.Scripts (function), 55
38 odf.office.Settings (function), 55
odf.odf2moinmoin.ODF2MoinMoin (class), odf.office.Spreadsheet (function), 55
38–40 odf.office.Styles (function), 55
odf.odf2moinmoin.ParagraphProps (class), odf.office.Text (function), 55
37–38 odf.opendocument (module), 56–59
odf.odf2moinmoin.TextProps (class), 37 odf.presentation (module), 60–61
odf.odf2xhtml (module), 41–51 odf.presentation.AnimationGroup (func-
odf.odf2xhtml.ODF2XHTML (class), 43– tion), 60
51 odf.presentation.Animations (function),
odf.odf2xhtml.StyleToCSS (class), 41– 60
43 odf.presentation.DateTime (function), 60
odf.odf2xhtml.TagStack (class), 43 odf.presentation.DateTimeDecl (function),
odf.odfmanifest (module), 52–53 60
odf.odfmanifest.manifestlist (function), odf.presentation.Dim (function), 60
52 odf.presentation.EventListener (function),

96
INDEX INDEX

60 odf.style.HeaderStyle (function), 64
odf.presentation.Footer (function), 60 odf.style.ListLevelProperties (function),
odf.presentation.FooterDecl (function), 64
60 odf.style.Map (function), 64
odf.presentation.Header (function), 60 odf.style.MasterPage (function), 64
odf.presentation.HeaderDecl (function), odf.style.PageLayout (function), 64
60 odf.style.PageLayoutProperties (function),
odf.presentation.HideShape (function), 64
60 odf.style.ParagraphProperties (function),
odf.presentation.HideText (function), 60 64
odf.presentation.Notes (function), 60 odf.style.PresentationPageLayout (func-
odf.presentation.Placeholder (function), tion), 64
60 odf.style.RegionCenter (function), 64
odf.presentation.Play (function), 60 odf.style.RegionLeft (function), 64
odf.presentation.Settings (function), 60 odf.style.RegionRight (function), 64
odf.presentation.Show (function), 60 odf.style.RubyProperties (function), 64
odf.presentation.ShowShape (function), odf.style.SectionProperties (function), 64
60 odf.style.Style (function), 64
odf.presentation.ShowText (function), 60 odf.style.StyleElement (function), 63
odf.presentation.Sound (function), 61 odf.style.TableCellProperties (function),
odf.script (module), 62 64
odf.script.EventListener (function), 62 odf.style.TableColumnProperties (func-
odf.style (module), 63–65 tion), 64
odf.style.BackgroundImage (function), 63 odf.style.TableProperties (function), 64
odf.style.ChartProperties (function), 63 odf.style.TableRowProperties (function),
odf.style.Column (function), 63 64
odf.style.Columns (function), 63 odf.style.TabStop (function), 64
odf.style.ColumnSep (function), 63 odf.style.TabStops (function), 64
odf.style.DefaultStyle (function), 63 odf.style.TextProperties (function), 65
odf.style.DrawingPageProperties (func- odf.svg (module), 66
tion), 63 odf.svg.DefinitionSrc (function), 66
odf.style.DropCap (function), 63 odf.svg.Desc (function), 66
odf.style.FontFace (function), 63 odf.svg.FontFaceFormat (function), 66
odf.style.Footer (function), 63 odf.svg.FontFaceName (function), 66
odf.style.FooterLeft (function), 63 odf.svg.FontFaceSrc (function), 66
odf.style.FooterStyle (function), 63 odf.svg.FontFaceUri (function), 66
odf.style.FootnoteSep (function), 63 odf.svg.Lineargradient (function), 66
odf.style.GraphicProperties (function), odf.svg.Radialgradient (function), 66
63 odf.svg.Stop (function), 66
odf.style.HandoutMaster (function), 63 odf.table (module), 67–71
odf.style.Header (function), 63 odf.table.Body (function), 67
odf.style.HeaderFooterProperties (func- odf.table.CalculationSettings (function),
tion), 63 67
odf.style.HeaderLeft (function), 63 odf.table.CellAddress (function), 67

97
INDEX INDEX

odf.table.CellContentChange (function), 68
67 odf.table.DataPilotTable (function), 68
odf.table.CellContentDeletion (function), odf.table.DataPilotTables (function), 68
67 odf.table.DdeLink (function), 68
odf.table.CellRangeSource (function), 67 odf.table.DdeLinks (function), 68
odf.table.ChangeDeletion (function), 67 odf.table.Deletion (function), 68
odf.table.ChangeTrackTableCell (func- odf.table.Deletions (function), 68
tion), 67 odf.table.Dependencies (function), 68
odf.table.Consolidation (function), 67 odf.table.Dependency (function), 68
odf.table.ContentValidation (function), odf.table.Detective (function), 69
67 odf.table.ErrorMacro (function), 69
odf.table.ContentValidations (function), odf.table.ErrorMessage (function), 69
67 odf.table.EvenColumns (function), 69
odf.table.CoveredTableCell (function), 67 odf.table.EvenRows (function), 69
odf.table.CutOffs (function), 67 odf.table.Filter (function), 69
odf.table.DatabaseRange (function), 68 odf.table.FilterAnd (function), 69
odf.table.DatabaseRanges (function), 68 odf.table.FilterCondition (function), 69
odf.table.DatabaseSourceQuery (function), odf.table.FilterOr (function), 69
68 odf.table.FirstColumn (function), 69
odf.table.DatabaseSourceSql (function), odf.table.FirstRow (function), 69
68 odf.table.HelpMessage (function), 69
odf.table.DatabaseSourceTable (function), odf.table.HighlightedRange (function),
68 69
odf.table.DataPilotDisplayInfo (function), odf.table.Insertion (function), 69
67 odf.table.InsertionCutOff (function), 69
odf.table.DataPilotField (function), 67 odf.table.Iteration (function), 69
odf.table.DataPilotFieldReference (func- odf.table.LabelRange (function), 69
tion), 67 odf.table.LabelRanges (function), 69
odf.table.DataPilotGroup (function), 67 odf.table.LastColumn (function), 69
odf.table.DataPilotGroupMember (func- odf.table.LastRow (function), 69
tion), 67 odf.table.Movement (function), 70
odf.table.DataPilotGroups (function), 67 odf.table.MovementCutOff (function), 70
odf.table.DataPilotLayoutInfo (function), odf.table.NamedExpression (function),
68 70
odf.table.DataPilotLevel (function), 68 odf.table.NamedExpressions (function),
odf.table.DataPilotMember (function), 70
68 odf.table.NamedRange (function), 70
odf.table.DataPilotMembers (function), odf.table.NullDate (function), 70
68 odf.table.OddColumns (function), 70
odf.table.DataPilotSortInfo (function), odf.table.OddRows (function), 70
68 odf.table.Operation (function), 70
odf.table.DataPilotSubtotal (function), odf.table.Previous (function), 70
68 odf.table.Scenario (function), 70
odf.table.DataPilotSubtotals (function), odf.table.Shapes (function), 70

98
INDEX INDEX

odf.table.Sort (function), 70 tion), 74


odf.table.SortBy (function), 70 odf.text.AlphabeticalIndexMarkStart (func-
odf.table.SortGroups (function), 70 tion), 74
odf.table.SourceCellRange (function), 70 odf.text.AlphabeticalIndexSource (func-
odf.table.SourceRangeAddress (function), tion), 74
70 odf.text.AuthorInitials (function), 74
odf.table.SourceService (function), 70 odf.text.AuthorName (function), 74
odf.table.SubtotalField (function), 70 odf.text.Bibliography (function), 74
odf.table.SubtotalRule (function), 70 odf.text.BibliographyConfiguration (func-
odf.table.SubtotalRules (function), 71 tion), 74
odf.table.Table (function), 71 odf.text.BibliographyEntryTemplate (func-
odf.table.TableCell (function), 71 tion), 74
odf.table.TableColumn (function), 71 odf.text.BibliographyMark (function), 74
odf.table.TableColumnGroup (function), odf.text.BibliographySource (function),
71 74
odf.table.TableColumns (function), 71 odf.text.Bookmark (function), 74
odf.table.TableHeaderColumns (function), odf.text.BookmarkEnd (function), 74
71 odf.text.BookmarkRef (function), 74
odf.table.TableHeaderRows (function), odf.text.BookmarkStart (function), 74
71 odf.text.Change (function), 75
odf.table.TableRow (function), 71 odf.text.ChangedRegion (function), 75
odf.table.TableRowGroup (function), 71 odf.text.ChangeEnd (function), 75
odf.table.TableRows (function), 71 odf.text.ChangeStart (function), 75
odf.table.TableSource (function), 71 odf.text.Chapter (function), 75
odf.table.TableTemplate (function), 71 odf.text.CharacterCount (function), 75
odf.table.TargetRangeAddress (function), odf.text.ConditionalText (function), 75
71 odf.text.CreationDate (function), 75
odf.table.TrackedChanges (function), 71 odf.text.CreationTime (function), 75
odf.teletype (module), 72–73 odf.text.Creator (function), 75
odf.teletype.addTextToElement (function), odf.text.DatabaseDisplay (function), 75
72 odf.text.DatabaseName (function), 75
odf.teletype.extractText (function), 72 odf.text.DatabaseNext (function), 75
odf.teletype.WhitespaceText (class), 72– odf.text.DatabaseRowNumber (function),
73 75
odf.text (module), 74–83 odf.text.DatabaseRowSelect (function),
odf.text.A (function), 74 75
odf.text.AlphabeticalIndex (function), 74 odf.text.Date (function), 75
odf.text.AlphabeticalIndexAutoMarkFile odf.text.DdeConnection (function), 75
(function), 74 odf.text.DdeConnectionDecl (function),
odf.text.AlphabeticalIndexEntryTemplate 75
(function), 74 odf.text.DdeConnectionDecls (function),
odf.text.AlphabeticalIndexMark (func- 75
tion), 74 odf.text.Deletion (function), 75
odf.text.AlphabeticalIndexMarkEnd (func- odf.text.Description (function), 76

99
INDEX INDEX

odf.text.EditingCycles (function), 76 odf.text.ListHeader (function), 77


odf.text.EditingDuration (function), 76 odf.text.ListItem (function), 77
odf.text.ExecuteMacro (function), 76 odf.text.ListLevelStyleBullet (function),
odf.text.Expression (function), 76 77
odf.text.FileName (function), 76 odf.text.ListLevelStyleImage (function),
odf.text.FormatChange (function), 76 77
odf.text.H (function), 76 odf.text.ListLevelStyleNumber (function),
odf.text.HiddenParagraph (function), 76 77
odf.text.HiddenText (function), 76 odf.text.ListStyle (function), 77
odf.text.IllustrationIndex (function), 76 odf.text.Measure (function), 78
odf.text.IllustrationIndexEntryTemplate odf.text.ModificationDate (function), 78
(function), 76 odf.text.ModificationTime (function), 78
odf.text.IllustrationIndexSource (func- odf.text.Note (function), 78
tion), 76 odf.text.NoteBody (function), 78
odf.text.ImageCount (function), 76 odf.text.NoteCitation (function), 78
odf.text.IndexBody (function), 76 odf.text.NoteContinuationNoticeBackward
odf.text.IndexEntryBibliography (func- (function), 78
tion), 76 odf.text.NoteContinuationNoticeForward
odf.text.IndexEntryChapter (function), (function), 78
76 odf.text.NoteRef (function), 78
odf.text.IndexEntryLinkEnd (function), odf.text.NotesConfiguration (function),
76 78
odf.text.IndexEntryLinkStart (function), odf.text.Number (function), 78
76 odf.text.NumberedParagraph (function),
odf.text.IndexEntryPageNumber (func- 78
tion), 76 odf.text.ObjectCount (function), 78
odf.text.IndexEntrySpan (function), 77 odf.text.ObjectIndex (function), 78
odf.text.IndexEntryTabStop (function), odf.text.ObjectIndexEntryTemplate (func-
77 tion), 78
odf.text.IndexEntryText (function), 77 odf.text.ObjectIndexSource (function),
odf.text.IndexSourceStyle (function), 77 78
odf.text.IndexSourceStyles (function), 77 odf.text.OutlineLevelStyle (function), 78
odf.text.IndexTitle (function), 77 odf.text.OutlineStyle (function), 78
odf.text.IndexTitleTemplate (function), odf.text.P (function), 78
77 odf.text.Page (function), 78
odf.text.InitialCreator (function), 77 odf.text.PageContinuation (function), 79
odf.text.Insertion (function), 77 odf.text.PageCount (function), 79
odf.text.Keywords (function), 77 odf.text.PageNumber (function), 79
odf.text.LineBreak (function), 77 odf.text.PageSequence (function), 79
odf.text.LinenumberingConfiguration (func- odf.text.PageVariableGet (function), 79
tion), 77 odf.text.PageVariableSet (function), 79
odf.text.LinenumberingSeparator (func- odf.text.ParagraphCount (function), 79
tion), 77 odf.text.Placeholder (function), 79
odf.text.List (function), 77 odf.text.PrintDate (function), 79

100
INDEX INDEX

odf.text.PrintedBy (function), 79 odf.text.TableIndexEntryTemplate (func-


odf.text.PrintTime (function), 79 tion), 81
odf.text.ReferenceMark (function), 79 odf.text.TableIndexSource (function), 81
odf.text.ReferenceMarkEnd (function), odf.text.TableOfContent (function), 81
79 odf.text.TableOfContentEntryTemplate
odf.text.ReferenceMarkStart (function), (function), 81
79 odf.text.TableOfContentSource (function),
odf.text.ReferenceRef (function), 79 81
odf.text.Ruby (function), 79 odf.text.TemplateName (function), 81
odf.text.RubyBase (function), 79 odf.text.TextInput (function), 81
odf.text.RubyText (function), 79 odf.text.Time (function), 81
odf.text.S (function), 79 odf.text.Title (function), 81
odf.text.Script (function), 79 odf.text.TocMark (function), 81
odf.text.Section (function), 80 odf.text.TocMarkEnd (function), 81
odf.text.SectionSource (function), 80 odf.text.TocMarkStart (function), 82
odf.text.SenderCity (function), 80 odf.text.TrackedChanges (function), 82
odf.text.SenderCompany (function), 80 odf.text.UserDefined (function), 82
odf.text.SenderCountry (function), 80 odf.text.UserFieldDecl (function), 82
odf.text.SenderEmail (function), 80 odf.text.UserFieldDecls (function), 82
odf.text.SenderFax (function), 80 odf.text.UserFieldGet (function), 82
odf.text.SenderFirstname (function), 80 odf.text.UserFieldInput (function), 82
odf.text.SenderInitials (function), 80 odf.text.UserIndex (function), 82
odf.text.SenderLastname (function), 80 odf.text.UserIndexEntryTemplate (func-
odf.text.SenderPhonePrivate (function), tion), 82
80 odf.text.UserIndexMark (function), 82
odf.text.SenderPhoneWork (function), 80 odf.text.UserIndexMarkEnd (function),
odf.text.SenderPosition (function), 80 82
odf.text.SenderPostalCode (function), 80 odf.text.UserIndexMarkStart (function),
odf.text.SenderStateOrProvince (func- 82
tion), 80 odf.text.UserIndexSource (function), 82
odf.text.SenderStreet (function), 80 odf.text.VariableDecl (function), 82
odf.text.SenderTitle (function), 80 odf.text.VariableDecls (function), 82
odf.text.Sequence (function), 80 odf.text.VariableGet (function), 82
odf.text.SequenceDecl (function), 80 odf.text.VariableInput (function), 82
odf.text.SequenceDecls (function), 80 odf.text.VariableSet (function), 82
odf.text.SequenceRef (function), 81 odf.text.WordCount (function), 82
odf.text.SheetName (function), 81 odf.thumbnail (module), 84
odf.text.SortKey (function), 81 odf.thumbnail.thumbnail (function), 84
odf.text.Span (function), 81 odf.userfield (module), 85–88
odf.text.Subject (function), 81 odf.userfield.ODFContentParser (class),
odf.text.Tab (function), 81 87–88
odf.text.TableCount (function), 81 odf.userfield.UserFields (class), 85–87
odf.text.TableFormula (function), 81 odf.userfield.writeattr (function), 85
odf.text.TableIndex (function), 81 odf.userfield.writetext (function), 85

101
INDEX INDEX

odf.xforms (module), 89 (method), 57


odf.xforms.Bind (function), 89 odf.opendocument.OpenDocument.rebuild caches
odf.xforms.Instance (function), 89 (method), 57
odf.xforms.Model (function), 89 odf.opendocument.OpenDocument.save (method),
odf.opendocument.load (function), 56 58
odf.opendocument.OpaqueObject (class), 56– odf.opendocument.OpenDocument.settingsxml
57 (method), 57
odf.opendocument.OpaqueObject. init (method),
odf.opendocument.OpenDocument.stylesxml
57 (method), 58
odf.opendocument.OpenDocument (class), 57– odf.opendocument.OpenDocument.toXml
59 (method), 57
odf.opendocument.OpenDocument. init odf.opendocument.OpenDocument.write (method),
(method), 57 58
odf.opendocument.OpenDocument.addObject odf.opendocument.OpenDocument.xml (method),
(method), 58 57
odf.opendocument.OpenDocument.addPicture
odf.opendocument.OpenDocumentChart (func-
(method), 58 tion), 56
odf.opendocument.OpenDocument.addPictureFromFile
odf.opendocument.OpenDocumentDrawing (func-
(method), 58 tion), 56
odf.opendocument.OpenDocument.addPictureFromString
odf.opendocument.OpenDocumentImage (func-
(method), 58 tion), 56
odf.opendocument.OpenDocument.addThumbnail
odf.opendocument.OpenDocumentPresentation
(method), 58 (function), 56
odf.opendocument.OpenDocument.build caches
odf.opendocument.OpenDocumentSpreadsheet
(method), 57 (function), 56
odf.opendocument.OpenDocument.clear caches
odf.opendocument.OpenDocumentText (func-
(method), 57 tion), 56
odf.opendocument.OpenDocument.contentxml
(method), 57
odf.opendocument.OpenDocument.createCDATASection
(method), 59
odf.opendocument.OpenDocument.createElement
(method), 58
odf.opendocument.OpenDocument.createTextNode
(method), 58
odf.opendocument.OpenDocument.getElementsByType
(method), 59
odf.opendocument.OpenDocument.getMediaType
(method), 59
odf.opendocument.OpenDocument.getStyleByName
(method), 59
odf.opendocument.OpenDocument.manifestxml
(method), 57
odf.opendocument.OpenDocument.metaxml

102

Potrebbero piacerti anche