← Back to branch summary

~ubuntu-branches/ubuntu/trusty/python-babel/trusty

« back to all changes in this revision

Viewing changes to doc/api/babel.messages.catalog.Message-class.html

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2013-10-28 10:11:31 UTC
  • mfrom: (4.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131028101131-zwbmm8sc29iemmlr
Tags: 1.3-2ubuntu1
* Merge from Debian unstable.  Remaining changes:
  - debian/rules: Run the testsuite during builds.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/babel.messages.catalog.Message-class.html
1
 
<?xml version="1.0" encoding="ascii"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
 
          "DTD/xhtml1-transitional.dtd">
4
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<head>
6
 
  <title>babel.messages.catalog.Message</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8
 
  <script type="text/javascript" src="epydoc.js"></script>
9
 
</head>
10
 
 
11
 
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
 
      alink="#204080">
13
 
<!-- ==================== NAVIGATION BAR ==================== -->
14
 
<table class="navbar" border="0" width="100%" cellpadding="0"
15
 
       bgcolor="#a0c0ff" cellspacing="0">
16
 
  <tr valign="middle">
17
 
  <!-- Home link -->
18
 
      <th>&nbsp;&nbsp;&nbsp;<a
19
 
        href="babel-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
 
 
21
 
  <!-- Tree link -->
22
 
      <th>&nbsp;&nbsp;&nbsp;<a
23
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
 
 
25
 
  <!-- Index link -->
26
 
      <th>&nbsp;&nbsp;&nbsp;<a
27
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
 
 
29
 
  <!-- Help link -->
30
 
      <th>&nbsp;&nbsp;&nbsp;<a
31
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
 
 
33
 
  <!-- Project homepage -->
34
 
      <th class="navbar" align="right" width="100%">
35
 
        <table border="0" cellpadding="0" cellspacing="0">
36
 
          <tr><th class="navbar" align="center"
37
 
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
38
 
          </tr></table></th>
39
 
  </tr>
40
 
</table>
41
 
<table width="100%" cellpadding="0" cellspacing="0">
42
 
  <tr valign="top">
43
 
    <td width="100%">
44
 
      <span class="breadcrumbs">
45
 
        <a href="babel-module.html">Package&nbsp;babel</a> ::
46
 
        <a href="babel.messages-module.html">Package&nbsp;messages</a> ::
47
 
        <a href="babel.messages.catalog-module.html">Module&nbsp;catalog</a> ::
48
 
        Class&nbsp;Message
49
 
      </span>
50
 
    </td>
51
 
    <td>
52
 
      <table cellpadding="0" cellspacing="0">
53
 
        <!-- hide/show private -->
54
 
      </table>
55
 
    </td>
56
 
  </tr>
57
 
</table>
58
 
<!-- ==================== CLASS DESCRIPTION ==================== -->
59
 
<h1 class="epydoc">Class Message</h1><p class="nomargin-top"></p>
60
 
<pre class="base-tree">
61
 
object --+
62
 
         |
63
 
        <strong class="uidshort">Message</strong>
64
 
</pre>
65
 
 
66
 
<hr />
67
 
Representation of a single message in a catalog.
68
 
 
69
 
<!-- ==================== INSTANCE METHODS ==================== -->
70
 
<a name="section-InstanceMethods"></a>
71
 
<table class="summary" border="1" cellpadding="3"
72
 
       cellspacing="0" width="100%" bgcolor="white">
73
 
<tr bgcolor="#70b0f0" class="table-header">
74
 
  <td align="left" colspan="2" class="table-header">
75
 
    <span class="table-header">Instance Methods</span></td>
76
 
</tr>
77
 
<tr>
78
 
    <td width="15%" align="right" valign="top" class="summary">
79
 
      <span class="summary-type">&nbsp;</span>
80
 
    </td><td class="summary">
81
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
82
 
        <tr>
83
 
          <td><span class="summary-sig"><a href="babel.messages.catalog.Message-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
84
 
        <span class="summary-sig-arg">id</span>,
85
 
        <span class="summary-sig-arg">string</span>=<span class="summary-sig-default"><code class="variable-quote">u'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
86
 
        <span class="summary-sig-arg">locations</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
87
 
        <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
88
 
        <span class="summary-sig-arg">auto_comments</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
89
 
        <span class="summary-sig-arg">user_comments</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
90
 
        <span class="summary-sig-arg">previous_id</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
91
 
        <span class="summary-sig-arg">lineno</span>=<span class="summary-sig-default">None</span>)</span><br />
92
 
      Create the message object.</td>
93
 
          <td align="right" valign="top">
