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">
6
<title>screenlets.options.base.EditableOptions</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="screenlets-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
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
>Screenlets 0.1.4</th>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
45
<a href="screenlets-module.html">Package screenlets</a> ::
46
<a href="screenlets.options-module.html">Package options</a> ::
47
<a href="screenlets.options.base-module.html">Module base</a> ::
48
Class EditableOptions
52
<table cellpadding="0" cellspacing="0">
53
<!-- hide/show private -->
54
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55
onclick="toggle_private();">hide private</a>]</span></td></tr>
56
<tr><td align="right"><span class="options"
57
>[<a href="frames.html" target="_top">frames</a
58
>] | <a href="screenlets.options.base.EditableOptions-class.html"
59
target="_top">no frames</a>]</span></td></tr>
64
<!-- ==================== CLASS DESCRIPTION ==================== -->
65
<h1 class="epydoc">Class EditableOptions</h1><p class="nomargin-top"><span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions">source code</a></span></p>
66
<pre class="base-tree">
69
<strong class="uidshort">EditableOptions</strong>
72
<dl><dt>Known Subclasses:</dt>
74
<ul class="subclass-list">
75
<li><a href="screenlets.Screenlet-class.html">Screenlet</a></li> </ul>
79
<p>The EditableOptions can be inherited from to allow objects to export
80
editable options for editing them with the OptionsEditor-class. NOTE:
81
This could use some improvement and is very poorly coded :) ...</p>
83
<!-- ==================== INSTANCE METHODS ==================== -->
84
<a name="section-InstanceMethods"></a>
85
<table class="summary" border="1" cellpadding="3"
86
cellspacing="0" width="100%" bgcolor="white">
87
<tr bgcolor="#70b0f0" class="table-header">
88
<td colspan="2" class="table-header">
89
<table border="0" cellpadding="0" cellspacing="0" width="100%">
91
<td align="left"><span class="table-header">Instance Methods</span></td>
92
<td align="right" valign="top"
93
><span class="options">[<a href="#section-InstanceMethods"
94
class="privatelink" onclick="toggle_private();"
95
>hide private</a>]</span></td>
101
<td width="15%" align="right" valign="top" class="summary">
102
<span class="summary-type"> </span>
103
</td><td class="summary">
104
<table width="100%" cellpadding="0" cellspacing="0" border="0">
106
<td><span class="summary-sig"><a href="screenlets.options.base.EditableOptions-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
107
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
108
<td align="right" valign="top">
109
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.__init__">source code</a></span>
118
<td width="15%" align="right" valign="top" class="summary">
119
<span class="summary-type"> </span>
120
</td><td class="summary">
121
<table width="100%" cellpadding="0" cellspacing="0" border="0">
123
<td><span class="summary-sig"><a href="screenlets.options.base.EditableOptions-class.html#add_option" class="summary-sig-name">add_option</a>(<span class="summary-sig-arg">self</span>,
124
<span class="summary-sig-arg">option</span>,
125
<span class="summary-sig-arg">callback</span>=<span class="summary-sig-default">None</span>,
126
<span class="summary-sig-arg">realtime</span>=<span class="summary-sig-default">True</span>)</span><br />
127
Add an editable option to this object.</td>
128
<td align="right" valign="top">
129
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.add_option">source code</a></span>
138
<td width="15%" align="right" valign="top" class="summary">
139
<span class="summary-type"> </span>
140
</td><td class="summary">
141
<table width="100%" cellpadding="0" cellspacing="0" border="0">
143
<td><span class="summary-sig"><a name="add_options_group"></a><span class="summary-sig-name">add_options_group</span>(<span class="summary-sig-arg">self</span>,
144
<span class="summary-sig-arg">name</span>,
145
<span class="summary-sig-arg">group_info</span>)</span><br />
146
Add a new options-group to this Options-object</td>
147
<td align="right" valign="top">
148
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.add_options_group">source code</a></span>
157
<td width="15%" align="right" valign="top" class="summary">
158
<span class="summary-type"> </span>
159
</td><td class="summary">
160
<table width="100%" cellpadding="0" cellspacing="0" border="0">
162
<td><span class="summary-sig"><a name="disable_option"></a><span class="summary-sig-name">disable_option</span>(<span class="summary-sig-arg">self</span>,
163
<span class="summary-sig-arg">name</span>)</span><br />
164
Disable the inputs for a certain Option.</td>
165
<td align="right" valign="top">
166
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.disable_option">source code</a></span>
175
<td width="15%" align="right" valign="top" class="summary">
176
<span class="summary-type"> </span>
177
</td><td class="summary">
178
<table width="100%" cellpadding="0" cellspacing="0" border="0">
180
<td><span class="summary-sig"><a name="enable_option"></a><span class="summary-sig-name">enable_option</span>(<span class="summary-sig-arg">self</span>,
181
<span class="summary-sig-arg">name</span>)</span><br />
182
Enable the inputs for a certain Option.</td>
183
<td align="right" valign="top">
184
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.enable_option">source code</a></span>
193
<td width="15%" align="right" valign="top" class="summary">
194
<span class="summary-type"> </span>
195
</td><td class="summary">
196
<table width="100%" cellpadding="0" cellspacing="0" border="0">
198
<td><span class="summary-sig"><a name="export_options_as_list"></a><span class="summary-sig-name">export_options_as_list</span>(<span class="summary-sig-arg">self</span>)</span><br />
199
Returns all editable options within a list (without groups) as
200
key/value tuples.</td>
201
<td align="right" valign="top">
202
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.export_options_as_list">source code</a></span>
211
<td width="15%" align="right" valign="top" class="summary">
212
<span class="summary-type"> </span>
213
</td><td class="summary">
214
<table width="100%" cellpadding="0" cellspacing="0" border="0">
216
<td><span class="summary-sig"><a name="callback_value_changed"></a><span class="summary-sig-name">callback_value_changed</span>(<span class="summary-sig-arg">self</span>,
217
<span class="summary-sig-arg">sender</span>,
218
<span class="summary-sig-arg">option</span>)</span><br />
219
Called when a widget has updated and this needs calling.</td>
220
<td align="right" valign="top">
221
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.callback_value_changed">source code</a></span>
230
<td width="15%" align="right" valign="top" class="summary">
231
<span class="summary-type"> </span>
232
</td><td class="summary">
233
<table width="100%" cellpadding="0" cellspacing="0" border="0">
235
<td><span class="summary-sig"><a href="screenlets.options.base.EditableOptions-class.html#get_option_by_name" class="summary-sig-name">get_option_by_name</a>(<span class="summary-sig-arg">self</span>,
236
<span class="summary-sig-arg">name</span>)</span><br />
237
Returns an option in this Options by it's name (or None).</td>
238
<td align="right" valign="top">
239
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.get_option_by_name">source code</a></span>
248
<td width="15%" align="right" valign="top" class="summary">
249
<span class="summary-type"> </span>
250
</td><td class="summary">
251
<table width="100%" cellpadding="0" cellspacing="0" border="0">
253
<td><span class="summary-sig"><a name="remove_option"></a><span class="summary-sig-name">remove_option</span>(<span class="summary-sig-arg">self</span>,
254
<span class="summary-sig-arg">name</span>)</span><br />
255
Remove an option from this Options.</td>
256
<td align="right" valign="top">
257
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.remove_option">source code</a></span>
266
<td width="15%" align="right" valign="top" class="summary">
267
<span class="summary-type"> </span>
268
</td><td class="summary">
269
<table width="100%" cellpadding="0" cellspacing="0" border="0">
271
<td><span class="summary-sig"><a href="screenlets.options.base.EditableOptions-class.html#add_options_from_file" class="summary-sig-name">add_options_from_file</a>(<span class="summary-sig-arg">self</span>,
272
<span class="summary-sig-arg">filename</span>)</span><br />
273
This function creates options from an XML-file with option-metadata.</td>
274
<td align="right" valign="top">
275
<span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.add_options_from_file">source code</a></span>
284
<td colspan="2" class="summary">
285
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
286
<code>__delattr__</code>,
287
<code>__format__</code>,
288
<code>__getattribute__</code>,
289
<code>__hash__</code>,
290
<code>__new__</code>,
291
<code>__reduce__</code>,
292
<code>__reduce_ex__</code>,
293
<code>__repr__</code>,
294
<code>__setattr__</code>,
295
<code>__sizeof__</code>,
296
<code>__str__</code>,
297
<code>__subclasshook__</code>
302
<!-- ==================== PROPERTIES ==================== -->
303
<a name="section-Properties"></a>
304
<table class="summary" border="1" cellpadding="3"
305
cellspacing="0" width="100%" bgcolor="white">
306
<tr bgcolor="#70b0f0" class="table-header">
307
<td colspan="2" class="table-header">
308
<table border="0" cellpadding="0" cellspacing="0" width="100%">
310
<td align="left"><span class="table-header">Properties</span></td>
311
<td align="right" valign="top"
312
><span class="options">[<a href="#section-Properties"
313
class="privatelink" onclick="toggle_private();"
314
>hide private</a>]</span></td>
320
<td colspan="2" class="summary">
321
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
322
<code>__class__</code>
327
<!-- ==================== METHOD DETAILS ==================== -->
328
<a name="section-MethodDetails"></a>
329
<table class="details" border="1" cellpadding="3"
330
cellspacing="0" width="100%" bgcolor="white">
331
<tr bgcolor="#70b0f0" class="table-header">
332
<td colspan="2" class="table-header">
333
<table border="0" cellpadding="0" cellspacing="0" width="100%">
335
<td align="left"><span class="table-header">Method Details</span></td>
336
<td align="right" valign="top"
337
><span class="options">[<a href="#section-MethodDetails"
338
class="privatelink" onclick="toggle_private();"
339
>hide private</a>]</span></td>
345
<a name="__init__"></a>
347
<table class="details" border="1" cellpadding="3"
348
cellspacing="0" width="100%" bgcolor="white">
350
<table width="100%" cellpadding="0" cellspacing="0" border="0">
351
<tr valign="top"><td>
352
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
353
<br /><em class="fname">(Constructor)</em>
355
</td><td align="right" valign="top"
356
><span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.__init__">source code</a></span>
360
<p>x.__init__(...) initializes x; see x.__class__.__doc__ for
365
<dd><em class="note">(inherited documentation)</em></dd>
370
<a name="add_option"></a>
372
<table class="details" border="1" cellpadding="3"
373
cellspacing="0" width="100%" bgcolor="white">
375
<table width="100%" cellpadding="0" cellspacing="0" border="0">
376
<tr valign="top"><td>
377
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_option</span>(<span class="sig-arg">self</span>,
378
<span class="sig-arg">option</span>,
379
<span class="sig-arg">callback</span>=<span class="sig-default">None</span>,
380
<span class="sig-arg">realtime</span>=<span class="sig-default">True</span>)</span>
382
</td><td align="right" valign="top"
383
><span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.add_option">source code</a></span>
387
<p>Add an editable option to this object. Editable Options can be edited
388
and configured using the OptionsDialog. The optional callback-arg can be
389
used to set a callback that gets notified when the option changes its
395
<a name="get_option_by_name"></a>
397
<table class="details" border="1" cellpadding="3"
398
cellspacing="0" width="100%" bgcolor="white">
400
<table width="100%" cellpadding="0" cellspacing="0" border="0">
401
<tr valign="top"><td>
402
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_option_by_name</span>(<span class="sig-arg">self</span>,
403
<span class="sig-arg">name</span>)</span>
405
</td><td align="right" valign="top"
406
><span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.get_option_by_name">source code</a></span>
410
<p>Returns an option in this Options by it's name (or None). TODO: this
411
gives wrong results in childclasses ... maybe access as
412
class-attribute??</p>
417
<a name="add_options_from_file"></a>
419
<table class="details" border="1" cellpadding="3"
420
cellspacing="0" width="100%" bgcolor="white">
422
<table width="100%" cellpadding="0" cellspacing="0" border="0">
423
<tr valign="top"><td>
424
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_options_from_file</span>(<span class="sig-arg">self</span>,
425
<span class="sig-arg">filename</span>)</span>
427
</td><td align="right" valign="top"
428
><span class="codelink"><a href="screenlets.options.base-pysrc.html#EditableOptions.add_options_from_file">source code</a></span>
432
<p>This function creates options from an XML-file with option-metadata.
433
TODO: make this more reusable and place it into module (once the groups
440
<!-- ==================== NAVIGATION BAR ==================== -->
441
<table class="navbar" border="0" width="100%" cellpadding="0"
442
bgcolor="#a0c0ff" cellspacing="0">
445
<th> <a
446
href="screenlets-module.html">Home</a> </th>
449
<th> <a
450
href="module-tree.html">Trees</a> </th>
453
<th> <a
454
href="identifier-index.html">Indices</a> </th>
457
<th> <a
458
href="help.html">Help</a> </th>
460
<!-- Project homepage -->
461
<th class="navbar" align="right" width="100%">
462
<table border="0" cellpadding="0" cellspacing="0">
463
<tr><th class="navbar" align="center"
464
>Screenlets 0.1.4</th>
468
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
470
<td align="left" class="footer">
471
Generated by Epydoc 3.0.1 on Mon Jun 6 10:56:35 2011
473
<td align="right" class="footer">
474
<a target="mainFrame" href="http://epydoc.sourceforge.net"
475
>http://epydoc.sourceforge.net</a>
480
<script type="text/javascript">
482
// Private objects are initially displayed (because if
483
// javascript is turned off then we want them to be
484
// visible); but by default, we want to hide them. So hide
485
// them unless we have a cookie that says to show them.
added
removed
docs/epydoc/screenlets.options.base.EditableOptions-class.html
