~sahana-eden-short-projects/sahana-eden/staging

« back to all changes in this revision

Viewing changes to docs/s3/vita.modules.s3.s3search.S3Search-class.html

  • Committer: Fran Boon
  • Date: 2011-10-13 20:21:49 UTC
  • mfrom: (185.15.289 vita)
  • Revision ID: fran@aidiq.com-20111013202149-rwfv1dr7fgdfr9kr
merge nursix: cleanups

Show diffs side-by-side

added added

removed removed

Lines of Context:
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>vita.modules.s3.s3search.S3Search</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="vita.modules.s3-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="http://eden.sahanafoundation.org/wiki/S3">S3</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
 
        Package&nbsp;vita ::
46
 
        Package&nbsp;modules ::
47
 
        <a href="vita.modules.s3-module.html">Package&nbsp;s3</a> ::
48
 
        <a href="vita.modules.s3.s3search-module.html">Module&nbsp;s3search</a> ::
49
 
        Class&nbsp;S3Search
50
 
      </span>
51
 
    </td>
52
 
    <td>
53
 
      <table cellpadding="0" cellspacing="0">
54
 
        <!-- hide/show private -->
55
 
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56
 
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57
 
        <tr><td align="right"><span class="options"
58
 
            >[<a href="frames.html" target="_top">frames</a
59
 
            >]&nbsp;|&nbsp;<a href="vita.modules.s3.s3search.S3Search-class.html"
60
 
            target="_top">no&nbsp;frames</a>]</span></td></tr>
61
 
      </table>
62
 
    </td>
63
 
  </tr>
64
 
</table>
65
 
<!-- ==================== CLASS DESCRIPTION ==================== -->
66
 
<h1 class="epydoc">Class S3Search</h1><p class="nomargin-top"><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search">source&nbsp;code</a></span></p>
67
 
<pre class="base-tree">
68
 
     object --+        
69
 
              |        
70
 
<a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a> --+    
71
 
                  |    
72
 
      <a href="vita.modules.s3.s3crud.S3CRUD-class.html">s3crud.S3CRUD</a> --+
73
 
                      |
74
 
                     <strong class="uidshort">S3Search</strong>
75
 
</pre>
76
 
 
77
 
<hr />
78
 
<p>RESTful Search Method for S3Resources</p>
79
 
 
80
 
<!-- ==================== INSTANCE METHODS ==================== -->
81
 
<a name="section-InstanceMethods"></a>
82
 
<table class="summary" border="1" cellpadding="3"
83
 
       cellspacing="0" width="100%" bgcolor="white">
84
 
<tr bgcolor="#70b0f0" class="table-header">
85
 
  <td colspan="2" class="table-header">
86
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
87
 
      <tr valign="top">
88
 
        <td align="left"><span class="table-header">Instance Methods</span></td>
89
 
        <td align="right" valign="top"
90
 
         ><span class="options">[<a href="#section-InstanceMethods"
91
 
         class="privatelink" onclick="toggle_private();"
92
 
         >hide private</a>]</span></td>
93
 
      </tr>
94
 
    </table>
95
 
  </td>
96
 
</tr>
97
 
<tr>
98
 
    <td width="15%" align="right" valign="top" class="summary">
99
 
      <span class="summary-type">&nbsp;</span>
100
 
    </td><td class="summary">
101
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
102
 
        <tr>
103
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3search.S3Search-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
104
 
        <span class="summary-sig-arg">simple</span>=<span class="summary-sig-default">None</span>,
105
 
        <span class="summary-sig-arg">advanced</span>=<span class="summary-sig-default">None</span>,
106
 
        <span class="summary-sig-arg">any</span>=<span class="summary-sig-default">False</span>,
107
 
        <span class="summary-sig-arg">**args</span>)</span><br />
108
 
      Constructor</td>
109
 
          <td align="right" valign="top">
110
 
            <span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.__init__">source&nbsp;code</a></span>
111
 
            
112
 
          </td>
113
 
        </tr>
114
 
      </table>
115
 
      
116
 
    </td>
117
 
  </tr>
118
 
<tr>
119
 
    <td width="15%" align="right" valign="top" class="summary">
120
 
      <span class="summary-type">&nbsp;</span>
121
 
    </td><td class="summary">
122
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
123
 
        <tr>
124
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3search.S3Search-class.html#apply_method" class="summary-sig-name">apply_method</a>(<span class="summary-sig-arg">self</span>,
125
 
        <span class="summary-sig-arg">r</span>,
126
 
        <span class="summary-sig-arg">**attr</span>)</span><br />
127
 
      Entry point to apply search method to S3Requests</td>