94
 
            
95
 
            
96
 
          </td>
97
 
        </tr>
98
 
      </table>
99
 
      
100
 
    </td>
101
 
  </tr>
102
 
<tr>
103
 
    <td width="15%" align="right" valign="top" class="summary">
104
 
      <span class="summary-type">&nbsp;</span>
105
 
    </td><td class="summary">
106
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
107
 
        <tr>
108
 
          <td><span class="summary-sig"><a href="babel.messages.catalog.Message-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
109
 
      repr(x)</td>
110
 
          <td align="right" valign="top">
111
 
            
112
 
            
113
 
          </td>
114
 
        </tr>
115
 
      </table>
116
 
      
117
 
    </td>
118
 
  </tr>
119
 
<tr>
120
 
    <td width="15%" align="right" valign="top" class="summary">
121
 
      <span class="summary-type">&nbsp;</span>
122
 
    </td><td class="summary">
123
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
124
 
        <tr>
125
 
          <td><span class="summary-sig"><a name="__cmp__"></a><span class="summary-sig-name">__cmp__</span>(<span class="summary-sig-arg">self</span>,
126
 
        <span class="summary-sig-arg">obj</span>)</span><br />
127
 
      Compare Messages, taking into account plural ids</td>
128
 
          <td align="right" valign="top">
129
 
            
130
 
            
131
 
          </td>
132
 
        </tr>
133
 
      </table>
134
 
      
135
 
    </td>
136
 
  </tr>
137
 
<tr>
138
 
    <td width="15%" align="right" valign="top" class="summary">
139
 
      <span class="summary-type">&nbsp;</span>
140
 
    </td><td class="summary">
141
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
142
 
        <tr>
143
 
          <td><span class="summary-sig"><a name="clone"></a><span class="summary-sig-name">clone</span>(<span class="summary-sig-arg">self</span>)</span></td>
144
 
          <td align="right" valign="top">
145
 
            
146
 
            
147
 
          </td>
148
 
        </tr>
149
 
      </table>
150
 
      
151
 
    </td>
152
 
  </tr>
153
 
<tr>
154
 
    <td width="15%" align="right" valign="top" class="summary">
155
 
      <span class="summary-type"><tt class="rst-docutils literal">iterator</tt></span>
156
 
    </td><td class="summary">
157
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
158
 
        <tr>
159
 
          <td><span class="summary-sig"><a href="babel.messages.catalog.Message-class.html#check" class="summary-sig-name">check</a>(<span class="summary-sig-arg">self</span>,
160
 
        <span class="summary-sig-arg">catalog</span>=<span class="summary-sig-default">None</span>)</span><br />
161
 
      Run various validation checks on the message.</td>
162
 
          <td align="right" valign="top">
163
 
            
164
 
            
165
 
          </td>
166
 
        </tr>
167
 
      </table>
168
 
      
169
 
    </td>
170
 
  </tr>
171
 
  <tr>
172
 
    <td colspan="2" class="summary">
173
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
174
 
      <code>__delattr__</code>,
175
 
      <code>__format__</code>,
176
 
      <code>__getattribute__</code>,
177
 
      <code>__hash__</code>,
178
 
      <code>__new__</code>,
179
 
      <code>__reduce__</code>,
180
 
      <code>__reduce_ex__</code>,
181
 
      <code>__setattr__</code>,
182
 
      <code>__sizeof__</code>,
183
 
      <code>__str__</code>,
184
 
      <code>__subclasshook__</code>
185
 
      </p>
186
 
    </td>
187
 
  </tr>
188
 
</table>
189
 
<!-- ==================== INSTANCE VARIABLES ==================== -->
190
 
<a name="section-InstanceVariables"></a>
191
 
<table class="summary" border="1" cellpadding="3"
192
 
       cellspacing="0" width="100%" bgcolor="white">
193
 
<tr bgcolor="#70b0f0" class="table-header">
194
 
  <td align="left" colspan="2" class="table-header">
195
 
    <span class="table-header">Instance Variables</span></td>
196
 
</tr>
197
 
<tr>
198
 
    <td width="15%" align="right" valign="top" class="summary">
199
 
      <span class="summary-type">&nbsp;</span>
200
 
    </td><td class="summary">
201
 
        <a name="id"></a><span class="summary-name">id</span><br />
202
 
      The message ID
203
 
    </td>
204
 
  </tr>
205
 
<tr>
206
 
    <td width="15%" align="right" valign="top" class="summary">
207
 
      <span class="summary-type">&nbsp;</span>
208
 
    </td><td class="summary">
