1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>ODFPY: odf/userfield.py Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ODFPY
 <span id="projectnumber">1.2.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('userfield_8py_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">userfield.py</div> </div>
</div><!--header-->
<div class="contents">
<a href="userfield_8py.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="namespaceodf_1_1userfield.html"> 1</a></span> <span class="comment">#!/usr/bin/python</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"># -*- coding: utf-8 -*-</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"># Copyright (C) 2006-2009 Søren Roug, European Environment Agency</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">#</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"># This is free software. You may redistribute it under the terms</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"># of the Apache license and the GNU General Public License Version</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"># 2 or at your option any later version.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">#</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"># This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"># GNU General Public License for more details.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">#</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"># You should have received a copy of the GNU General Public</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"># License along with this program; if not, write to the Free Software</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"># Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">#</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"># Contributor(s): Michael Howitz, gocept gmbh & co. kg</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">#</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"># $Id: userfield.py 447 2008-07-10 20:01:30Z roug $</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">##</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"># Class to show and manipulate user fields in odf documents.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">import</span> sys</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">import</span> zipfile</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">from</span> <a class="code" href="namespaceodf_1_1text.html">odf.text</a> <span class="keyword">import</span> UserFieldDecl</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">from</span> <a class="code" href="namespaceodf_1_1namespaces.html">odf.namespaces</a> <span class="keyword">import</span> OFFICENS</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">from</span> <a class="code" href="namespaceodf_1_1opendocument.html">odf.opendocument</a> <span class="keyword">import</span> load</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">import</span> io, sys</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">if</span> sys.version_info.major==3:</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespaceodf_1_1userfield.html#acbf030274e249b947b246cb243e604a3"> 34</a></span>  unicode=str</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespaceodf_1_1userfield.html#ac0d2b936dc2daec018705cd7f643a475"> 36</a></span> OUTENCODING = <span class="stringliteral">"utf-8"</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"># OpenDocument v.1.0 section 6.7.1</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespaceodf_1_1userfield.html#a9a19426c5bf0ad246a4652644ae83885"> 40</a></span> VALUE_TYPES = {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="stringliteral">u'float'</span>: (OFFICENS, <span class="stringliteral">u'value'</span>),</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="stringliteral">u'percentage'</span>: (OFFICENS, <span class="stringliteral">u'value'</span>),</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="stringliteral">u'currency'</span>: (OFFICENS, <span class="stringliteral">u'value'</span>),</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="stringliteral">u'date'</span>: (OFFICENS, <span class="stringliteral">u'date-value'</span>),</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="stringliteral">u'time'</span>: (OFFICENS, <span class="stringliteral">u'time-value'</span>),</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="stringliteral">u'boolean'</span>: (OFFICENS, <span class="stringliteral">u'boolean-value'</span>),</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="stringliteral">u'string'</span>: (OFFICENS, <span class="stringliteral">u'string-value'</span>),</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  }</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">##</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"># List, view and manipulate user fields.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html"> 53</a></span> <span class="keyword">class </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html">UserFields</a>(<a class="code" href="classobject.html">object</a>):</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment"># these attributes can be a filename or a file like object</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9"> 56</a></span>  src_file = <span class="keywordtype">None</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#a4ff1ceee3cb418e2b72d6c0366fb63b3"> 57</a></span>  dest_file = <span class="keywordtype">None</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">##</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment"># Constructor</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment"># @param src open file in binary mode: source document,</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment"># or filename as a unicode string, or None for stdin.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment"># @param dest opendile in binary mode: destination document,</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment"># or filename as a unicode string, or None for stdout.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#a5181a6106854423e1e28a83455aa9e94"> 67</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#a5181a6106854423e1e28a83455aa9e94">__init__</a>(self, src=None, dest=None):</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  assert(src==<span class="keywordtype">None</span> <span class="keywordflow">or</span> <span class="stringliteral">'rb'</span> <span class="keywordflow">in</span> repr(src) <span class="keywordflow">or</span> <span class="stringliteral">'BufferedReader'</span> <span class="keywordflow">in</span> repr(src) <span class="keywordflow">or</span> <span class="stringliteral">'BytesIO'</span> <span class="keywordflow">in</span> repr(src) <span class="keywordflow">or</span> type(src)==type(<span class="stringliteral">u""</span>))</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  assert(dest==<span class="keywordtype">None</span> <span class="keywordflow">or</span> <span class="stringliteral">'wb'</span> <span class="keywordflow">in</span> repr(dest) <span class="keywordflow">or</span> <span class="stringliteral">'BufferedWriter'</span> <span class="keywordflow">in</span> repr(dest) <span class="keywordflow">or</span> <span class="stringliteral">'BytesIO'</span> <span class="keywordflow">in</span> repr(dest) <span class="keywordflow">or</span> type(dest)==type(<span class="stringliteral">u""</span>))</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a> = src</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#a4ff1ceee3cb418e2b72d6c0366fb63b3">dest_file</a> = dest</div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#adfbbf12e8d9c5377410d463070b5bd76"> 72</a></span>  self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#adfbbf12e8d9c5377410d463070b5bd76">document</a> = <span class="keywordtype">None</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#a65ccd99e2c198f06b55551d6a7bbf59a"> 74</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#a65ccd99e2c198f06b55551d6a7bbf59a">loaddoc</a>(self):</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span> (sys.version_info.major==3 <span class="keywordflow">and</span> (isinstance(self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a>, str) <span class="keywordflow">or</span> (isinstance(self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a>, io.IOBase)))) <span class="keywordflow">or</span> (sys.version_info.major==2 <span class="keywordflow">and</span> isinstance(self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a>, basestring)):</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment"># src_file is a filename, check if it is a zip-file</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">if</span> <span class="keywordflow">not</span> zipfile.is_zipfile(self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a>):</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">raise</span> TypeError(<span class="stringliteral">u"%s is no odt file."</span> % self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a>)</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">elif</span> self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a> <span class="keywordflow">is</span> <span class="keywordtype">None</span>:</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment"># use stdin if no file given</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a> = sys.stdin</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#adfbbf12e8d9c5377410d463070b5bd76">document</a> = <a class="code" href="namespaceodf_1_1opendocument.html#a5f91a599e953a7b3d3cd07ad3a696467">load</a>(self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">src_file</a>)</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#ae5336dcb2cdaee62f02d16cdb8945a2f"> 85</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#ae5336dcb2cdaee62f02d16cdb8945a2f">savedoc</a>(self):</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment"># write output</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">if</span> self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#a4ff1ceee3cb418e2b72d6c0366fb63b3">dest_file</a> <span class="keywordflow">is</span> <span class="keywordtype">None</span>:</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment"># use stdout if no filename given</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  self.document.save(<span class="stringliteral">u'-'</span>)</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">else</span>:</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  self.document.save(self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#a4ff1ceee3cb418e2b72d6c0366fb63b3">dest_file</a>)</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">##</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment"># List (extract) all known user-fields.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment"># @return list of user-field names as unicode strings.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#a9151edeae09fcea4b334a445d7efc6b0"> 98</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#a9151edeae09fcea4b334a445d7efc6b0">list_fields</a>(self):</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">return</span> [x[0] <span class="keywordflow">for</span> x <span class="keywordflow">in</span> self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#ae67ac78a3c883117d523f245f076b227">list_fields_and_values</a>()]</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">##</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment"># List (extract) user-fields with type and value.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="comment"># @param field_names list of field names as unicode strings</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment"># to show, or None for all.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment"># @return list of tuples (<field name>, <field type>, <value>)</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment"># as type (unicode string, stringified type, unicode string).</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#ae67ac78a3c883117d523f245f076b227"> 111</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#ae67ac78a3c883117d523f245f076b227">list_fields_and_values</a>(self, field_names=None):</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#a65ccd99e2c198f06b55551d6a7bbf59a">loaddoc</a>()</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  found_fields = []</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  all_fields = self.document.getElementsByType(UserFieldDecl)</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">for</span> f <span class="keywordflow">in</span> all_fields:</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  value_type = f.getAttribute(<span class="stringliteral">u'valuetype'</span>)</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">if</span> value_type == <span class="stringliteral">u'string'</span>:</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  value = f.getAttribute(<span class="stringliteral">u'stringvalue'</span>)</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">else</span>:</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  value = f.getAttribute(<span class="stringliteral">u'value'</span>)</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  field_name = f.getAttribute(<span class="stringliteral">u'name'</span>)</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordflow">if</span> field_names <span class="keywordflow">is</span> <span class="keywordtype">None</span> <span class="keywordflow">or</span> field_name <span class="keywordflow">in</span> field_names:</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  found_fields.append((field_name,</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  value_type,</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  value))</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordflow">return</span> found_fields</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="comment">##</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment"># Extract the contents of given field names from the file.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment"># @param field_names list of field names as unicode strings</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="comment"># @return list of field values as unicode strings.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#a1ca142bc38126c2d15a9a40e94c9d21c"> 137</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#a1ca142bc38126c2d15a9a40e94c9d21c">list_values</a>(self, field_names):</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordflow">return</span> [x[2] <span class="keywordflow">for</span> x <span class="keywordflow">in</span> self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#ae67ac78a3c883117d523f245f076b227">list_fields_and_values</a>(field_names)]</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="comment">##</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment"># Extract the contents of this field from the file.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="comment"># @param field_name unicode string: name of a field</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment"># @return field value as a unicode string or None if field does not exist.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#a916cc9d873f57f30b69e752bb48d5bff"> 146</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#a916cc9d873f57f30b69e752bb48d5bff">get</a>(self, field_name):</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  assert(type(field_name)==type(<span class="stringliteral">u""</span>))</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  values = self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#a1ca142bc38126c2d15a9a40e94c9d21c">list_values</a>([field_name])</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordflow">if</span> <span class="keywordflow">not</span> values:</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">return</span> <span class="keywordtype">None</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordflow">return</span> values[0]</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="comment">##</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="comment"># Extract the type and contents of this field from the file.</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="comment"># @param field_name unicode string: name of a field</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment"># @return tuple (<type>, <field-value>) as a pair of unicode strings</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="comment"># or None if field does not exist.</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#a532884dffd16a0a946aa961ea442d3ca"> 160</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#a532884dffd16a0a946aa961ea442d3ca">get_type_and_value</a>(self, field_name):</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  assert(type(field_name)==type(<span class="stringliteral">u""</span>))</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  fields = self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#ae67ac78a3c883117d523f245f076b227">list_fields_and_values</a>([field_name])</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordflow">if</span> <span class="keywordflow">not</span> fields:</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordflow">return</span> <span class="keywordtype">None</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  field_name, value_type, value = fields[0]</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">return</span> value_type, value</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="comment">##</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="comment"># Set the value of user fields. The field types will be the same.</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="comment"># data ... dict, with field name as key, field value as value</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment"># Returns None</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="comment"># </span></div>
<div class="line"><a name="l00176"></a><span class="lineno"><a class="line" href="classodf_1_1userfield_1_1UserFields.html#aa13e8293efd5d183ac771d07b56a4558"> 176</a></span>  <span class="keyword">def </span><a class="code" href="classodf_1_1userfield_1_1UserFields.html#aa13e8293efd5d183ac771d07b56a4558">update</a>(self, data):</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#a65ccd99e2c198f06b55551d6a7bbf59a">loaddoc</a>()</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  all_fields = self.document.getElementsByType(UserFieldDecl)</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordflow">for</span> f <span class="keywordflow">in</span> all_fields:</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  field_name = f.getAttribute(<span class="stringliteral">u'name'</span>)</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordflow">if</span> field_name <span class="keywordflow">in</span> data:</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  value_type = f.getAttribute(<span class="stringliteral">u'valuetype'</span>)</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  value = data.get(field_name)</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordflow">if</span> value_type == <span class="stringliteral">u'string'</span>:</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  f.setAttribute(<span class="stringliteral">u'stringvalue'</span>, value)</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordflow">else</span>:</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  f.setAttribute(<span class="stringliteral">u'value'</span>, value)</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  self.<a class="code" href="classodf_1_1userfield_1_1UserFields.html#ae5336dcb2cdaee62f02d16cdb8945a2f">savedoc</a>()</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_aab129a38d3cc36d3ca8469de9a04c5a9"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#aab129a38d3cc36d3ca8469de9a04c5a9">odf.userfield.UserFields.src_file</a></div><div class="ttdeci">src_file</div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00056">userfield.py:56</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_ae5336dcb2cdaee62f02d16cdb8945a2f"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#ae5336dcb2cdaee62f02d16cdb8945a2f">odf.userfield.UserFields.savedoc</a></div><div class="ttdeci">def savedoc</div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00085">userfield.py:85</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_aa13e8293efd5d183ac771d07b56a4558"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#aa13e8293efd5d183ac771d07b56a4558">odf.userfield.UserFields.update</a></div><div class="ttdeci">def update</div><div class="ttdoc">Set the value of user fields. </div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00176">userfield.py:176</a></div></div>
<div class="ttc" id="namespaceodf_1_1opendocument_html"><div class="ttname"><a href="namespaceodf_1_1opendocument.html">odf.opendocument</a></div><div class="ttdef"><b>Definition:</b> <a href="opendocument_8py_source.html#l00001">opendocument.py:1</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html">odf.userfield.UserFields</a></div><div class="ttdoc">List, view and manipulate user fields. </div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00053">userfield.py:53</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_a9151edeae09fcea4b334a445d7efc6b0"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#a9151edeae09fcea4b334a445d7efc6b0">odf.userfield.UserFields.list_fields</a></div><div class="ttdeci">def list_fields</div><div class="ttdoc">List (extract) all known user-fields. </div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00098">userfield.py:98</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_a916cc9d873f57f30b69e752bb48d5bff"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#a916cc9d873f57f30b69e752bb48d5bff">odf.userfield.UserFields.get</a></div><div class="ttdeci">def get</div><div class="ttdoc">Extract the contents of this field from the file. </div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00146">userfield.py:146</a></div></div>
<div class="ttc" id="namespaceodf_1_1opendocument_html_a5f91a599e953a7b3d3cd07ad3a696467"><div class="ttname"><a href="namespaceodf_1_1opendocument.html#a5f91a599e953a7b3d3cd07ad3a696467">odf.opendocument.load</a></div><div class="ttdeci">def load</div><div class="ttdoc">Load an ODF file into memory. </div><div class="ttdef"><b>Definition:</b> <a href="opendocument_8py_source.html#l01003">opendocument.py:1003</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_a4ff1ceee3cb418e2b72d6c0366fb63b3"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#a4ff1ceee3cb418e2b72d6c0366fb63b3">odf.userfield.UserFields.dest_file</a></div><div class="ttdeci">dest_file</div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00057">userfield.py:57</a></div></div>
<div class="ttc" id="classobject_html"><div class="ttname"><a href="classobject.html">object</a></div></div>
<div class="ttc" id="namespaceodf_1_1text_html"><div class="ttname"><a href="namespaceodf_1_1text.html">odf.text</a></div><div class="ttdef"><b>Definition:</b> <a href="text_8py_source.html#l00001">text.py:1</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_a1ca142bc38126c2d15a9a40e94c9d21c"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#a1ca142bc38126c2d15a9a40e94c9d21c">odf.userfield.UserFields.list_values</a></div><div class="ttdeci">def list_values</div><div class="ttdoc">Extract the contents of given field names from the file. </div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00137">userfield.py:137</a></div></div>
<div class="ttc" id="namespaceodf_1_1namespaces_html"><div class="ttname"><a href="namespaceodf_1_1namespaces.html">odf.namespaces</a></div><div class="ttdef"><b>Definition:</b> <a href="namespaces_8py_source.html#l00001">namespaces.py:1</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_adfbbf12e8d9c5377410d463070b5bd76"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#adfbbf12e8d9c5377410d463070b5bd76">odf.userfield.UserFields.document</a></div><div class="ttdeci">document</div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00072">userfield.py:72</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_a532884dffd16a0a946aa961ea442d3ca"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#a532884dffd16a0a946aa961ea442d3ca">odf.userfield.UserFields.get_type_and_value</a></div><div class="ttdeci">def get_type_and_value</div><div class="ttdoc">Extract the type and contents of this field from the file. </div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00160">userfield.py:160</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_a65ccd99e2c198f06b55551d6a7bbf59a"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#a65ccd99e2c198f06b55551d6a7bbf59a">odf.userfield.UserFields.loaddoc</a></div><div class="ttdeci">def loaddoc</div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00074">userfield.py:74</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_a5181a6106854423e1e28a83455aa9e94"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#a5181a6106854423e1e28a83455aa9e94">odf.userfield.UserFields.__init__</a></div><div class="ttdeci">def __init__</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00067">userfield.py:67</a></div></div>
<div class="ttc" id="classodf_1_1userfield_1_1UserFields_html_ae67ac78a3c883117d523f245f076b227"><div class="ttname"><a href="classodf_1_1userfield_1_1UserFields.html#ae67ac78a3c883117d523f245f076b227">odf.userfield.UserFields.list_fields_and_values</a></div><div class="ttdeci">def list_fields_and_values</div><div class="ttdoc">List (extract) user-fields with type and value. </div><div class="ttdef"><b>Definition:</b> <a href="userfield_8py_source.html#l00111">userfield.py:111</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d3e4a566b869afb68c42af9b8e3a2d5a.html">odf</a></li><li class="navelem"><a class="el" href="userfield_8py.html">userfield.py</a></li>
<li class="footer">Generated on Tue Oct 28 2014 13:47:24 for ODFPY by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
</ul>
</div>
</body>
</html>
|