128
 
          <td align="right" valign="top">
129
 
            <span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.apply_method">source&nbsp;code</a></span>
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 href="vita.modules.s3.s3search.S3Search-class.html#search_interactive" class="summary-sig-name">search_interactive</a>(<span class="summary-sig-arg">self</span>,
144
 
        <span class="summary-sig-arg">r</span>,
145
 
        <span class="summary-sig-arg">**attr</span>)</span><br />
146
 
      Interactive search</td>
147
 
          <td align="right" valign="top">
148
 
            <span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.search_interactive">source&nbsp;code</a></span>
149
 
            
150
 
          </td>
151
 
        </tr>
152
 
      </table>
153
 
      
154
 
    </td>
155
 
  </tr>
156
 
<tr>
157
 
    <td width="15%" align="right" valign="top" class="summary">
158
 
      <span class="summary-type">&nbsp;</span>
159
 
    </td><td class="summary">
160
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
161
 
        <tr>
162
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3search.S3Search-class.html#search_json" class="summary-sig-name">search_json</a>(<span class="summary-sig-arg">self</span>,
163
 
        <span class="summary-sig-arg">r</span>,
164
 
        <span class="summary-sig-arg">**attr</span>)</span><br />
165
 
      Legacy JSON search method (for autocomplete-widgets)</td>
166
 
          <td align="right" valign="top">
167
 
            <span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.search_json">source&nbsp;code</a></span>
168
 
            
169
 
          </td>
170
 
        </tr>
171
 
      </table>
172
 
      
173
 
    </td>
174
 
  </tr>
175
 
  <tr>
176
 
    <td colspan="2" class="summary">
177
 
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html">s3crud.S3CRUD</a></code></b>:
178
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#create">create</a></code>,
179
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#crud_button">crud_button</a></code>,
180
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#crud_string">crud_string</a></code>,
181
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#delete">delete</a></code>,
182
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#insert_buttons">insert_buttons</a></code>,
183
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#last_update">last_update</a></code>,
184
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#read">read</a></code>,
185
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#select">select</a></code>,
186
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#sqlform">sqlform</a></code>,
187
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#sqltable">sqltable</a></code>,
188
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#ssp_filter">ssp_filter</a></code>,
189
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#ssp_orderby">ssp_orderby</a></code>,
190
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#update">update</a></code>
191
 
      </p>
192
 
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html">s3crud.S3CRUD</a></code></b> (private):
193
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#_linkto" onclick="show_private();">_linkto</a></code>
194
 
      </p></div>
195
 
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b>:
196
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#__call__">__call__</a></code>
197
 
      </p>
198
 
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b> (private):
199
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#_config" onclick="show_private();">_config</a></code>
200
 
      </p></div>
201
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
202
 
      <code>__delattr__</code>,
203
 
      <code>__format__</code>,
204
 
      <code>__getattribute__</code>,
205
 
      <code>__hash__</code>,
206
 
      <code>__new__</code>,
207
 
      <code>__reduce__</code>,
208
 
      <code>__reduce_ex__</code>,
209
 
      <code>__repr__</code>,
210
 
      <code>__setattr__</code>,
211
 
      <code>__sizeof__</code>,
212
 
      <code>__str__</code>,
213
 
      <code>__subclasshook__</code>
214
 
      </p>
215
 
    </td>
216
 
  </tr>
217
 
</table>
218
 
<!-- ==================== STATIC METHODS ==================== -->
219
 
<a name="section-StaticMethods"></a>
220
 
<table class="summary" border="1" cellpadding="3"
221
 
       cellspacing="0" width="100%" bgcolor="white">
222
 
<tr bgcolor="#70b0f0" class="table-header">
223
 
  <td colspan="2" class="table-header">
224
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
225
 
      <tr valign="top">
226
 
        <td align="left"><span class="table-header">Static Methods</span></td>
227
 
        <td align="right" valign="top"
228
 
         ><span class="options">[<a href="#section-StaticMethods"
229
 
         class="privatelink" onclick="toggle_private();"
230
 
         >hide private</a>]</span></td>
231
 
      </tr>
232
 
    </table>
233
 
  </td>
234
 
</tr>
235
 
  <tr>
236
 
    <td colspan="2" class="summary">
237
 
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html">s3crud.S3CRUD</a></code></b>:
238
 
      <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#insert_subheadings">insert_subheadings</a></code>
239
 
      </p>
240
 
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b> (private):
241
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#_extend_view" onclick="show_private();">_extend_view</a></code>,
242
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#_record_id" onclick="show_private();">_record_id</a></code>,
243
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#_view" onclick="show_private();">_view</a></code>
244
 
      </p></div>