209
 
        <a name="string"></a><span class="summary-name">string</span><br />
210
 
      The message translation
211
 
    </td>
212
 
  </tr>
213
 
</table>
214
 
<!-- ==================== PROPERTIES ==================== -->
215
 
<a name="section-Properties"></a>
216
 
<table class="summary" border="1" cellpadding="3"
217
 
       cellspacing="0" width="100%" bgcolor="white">
218
 
<tr bgcolor="#70b0f0" class="table-header">
219
 
  <td align="left" colspan="2" class="table-header">
220
 
    <span class="table-header">Properties</span></td>
221
 
</tr>
222
 
<tr>
223
 
    <td width="15%" align="right" valign="top" class="summary">
224
 
      <span class="summary-type"><code class="link">bool</code></span>
225
 
    </td><td class="summary">
226
 
        <a href="babel.messages.catalog.Message-class.html#fuzzy" class="summary-name">fuzzy</a><br />
227
 
      Whether the translation is fuzzy.
228
 
    </td>
229
 
  </tr>
230
 
<tr>
231
 
    <td width="15%" align="right" valign="top" class="summary">
232
 
      <span class="summary-type"><code class="link">bool</code></span>
233
 
    </td><td class="summary">
234
 
        <a href="babel.messages.catalog.Message-class.html#pluralizable" class="summary-name">pluralizable</a><br />
235
 
      Whether the message is plurizable.
236
 
    </td>
237
 
  </tr>
238
 
<tr>
239
 
    <td width="15%" align="right" valign="top" class="summary">
240
 
      <span class="summary-type"><code class="link">bool</code></span>
241
 
    </td><td class="summary">
242
 
        <a href="babel.messages.catalog.Message-class.html#python_format" class="summary-name">python_format</a><br />
243
 
      Whether the message contains Python-style parameters.
244
 
    </td>
245
 
  </tr>
246
 
  <tr>
247
 
    <td colspan="2" class="summary">
248
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
249
 
      <code>__class__</code>
250
 
      </p>
251
 
    </td>
252
 
  </tr>
253
 
</table>
254
 
<!-- ==================== METHOD DETAILS ==================== -->
255
 
<a name="section-MethodDetails"></a>
256
 
<table class="details" border="1" cellpadding="3"
257
 
       cellspacing="0" width="100%" bgcolor="white">
258
 
<tr bgcolor="#70b0f0" class="table-header">
259
 
  <td align="left" colspan="2" class="table-header">
260
 
    <span class="table-header">Method Details</span></td>
261
 
</tr>
262
 
</table>
263
 
<a name="__init__"></a>
264
 
<div>
265
 
<table class="details" border="1" cellpadding="3"
266
 
       cellspacing="0" width="100%" bgcolor="white">
267
 
<tr><td>
268
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
269
 
  <tr valign="top"><td>
270
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
271
 
        <span class="sig-arg">id</span>,
272
 
        <span class="sig-arg">string</span>=<span class="sig-default"><code class="variable-quote">u'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
273
 
        <span class="sig-arg">locations</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
274
 
        <span class="sig-arg">flags</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
275
 
        <span class="sig-arg">auto_comments</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
276
 
        <span class="sig-arg">user_comments</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
277
 
        <span class="sig-arg">previous_id</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
278
 
        <span class="sig-arg">lineno</span>=<span class="sig-default">None</span>)</span>
279
 
    <br /><em class="fname">(Constructor)</em>
280
 
  </h3>
281
 
  </td><td align="right" valign="top"
282
 
    >&nbsp;
283
 
    </td>
284
 
  </tr></table>
285
 
  
286
 
  Create the message object.
287
 
  <dl class="fields">
288
 
    <dt>Parameters:</dt>
289
 
    <dd><ul class="nomargin-top">
290
 
        <li><strong class="pname"><code>id</code></strong> - the message ID, or a <tt class="rst-docutils literal">(singular, plural)</tt> tuple for
291
 
pluralizable messages</li>
292
 
        <li><strong class="pname"><code>string</code></strong> - the translated message string, or a
293
 
<tt class="rst-docutils literal">(singular, plural)</tt> tuple for pluralizable messages</li>
294
 
        <li><strong class="pname"><code>locations</code></strong> - a sequence of <tt class="rst-docutils literal">(filenname, lineno)</tt> tuples</li>
295
 
        <li><strong class="pname"><code>flags</code></strong> - a set or sequence of flags</li>
296
 
        <li><strong class="pname"><code>auto_comments</code></strong> - a sequence of automatic comments for the message</li>
