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.list_option.ListOption</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.list_option-module.html">Module list_option</a> ::
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.list_option.ListOption-class.html"
59
target="_top">no frames</a>]</span></td></tr>
64
<!-- ==================== CLASS DESCRIPTION ==================== -->
65
<h1 class="epydoc">Class ListOption</h1><p class="nomargin-top"><span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption">source code</a></span></p>
66
<pre class="base-tree">
71
<a href="screenlets.options.base.Option-class.html">base.Option</a> --+
73
<strong class="uidshort">ListOption</strong>
77
<p>An Option for string options.</p>
79
<!-- ==================== INSTANCE METHODS ==================== -->
80
<a name="section-InstanceMethods"></a>
81
<table class="summary" border="1" cellpadding="3"
82
cellspacing="0" width="100%" bgcolor="white">
83
<tr bgcolor="#70b0f0" class="table-header">
84
<td colspan="2" class="table-header">
85
<table border="0" cellpadding="0" cellspacing="0" width="100%">
87
<td align="left"><span class="table-header">Instance Methods</span></td>
88
<td align="right" valign="top"
89
><span class="options">[<a href="#section-InstanceMethods"
90
class="privatelink" onclick="toggle_private();"
91
>hide private</a>]</span></td>
97
<td width="15%" align="right" valign="top" class="summary">
98
<span class="summary-type"> </span>
99
</td><td class="summary">
100
<table width="100%" cellpadding="0" cellspacing="0" border="0">
102
<td><span class="summary-sig"><a href="screenlets.options.list_option.ListOption-class.html#on_import" class="summary-sig-name">on_import</a>(<span class="summary-sig-arg">self</span>,
103
<span class="summary-sig-arg">strvalue</span>)</span><br />
104
When a list is imported from the config.</td>
105
<td align="right" valign="top">
106
<span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.on_import">source code</a></span>
115
<td width="15%" align="right" valign="top" class="summary">
116
<span class="summary-type"> </span>
117
</td><td class="summary">
118
<table width="100%" cellpadding="0" cellspacing="0" border="0">
120
<td><span class="summary-sig"><a href="screenlets.options.list_option.ListOption-class.html#on_export" class="summary-sig-name">on_export</a>(<span class="summary-sig-arg">self</span>,
121
<span class="summary-sig-arg">value</span>)</span><br />
122
When a list is exported to the config.</td>
123
<td align="right" valign="top">
124
<span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.on_export">source code</a></span>
133
<td width="15%" align="right" valign="top" class="summary">
134
<span class="summary-type"> </span>
135
</td><td class="summary">
136
<table width="100%" cellpadding="0" cellspacing="0" border="0">
138
<td><span class="summary-sig"><a href="screenlets.options.list_option.ListOption-class.html#generate_widget" class="summary-sig-name">generate_widget</a>(<span class="summary-sig-arg">self</span>,
139
<span class="summary-sig-arg">value</span>)</span><br />
140
Generate some widgets for a list.</td>
141
<td align="right" valign="top">
142
<span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.generate_widget">source code</a></span>
151
<td width="15%" align="right" valign="top" class="summary">
152
<span class="summary-type"> </span>
153
</td><td class="summary">
154
<table width="100%" cellpadding="0" cellspacing="0" border="0">
156
<td><span class="summary-sig"><a name="open_listeditor"></a><span class="summary-sig-name">open_listeditor</span>(<span class="summary-sig-arg">self</span>,
157
<span class="summary-sig-arg">event</span>)</span></td>
158
<td align="right" valign="top">
159
<span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.open_listeditor">source code</a></span>
168
<td width="15%" align="right" valign="top" class="summary">
169
<span class="summary-type"> </span>
170
</td><td class="summary">
171
<table width="100%" cellpadding="0" cellspacing="0" border="0">
173
<td><span class="summary-sig"><a href="screenlets.options.list_option.ListOption-class.html#set_value" class="summary-sig-name">set_value</a>(<span class="summary-sig-arg">self</span>,
174
<span class="summary-sig-arg">value</span>)</span><br />
175
Set the list string value as required.</td>
176
<td align="right" valign="top">
177
<span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.set_value">source code</a></span>
186
<td width="15%" align="right" valign="top" class="summary">
187
<span class="summary-type"> </span>
188
</td><td class="summary">
189
<table width="100%" cellpadding="0" cellspacing="0" border="0">
191
<td><span class="summary-sig"><a href="screenlets.options.list_option.ListOption-class.html#has_changed" class="summary-sig-name">has_changed</a>(<span class="summary-sig-arg">self</span>,
192
<span class="summary-sig-arg">widget</span>)</span><br />
193
Executed when the widget event kicks off.</td>
194
<td align="right" valign="top">
195
<span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.has_changed">source code</a></span>
204
<td colspan="2" class="summary">
205
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="screenlets.options.base.Option-class.html">base.Option</a></code></b>:
206
<code><a href="screenlets.options.base.Option-class.html#__init__">__init__</a></code>
208
<p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>.GObject</code></b>:
209
<code>__cmp__</code>,
210
<code>__copy__</code>,
211
<code>__deepcopy__</code>,
212
<code>__delattr__</code>,
213
<code>__gdoc__</code>,
214
<code>__gobject_init__</code>,
215
<code>__hash__</code>,
216
<code>__new__</code>,
217
<code>__repr__</code>,
218
<code>__setattr__</code>,
220
<code>connect</code>,
221
<code>connect_after</code>,
222
<code>connect_object</code>,
223
<code>connect_object_after</code>,
224
<code>disconnect</code>,
225
<code>disconnect_by_func</code>,
227
<code>emit_stop_by_name</code>,
228
<code>freeze_notify</code>,
229
<code>get_data</code>,
230
<code>get_properties</code>,
231
<code>get_property</code>,
232
<code>handler_block</code>,
233
<code>handler_block_by_func</code>,
234
<code>handler_disconnect</code>,
235
<code>handler_is_connected</code>,
236
<code>handler_unblock</code>,
237
<code>handler_unblock_by_func</code>,
240
<code>set_data</code>,
241
<code>set_properties</code>,
242
<code>set_property</code>,
243
<code>stop_emission</code>,
244
<code>thaw_notify</code>,
245
<code>weak_ref</code>
247
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
248
<code>__format__</code>,
249
<code>__getattribute__</code>,
250
<code>__reduce__</code>,
251
<code>__reduce_ex__</code>,
252
<code>__sizeof__</code>,
253
<code>__str__</code>,
254
<code>__subclasshook__</code>
259
<!-- ==================== CLASS VARIABLES ==================== -->
260
<a name="section-ClassVariables"></a>
261
<table class="summary" border="1" cellpadding="3"
262
cellspacing="0" width="100%" bgcolor="white">
263
<tr bgcolor="#70b0f0" class="table-header">
264
<td colspan="2" class="table-header">
265
<table border="0" cellpadding="0" cellspacing="0" width="100%">
267
<td align="left"><span class="table-header">Class Variables</span></td>
268
<td align="right" valign="top"
269
><span class="options">[<a href="#section-ClassVariables"
270
class="privatelink" onclick="toggle_private();"
271
>hide private</a>]</span></td>
277
<td colspan="2" class="summary">
278
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="screenlets.options.base.Option-class.html">base.Option</a></code></b>:
279
<code><a href="screenlets.options.base.Option-class.html#__gsignals__">__gsignals__</a></code>,
280
<code><a href="screenlets.options.base.Option-class.html#__gtype__">__gtype__</a></code>,
281
<code><a href="screenlets.options.base.Option-class.html#default">default</a></code>,
282
<code><a href="screenlets.options.base.Option-class.html#desc">desc</a></code>,
283
<code><a href="screenlets.options.base.Option-class.html#disabled">disabled</a></code>,
284
<code><a href="screenlets.options.base.Option-class.html#hidden">hidden</a></code>,
285
<code><a href="screenlets.options.base.Option-class.html#label">label</a></code>,
286
<code><a href="screenlets.options.base.Option-class.html#protected">protected</a></code>,
287
<code><a href="screenlets.options.base.Option-class.html#realtime">realtime</a></code>,
288
<code><a href="screenlets.options.base.Option-class.html#widget">widget</a></code>
293
<!-- ==================== PROPERTIES ==================== -->
294
<a name="section-Properties"></a>
295
<table class="summary" border="1" cellpadding="3"
296
cellspacing="0" width="100%" bgcolor="white">
297
<tr bgcolor="#70b0f0" class="table-header">
298
<td colspan="2" class="table-header">
299
<table border="0" cellpadding="0" cellspacing="0" width="100%">
301
<td align="left"><span class="table-header">Properties</span></td>
302
<td align="right" valign="top"
303
><span class="options">[<a href="#section-Properties"
304
class="privatelink" onclick="toggle_private();"
305
>hide private</a>]</span></td>
311
<td colspan="2" class="summary">
312
<p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>.GObject</code></b>:
313
<code>__grefcount__</code>
315
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
316
<code>__class__</code>
321
<!-- ==================== METHOD DETAILS ==================== -->
322
<a name="section-MethodDetails"></a>
323
<table class="details" border="1" cellpadding="3"
324
cellspacing="0" width="100%" bgcolor="white">
325
<tr bgcolor="#70b0f0" class="table-header">
326
<td colspan="2" class="table-header">
327
<table border="0" cellpadding="0" cellspacing="0" width="100%">
329
<td align="left"><span class="table-header">Method Details</span></td>
330
<td align="right" valign="top"
331
><span class="options">[<a href="#section-MethodDetails"
332
class="privatelink" onclick="toggle_private();"
333
>hide private</a>]</span></td>
339
<a name="on_import"></a>
341
<table class="details" border="1" cellpadding="3"
342
cellspacing="0" width="100%" bgcolor="white">
344
<table width="100%" cellpadding="0" cellspacing="0" border="0">
345
<tr valign="top"><td>
346
<h3 class="epydoc"><span class="sig"><span class="sig-name">on_import</span>(<span class="sig-arg">self</span>,
347
<span class="sig-arg">strvalue</span>)</span>
349
</td><td align="right" valign="top"
350
><span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.on_import">source code</a></span>
354
<p>When a list is imported from the config.</p>
357
<a href="screenlets.options.base.Option-class.html#on_import">base.Option.on_import</a>
362
<a name="on_export"></a>
364
<table class="details" border="1" cellpadding="3"
365
cellspacing="0" width="100%" bgcolor="white">
367
<table width="100%" cellpadding="0" cellspacing="0" border="0">
368
<tr valign="top"><td>
369
<h3 class="epydoc"><span class="sig"><span class="sig-name">on_export</span>(<span class="sig-arg">self</span>,
370
<span class="sig-arg">value</span>)</span>
372
</td><td align="right" valign="top"
373
><span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.on_export">source code</a></span>
377
<p>When a list is exported to the config.</p>
380
<a href="screenlets.options.base.Option-class.html#on_export">base.Option.on_export</a>
385
<a name="generate_widget"></a>
387
<table class="details" border="1" cellpadding="3"
388
cellspacing="0" width="100%" bgcolor="white">
390
<table width="100%" cellpadding="0" cellspacing="0" border="0">
391
<tr valign="top"><td>
392
<h3 class="epydoc"><span class="sig"><span class="sig-name">generate_widget</span>(<span class="sig-arg">self</span>,
393
<span class="sig-arg">value</span>)</span>
395
</td><td align="right" valign="top"
396
><span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.generate_widget">source code</a></span>
400
<p>Generate some widgets for a list.</p>
403
<a href="screenlets.options.base.Option-class.html#generate_widget">base.Option.generate_widget</a>
408
<a name="set_value"></a>
410
<table class="details" border="1" cellpadding="3"
411
cellspacing="0" width="100%" bgcolor="white">
413
<table width="100%" cellpadding="0" cellspacing="0" border="0">
414
<tr valign="top"><td>
415
<h3 class="epydoc"><span class="sig"><span class="sig-name">set_value</span>(<span class="sig-arg">self</span>,
416
<span class="sig-arg">value</span>)</span>
418
</td><td align="right" valign="top"
419
><span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.set_value">source code</a></span>
423
<p>Set the list string value as required.</p>
426
<a href="screenlets.options.base.Option-class.html#set_value">base.Option.set_value</a>
431
<a name="has_changed"></a>
433
<table class="details" border="1" cellpadding="3"
434
cellspacing="0" width="100%" bgcolor="white">
436
<table width="100%" cellpadding="0" cellspacing="0" border="0">
437
<tr valign="top"><td>
438
<h3 class="epydoc"><span class="sig"><span class="sig-name">has_changed</span>(<span class="sig-arg">self</span>,
439
<span class="sig-arg">widget</span>)</span>
441
</td><td align="right" valign="top"
442
><span class="codelink"><a href="screenlets.options.list_option-pysrc.html#ListOption.has_changed">source code</a></span>
446
<p>Executed when the widget event kicks off.</p>
449
<a href="screenlets.options.base.Option-class.html#has_changed">base.Option.has_changed</a>
455
<!-- ==================== NAVIGATION BAR ==================== -->
456
<table class="navbar" border="0" width="100%" cellpadding="0"
457
bgcolor="#a0c0ff" cellspacing="0">
460
<th> <a
461
href="screenlets-module.html">Home</a> </th>
464
<th> <a
465
href="module-tree.html">Trees</a> </th>
468
<th> <a
469
href="identifier-index.html">Indices</a> </th>
472
<th> <a
473
href="help.html">Help</a> </th>
475
<!-- Project homepage -->
476
<th class="navbar" align="right" width="100%">
477
<table border="0" cellpadding="0" cellspacing="0">
478
<tr><th class="navbar" align="center"
479
>Screenlets 0.1.4</th>
483
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
485
<td align="left" class="footer">
486
Generated by Epydoc 3.0.1 on Mon Jun 6 10:56:36 2011
488
<td align="right" class="footer">
489
<a target="mainFrame" href="http://epydoc.sourceforge.net"
490
>http://epydoc.sourceforge.net</a>
495
<script type="text/javascript">
497
// Private objects are initially displayed (because if
498
// javascript is turned off then we want them to be
499
// visible); but by default, we want to hide them. So hide
500
// them unless we have a cookie that says to show them.