245
 
    </td>
246
 
  </tr>
247
 
</table>
248
 
<!-- ==================== PROPERTIES ==================== -->
249
 
<a name="section-Properties"></a>
250
 
<table class="summary" border="1" cellpadding="3"
251
 
       cellspacing="0" width="100%" bgcolor="white">
252
 
<tr bgcolor="#70b0f0" class="table-header">
253
 
  <td colspan="2" class="table-header">
254
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
255
 
      <tr valign="top">
256
 
        <td align="left"><span class="table-header">Properties</span></td>
257
 
        <td align="right" valign="top"
258
 
         ><span class="options">[<a href="#section-Properties"
259
 
         class="privatelink" onclick="toggle_private();"
260
 
         >hide private</a>]</span></td>
261
 
      </tr>
262
 
    </table>
263
 
  </td>
264
 
</tr>
265
 
  <tr>
266
 
    <td colspan="2" class="summary">
267
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
268
 
      <code>__class__</code>
269
 
      </p>
270
 
    </td>
271
 
  </tr>
272
 
</table>
273
 
<!-- ==================== METHOD DETAILS ==================== -->
274
 
<a name="section-MethodDetails"></a>
275
 
<table class="details" border="1" cellpadding="3"
276
 
       cellspacing="0" width="100%" bgcolor="white">
277
 
<tr bgcolor="#70b0f0" class="table-header">
278
 
  <td colspan="2" class="table-header">
279
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
280
 
      <tr valign="top">
281
 
        <td align="left"><span class="table-header">Method Details</span></td>
282
 
        <td align="right" valign="top"
283
 
         ><span class="options">[<a href="#section-MethodDetails"
284
 
         class="privatelink" onclick="toggle_private();"
285
 
         >hide private</a>]</span></td>
286
 
      </tr>
287
 
    </table>
288
 
  </td>
289
 
</tr>
290
 
</table>
291
 
<a name="__init__"></a>
292
 
<div>
293
 
<table class="details" border="1" cellpadding="3"
294
 
       cellspacing="0" width="100%" bgcolor="white">
295
 
<tr><td>
296
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
297
 
  <tr valign="top"><td>
298
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
299
 
        <span class="sig-arg">simple</span>=<span class="sig-default">None</span>,
300
 
        <span class="sig-arg">advanced</span>=<span class="sig-default">None</span>,
301
 
        <span class="sig-arg">any</span>=<span class="sig-default">False</span>,
302
 
        <span class="sig-arg">**args</span>)</span>
303
 
    <br /><em class="fname">(Constructor)</em>
304
 
  </h3>
305
 
  </td><td align="right" valign="top"
306
 
    ><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.__init__">source&nbsp;code</a></span>&nbsp;
307
 
    </td>
308
 
  </tr></table>
309
 
  
310
 
  <p>Constructor</p>
311
 
  <dl class="fields">
312
 
    <dt>Parameters:</dt>
313
 
    <dd><ul class="nomargin-top">
314
 
        <li><strong class="pname"><code>simple</code></strong> - the widgets for the simple search form as list</li>
315
 
        <li><strong class="pname"><code>advanced</code></strong> - the widgets for the advanced search form as list</li>
316
 
        <li><strong class="pname"><code>any</code></strong> - match &quot;any of&quot; (True) or &quot;all of&quot; (False) the
317
 
          options in advanced search</li>
318
 
    </ul></dd>
319
 
    <dt>Overrides:
320
 
        object.__init__
321
 
    </dt>
322
 
  </dl>
323
 
</td></tr></table>
324
 
</div>
325
 
<a name="apply_method"></a>
326
 
<div>
327
 
<table class="details" border="1" cellpadding="3"
328
 
       cellspacing="0" width="100%" bgcolor="white">
329
 
<tr><td>
330
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
331
 
  <tr valign="top"><td>
332
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">apply_method</span>(<span class="sig-arg">self</span>,
333
 
        <span class="sig-arg">r</span>,
334
 
        <span class="sig-arg">**attr</span>)</span>
335
 
  </h3>
336
 
  </td><td align="right" valign="top"
337
 
    ><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.apply_method">source&nbsp;code</a></span>&nbsp;
338
 
    </td>
339
 
  </tr></table>
340
 
  
341
 
  <p>Entry point to apply search method to S3Requests</p>
342
 
  <dl class="fields">
343
 
    <dt>Parameters:</dt>
344
 
    <dd><ul class="nomargin-top">
345
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request</li>
346
 
        <li><strong class="pname"><code>attr</code></strong> - request attributes</li>
347
 
    </ul></dd>
348
 
    <dt>Returns:</dt>
