2
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
"DTD/xhtml1-strict.dtd">
6
<title>API docs for “elisa.plugins.poblesec.link.LinksMenuViewMode”</title>
7
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
8
<link href="apidocs.css" type="text/css" rel="stylesheet" />
9
<script src="sorttable.js" type="text/javascript"></script>
13
<h1 class="class">Class e.p.p.l.LinksMenuViewMode(<a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html">GenericListViewMode</a>):</h1>
15
<span id="part">Part of <a href="elisa.html">elisa</a>.<a href="elisa.plugins.html">plugins</a>.<a href="elisa.plugins.poblesec.html">poblesec</a>.<a href="elisa.plugins.poblesec.link.html">link</a></span>
17
<a href="classIndex.html#elisa.plugins.poblesec.link.LinksMenuViewMode">View In Hierarchy</a>
22
<div>DOCME<table class="fieldTable"></table></div>
26
<div id="splitTables">
27
<table class="children sortable" id="id3022">
37
<td class="lineno">57</td>
39
<td><a href="elisa.plugins.poblesec.link.LinksMenuViewMode.html#get_label">get_label</a></td>
40
<td><span>Return a text to display in a label to represent an item.</span></td>
41
</tr><tr class="method">
43
<td class="lineno">60</td>
45
<td><a href="elisa.plugins.poblesec.link.LinksMenuViewMode.html#get_preview_image">get_preview_image</a></td>
46
<td><span>Return the path to an image file to display as a preview image for
48
</tr><tr class="method">
50
<td class="lineno">63</td>
52
<td><a href="elisa.plugins.poblesec.link.LinksMenuViewMode.html#get_image">get_image</a></td>
53
<td><span>Return the path to an image file to display as an image for an item.</span></td>
54
</tr><tr class="method">
56
<td class="lineno">66</td>
58
<td><a href="elisa.plugins.poblesec.link.LinksMenuViewMode.html#get_default_image">get_default_image</a></td>
59
<td><span>Return the path of a theme resource to display as a default image
66
Inherited from <a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html">GenericListViewMode</a>:
68
<table class="children sortable" id="id3023">
76
<tr class="basemethod">
78
<td class="lineno">66</td>
80
<td><a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html#get_sublabel">get_sublabel</a></td>
81
<td><span>Return a text to display in a sublabel to represent an item.</span></td>
82
</tr><tr class="basemethod">
84
<td class="lineno">137</td>
86
<td><a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html#get_contextual_background">get_contextual_background</a></td>
87
<td><span>Return the path to an image file to display as a contextual
88
background</span></td>
94
Inherited from <a href="elisa.core.component.Component.html">Component</a> (via <a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html">GenericListViewMode</a>):
96
<table class="children sortable" id="id3024">
104
<tr class="baseclass">
106
<td class="lineno">83</td>
108
<td><a href="elisa.core.component.Component.PathDescriptor.html">PathDescriptor</a></td>
109
<td><span class="undocumented">Undocumented</span></td>
110
</tr><tr class="baseclassmethod">
112
<td class="lineno">95</td>
113
<td>Class Method</td>
114
<td><a href="elisa.core.component.Component.html#create">create</a></td>
115
<td><span>Create and initialize the component.</span></td>
116
</tr><tr class="basemethod">
118
<td class="lineno">128</td>
120
<td><a href="elisa.core.component.Component.html#initialize">initialize</a></td>
121
<td><span>Initialize the component.</span></td>
122
</tr><tr class="basemethod">
124
<td class="lineno">140</td>
126
<td><a href="elisa.core.component.Component.html#clean">clean</a></td>
127
<td><span>Clean the component.</span></td>
128
</tr><tr class="basemethod">
130
<td class="lineno">153</td>
132
<td><a href="elisa.core.component.Component.html#name__get">name__get</a></td>
133
<td><span class="undocumented">Undocumented</span></td>
134
</tr><tr class="basemethod">
136
<td class="lineno">158</td>
138
<td><a href="elisa.core.component.Component.html#name__set">name__set</a></td>
139
<td><span class="undocumented">Undocumented</span></td>
145
Inherited from <a href="elisa.core.log.Loggable.html">Loggable</a> (via <a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html">GenericListViewMode</a>, <a href="elisa.core.component.Component.html">Component</a>):
147
<table class="children sortable" id="id3025">
155
<tr class="basemethod">
157
<td class="lineno">81</td>
159
<td><a href="elisa.core.log.Loggable.html#__init__">__init__</a></td>
160
<td><span class="undocumented">Undocumented</span></td>
171
<div class="function">
172
<a name="elisa.plugins.poblesec.link.LinksMenuViewMode.get_label">
178
<div class="functionHeader">
181
get_label(self, item):
184
<div class="functionBody">
185
<div class="interfaceinfo">overrides <a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html#get_label">elisa.plugins.poblesec.base.list.GenericListViewMode.get_label</a></div>
186
<div>Return a text to display in a label to represent an item.</p>
187
<p>This call is asynchronous, it should return a <a
188
href="elisa.core.utils.cancellable_defer.CancellableDeferred.html"><code>elisa.core.utils.cancellable_defer.CancellableDeferred</code></a>
189
that, when triggered, returns the text of the label.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">item</td><td>a list item
190
(type: a subclass of <a
191
href="elisa.core.components.model.Model.html"><code>elisa.core.components.model.Model</code></a>
192
)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">a cancellable deferred
194
href="elisa.core.utils.cancellable_defer.CancellableDeferred.html"><code>elisa.core.utils.cancellable_defer.CancellableDeferred</code></a>
195
)</td></tr></table></div>
197
</div><div class="function">
198
<a name="elisa.plugins.poblesec.link.LinksMenuViewMode.get_preview_image">
201
<a name="get_preview_image">
204
<div class="functionHeader">
207
get_preview_image(self, item, theme):
210
<div class="functionBody">
211
<div class="interfaceinfo">overrides <a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html#get_preview_image">elisa.plugins.poblesec.base.list.GenericListViewMode.get_preview_image</a></div>
212
<div>Return the path to an image file to display as a preview image for an
214
<p>This call is synchronous, if no preview image is available yet for the
215
item or if no other image than the default one is necessary, it should
216
return <code>None</code>.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">item</td><td>a list item
217
(type: a subclass of <a
218
href="elisa.core.components.model.Model.html"><code>elisa.core.components.model.Model</code></a>
219
)</td></tr><tr><td></td><td class="fieldArg">theme</td><td>the frontend's current theme
221
href="elisa.plugins.pigment.widgets.theme.Theme.html"><code>elisa.plugins.pigment.widgets.theme.Theme</code></a>
222
)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the path to an image file on disk or <code>None</code>
223
(type: <code>str</code> or <code>None</code>
224
)</td></tr></table></div>
226
</div><div class="function">
227
<a name="elisa.plugins.poblesec.link.LinksMenuViewMode.get_image">
233
<div class="functionHeader">
236
get_image(self, item, theme):
239
<div class="functionBody">
240
<div class="interfaceinfo">overrides <a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html#get_image">elisa.plugins.poblesec.base.list.GenericListViewMode.get_image</a></div>
241
<div>Return the path to an image file to display as an image for an item.</p>
242
<p>This call is asynchronous, it should return a <a
243
href="elisa.core.utils.cancellable_defer.CancellableDeferred.html"><code>elisa.core.utils.cancellable_defer.CancellableDeferred</code></a>
244
that, when triggered, returns the path to an image file on disk (downloaded
245
and cached if necessary).</p>
246
<p>If no other image than the default one is necessary/available, this
247
method should return <code>None</code>.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">item</td><td>a list item
248
(type: a subclass of <a
249
href="elisa.core.components.model.Model.html"><code>elisa.core.components.model.Model</code></a>
250
)</td></tr><tr><td></td><td class="fieldArg">theme</td><td>the frontend's current theme
252
href="elisa.plugins.pigment.widgets.theme.Theme.html"><code>elisa.plugins.pigment.widgets.theme.Theme</code></a>
253
)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">a cancellable deferred or <code>None</code>
255
href="elisa.core.utils.cancellable_defer.CancellableDeferred.html"><code>elisa.core.utils.cancellable_defer.CancellableDeferred</code></a>
256
)</td></tr></table></div>
258
</div><div class="function">
259
<a name="elisa.plugins.poblesec.link.LinksMenuViewMode.get_default_image">
262
<a name="get_default_image">
265
<div class="functionHeader">
268
get_default_image(self, item):
271
<div class="functionBody">
272
<div class="interfaceinfo">overrides <a href="elisa.plugins.poblesec.base.list.GenericListViewMode.html#get_default_image">elisa.plugins.poblesec.base.list.GenericListViewMode.get_default_image</a></div>
273
<div>Return the path of a theme resource to display as a default image for an
274
item.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">item</td><td>a list item
275
(type: a subclass of <a
276
href="elisa.core.components.model.Model.html"><code>elisa.core.components.model.Model</code></a>
277
)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the path of a theme resource to display as a default image for the item
278
(type: <code>str</code>
279
)</td></tr></table></div>
283
<a href="index.html">API Documentation</a> for <a href="http://elisa.fluendo.com">Elisa Media Center</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2009-05-25 19:09:45.
b'\\ No newline at end of file'