297
 
        <li><strong class="pname"><code>user_comments</code></strong> - a sequence of user comments for the message</li>
298
 
        <li><strong class="pname"><code>previous_id</code></strong> - the previous message ID, or a <tt class="rst-docutils literal">(singular, plural)</tt>
299
 
tuple for pluralizable messages</li>
300
 
        <li><strong class="pname"><code>lineno</code></strong> - the line number on which the msgid line was found in the
301
 
PO file, if any</li>
302
 
    </ul></dd>
303
 
    <dt>Overrides:
304
 
        object.__init__
305
 
    </dt>
306
 
  </dl>
307
 
</td></tr></table>
308
 
</div>
309
 
<a name="__repr__"></a>
310
 
<div>
311
 
<table class="details" border="1" cellpadding="3"
312
 
       cellspacing="0" width="100%" bgcolor="white">
313
 
<tr><td>
314
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
315
 
  <tr valign="top"><td>
316
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
317
 
    <br /><em class="fname">(Representation operator)</em>
318
 
  </h3>
319
 
  </td><td align="right" valign="top"
320
 
    >&nbsp;
321
 
    </td>
322
 
  </tr></table>
323
 
  
324
 
  repr(x)
325
 
  <dl class="fields">
326
 
    <dt>Overrides:
327
 
        object.__repr__
328
 
        <dd><em class="note">(inherited documentation)</em></dd>
329
 
    </dt>
330
 
  </dl>
331
 
</td></tr></table>
332
 
</div>
333
 
<a name="check"></a>
334
 
<div>
335
 
<table class="details" border="1" cellpadding="3"
336
 
       cellspacing="0" width="100%" bgcolor="white">
337
 
<tr><td>
338
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
339
 
  <tr valign="top"><td>
340
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">check</span>(<span class="sig-arg">self</span>,
341
 
        <span class="sig-arg">catalog</span>=<span class="sig-default">None</span>)</span>
342
 
  </h3>
343
 
  </td><td align="right" valign="top"
344
 
    >&nbsp;
345
 
    </td>
346
 
  </tr></table>
347
 
  
348
 
  Run various validation checks on the message.  Some validations
349
 
are only performed if the catalog is provided.  This method returns
350
 
a sequence of <a href="babel.messages.catalog.TranslationError-class.html" class="link">TranslationError</a> objects.
351
 
  <dl class="fields">
352
 
    <dt>Parameters:</dt>
353
 
    <dd><ul class="nomargin-top">
354
 
        <li><strong class="pname"><code>catalog</code></strong> - A catalog instance that is passed to the checkers</li>
355
 
    </ul></dd>
356
 
    <dt>Returns: <tt class="rst-rst-docutils literal rst-docutils literal">iterator</tt></dt>
357
 
  </dl>
358
 
<div class="fields">      <p><strong>See Also:</strong>
359
 
        <a href="babel.messages.catalog.Catalog-class.html#check" class="link">Catalog.check</a> for a way to perform checks for all messages
360
 
in a catalog.
361
 
      </p>
362
 
</div></td></tr></table>
363
 
</div>
364
 
<br />
365
 
<!-- ==================== PROPERTY DETAILS ==================== -->
366
 
<a name="section-PropertyDetails"></a>
367
 
<table class="details" border="1" cellpadding="3"
368
 
       cellspacing="0" width="100%" bgcolor="white">
369
 
<tr bgcolor="#70b0f0" class="table-header">
370
 
  <td align="left" colspan="2" class="table-header">
371
 
    <span class="table-header">Property Details</span></td>
372
 
</tr>
373
 
</table>
374
 
<a name="fuzzy"></a>
375
 
<div>
376
 
<table class="details" border="1" cellpadding="3"
377
 
       cellspacing="0" width="100%" bgcolor="white">
378
 
<tr><td>
379
 
  <h3 class="epydoc">fuzzy</h3>
380
 
  <p>Whether the translation is fuzzy.</p>
381
 
<pre class="py-doctest">
382
 
<span class="py-prompt">&gt;&gt;&gt; </span>Message(<span class="py-string">'foo'</span>).fuzzy
383
 
<span class="py-output">False</span>
384
 
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>msg = Message(<span class="py-string">'foo'</span>, <span class="py-string">'foo'</span>, flags=[<span class="py-string">'fuzzy'</span>])
385
 
<span class="py-prompt">&gt;&gt;&gt; </span>msg.fuzzy
386
 
<span class="py-output">True</span>
387
 
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>msg
388
 
<span class="py-output">&lt;Message 'foo' (flags: ['fuzzy'])&gt;</span></pre>
389
 
  <dl class="fields">