349
 
        <dd>output object to send to the view</dd>
350
 
    <dt>Overrides:
351
 
        <a href="vita.modules.s3.s3rest.S3Method-class.html#apply_method">s3rest.S3Method.apply_method</a>
352
 
    </dt>
353
 
  </dl>
354
 
</td></tr></table>
355
 
</div>
356
 
<a name="search_interactive"></a>
357
 
<div>
358
 
<table class="details" border="1" cellpadding="3"
359
 
       cellspacing="0" width="100%" bgcolor="white">
360
 
<tr><td>
361
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
362
 
  <tr valign="top"><td>
363
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">search_interactive</span>(<span class="sig-arg">self</span>,
364
 
        <span class="sig-arg">r</span>,
365
 
        <span class="sig-arg">**attr</span>)</span>
366
 
  </h3>
367
 
  </td><td align="right" valign="top"
368
 
    ><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.search_interactive">source&nbsp;code</a></span>&nbsp;
369
 
    </td>
370
 
  </tr></table>
371
 
  
372
 
  <p>Interactive search</p>
373
 
  <dl class="fields">
374
 
    <dt>Parameters:</dt>
375
 
    <dd><ul class="nomargin-top">
376
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request instance</li>
377
 
        <li><strong class="pname"><code>attr</code></strong> - request parameters</li>
378
 
    </ul></dd>
379
 
  </dl>
380
 
</td></tr></table>
381
 
</div>
382
 
<a name="search_json"></a>
383
 
<div>
384
 
<table class="details" border="1" cellpadding="3"
385
 
       cellspacing="0" width="100%" bgcolor="white">
386
 
<tr><td>
387
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
388
 
  <tr valign="top"><td>
389
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">search_json</span>(<span class="sig-arg">self</span>,
390
 
        <span class="sig-arg">r</span>,
391
 
        <span class="sig-arg">**attr</span>)</span>
392
 
  </h3>
393
 
  </td><td align="right" valign="top"
394
 
    ><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.search_json">source&nbsp;code</a></span>&nbsp;
395
 
    </td>
396
 
  </tr></table>
397
 
  
398
 
  <p>Legacy JSON search method (for autocomplete-widgets)</p>
399
 
  <dl class="fields">
400
 
    <dt>Parameters:</dt>
401
 
    <dd><ul class="nomargin-top">
402
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request</li>
403
 
        <li><strong class="pname"><code>attr</code></strong> - request attributes</li>
404
 
    </ul></dd>
405
 
  </dl>
406
 
</td></tr></table>
407
 
</div>
408
 
<br />
409
 
<!-- ==================== NAVIGATION BAR ==================== -->
410
 
<table class="navbar" border="0" width="100%" cellpadding="0"
411
 
       bgcolor="#a0c0ff" cellspacing="0">
412
 
  <tr valign="middle">
413
 
  <!-- Home link -->
414
 
      <th>&nbsp;&nbsp;&nbsp;<a
415
 
        href="vita.modules.s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
416
 
 
417
 
  <!-- Tree link -->
418
 
      <th>&nbsp;&nbsp;&nbsp;<a
419
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
420
 
 
421
 
  <!-- Index link -->
422
 
      <th>&nbsp;&nbsp;&nbsp;<a
423
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
424
 
 
425
 
  <!-- Help link -->
426
 
      <th>&nbsp;&nbsp;&nbsp;<a
427
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
428
 
 
429
 
  <!-- Project homepage -->
430
 
      <th class="navbar" align="right" width="100%">
431
 
        <table border="0" cellpadding="0" cellspacing="0">
432
 
          <tr><th class="navbar" align="center"
433
 
            ><a class="navbar" target="_top" href="http://eden.sahanafoundation.org/wiki/S3">S3</a></th>
434
 
          </tr></table></th>
435
 
  </tr>
436
 
</table>
437
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
438
 
  <tr>
439
 
    <td align="left" class="footer">
440
 
    Generated by Epydoc 3.0.1 on Tue Mar 29 14:25:41 2011
441
 
    </td>
442
 
    <td align="right" class="footer">
443
 
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
444
 
        >http://epydoc.sourceforge.net</a>
445
 
    </td>
446
 
  </tr>
447
 
</table>
448
 
 
449
 
<script type="text/javascript">
450
 
  <!--
451
 
  // Private objects are initially displayed (because if
452
 
  // javascript is turned off then we want them to be
453
 
  // visible); but by default, we want to hide them.  So hide
454
 
  // them unless we have a cookie that says to show them.
455
 
  checkCookie();
456
 
  // -->
457
 
</script>
458
 
</body>
459
 
</html>