390
 
    <dt>Get Method:</dt>
391
 
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fuzzy(<span class="summary-sig-arg">self</span>)</span>
392
 
    </dd>
393
 
    <dt>Type:</dt>
394
 
      <dd><code class="link">bool</code></dd>
395
 
  </dl>
396
 
</td></tr></table>
397
 
</div>
398
 
<a name="pluralizable"></a>
399
 
<div>
400
 
<table class="details" border="1" cellpadding="3"
401
 
       cellspacing="0" width="100%" bgcolor="white">
402
 
<tr><td>
403
 
  <h3 class="epydoc">pluralizable</h3>
404
 
  <p>Whether the message is plurizable.</p>
405
 
<pre class="py-doctest">
406
 
<span class="py-prompt">&gt;&gt;&gt; </span>Message(<span class="py-string">'foo'</span>).pluralizable
407
 
<span class="py-output">False</span>
408
 
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>Message((<span class="py-string">'foo'</span>, <span class="py-string">'bar'</span>)).pluralizable
409
 
<span class="py-output">True</span></pre>
410
 
  <dl class="fields">
411
 
    <dt>Get Method:</dt>
412
 
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.pluralizable(<span class="summary-sig-arg">self</span>)</span>
413
 
    </dd>
414
 
    <dt>Type:</dt>
415
 
      <dd><code class="link">bool</code></dd>
416
 
  </dl>
417
 
</td></tr></table>
418
 
</div>
419
 
<a name="python_format"></a>
420
 
<div>
421
 
<table class="details" border="1" cellpadding="3"
422
 
       cellspacing="0" width="100%" bgcolor="white">
423
 
<tr><td>
424
 
  <h3 class="epydoc">python_format</h3>
425
 
  <p>Whether the message contains Python-style parameters.</p>
426
 
<pre class="py-doctest">
427
 
<span class="py-prompt">&gt;&gt;&gt; </span>Message(<span class="py-string">'foo %(name)s bar'</span>).python_format
428
 
<span class="py-output">True</span>
429
 
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>Message((<span class="py-string">'foo %(name)s'</span>, <span class="py-string">'foo %(name)s'</span>)).python_format
430
 
<span class="py-output">True</span></pre>
431
 
  <dl class="fields">
432
 
    <dt>Get Method:</dt>
433
 
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.python_format(<span class="summary-sig-arg">self</span>)</span>
434
 
    </dd>
435
 
    <dt>Type:</dt>
436
 
      <dd><code class="link">bool</code></dd>
437
 
  </dl>
438
 
</td></tr></table>
439
 
</div>
440
 
<br />
441
 
<!-- ==================== NAVIGATION BAR ==================== -->
442
 
<table class="navbar" border="0" width="100%" cellpadding="0"
443
 
       bgcolor="#a0c0ff" cellspacing="0">
444
 
  <tr valign="middle">
445
 
  <!-- Home link -->
446
 
      <th>&nbsp;&nbsp;&nbsp;<a
447
 
        href="babel-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
448
 
 
449
 
  <!-- Tree link -->
450
 
      <th>&nbsp;&nbsp;&nbsp;<a
451
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
452
 
 
453
 
  <!-- Index link -->
454
 
      <th>&nbsp;&nbsp;&nbsp;<a
455
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
456
 
 
457
 
  <!-- Help link -->
458
 
      <th>&nbsp;&nbsp;&nbsp;<a
459
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
460
 
 
461
 
  <!-- Project homepage -->
462
 
      <th class="navbar" align="right" width="100%">
463
 
        <table border="0" cellpadding="0" cellspacing="0">
464
 
          <tr><th class="navbar" align="center"
465
 
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
466
 
          </tr></table></th>
467
 
  </tr>
468
 
</table>
469
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
470
 
  <tr>
471
 
    <td align="left" class="footer">
472
 
    Generated by Epydoc 3.0.1 on Thu Mar 17 15:12:44 2011
473
 
    </td>
474
 
    <td align="right" class="footer">
475
 
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
476
 
        >http://epydoc.sourceforge.net</a>
477
 
    </td>
478
 
  </tr>
479
 
</table>
480
 
 
481
 
<script type="text/javascript">
482
 
  <!--
483
 
  // Private objects are initially displayed (because if
484
 
  // javascript is turned off then we want them to be
485
 
  // visible); but by default, we want to hide them.  So hide
486
 
  // them unless we have a cookie that says to show them.
487
 
  checkCookie();
488
 
  // -->
489
 
</script>
490
 
</body>
491
 
</html>