Part of elisa.plugins.poblesec.section View In Hierarchy
Line # | Kind | Name | Docs |
---|---|---|---|
50 | Method | get_label | Return a text to display in a label to represent an item. |
53 | Method | get_default_image | Return the path of a theme resource to display as a default image for |
56 | Method | get_image | Return the path to an image file to display as an image for an item. |
59 | Method | get_preview_image | Return the path to an image file to display as a preview image for an |
Inherited from GenericListViewMode:
Line # | Kind | Name | Docs |
---|---|---|---|
206 | Method | get_sublabel | Return a text to display in a sublabel to represent an item. |
Inherited from Component (via GenericListViewMode):
Line # | Kind | Name | Docs |
---|---|---|---|
85 | Class | PathDescriptor | Undocumented |
97 | Class Method | create | Create and initialize the component. |
130 | Method | initialize | Initialize the component. |
142 | Method | clean | Clean the component. |
Inherited from Loggable (via GenericListViewMode, Component):
Line # | Kind | Name | Docs |
---|---|---|---|
81 | Method | __init__ | Undocumented |
Return a text to display in a label to represent an item.
This call is asynchronous, it should return aelisa.core.utils.cancellable_defer.CancellableDeferred
that, when triggered, returns the text of the label.
Parameters | item | a list item
(type: a subclass of elisa.core.components.model.Model
) |
Returns | a cancellable deferred
(type: elisa.core.utils.cancellable_defer.CancellableDeferred
) |
Parameters | item | a list item
(type: a subclass of elisa.core.components.model.Model
) |
Returns | the path of a theme resource to display as a default image for the
item
(type: str
) |
Return the path to an image file to display as an image for an item.
This call is asynchronous, it should return a elisa.core.utils.cancellable_defer.CancellableDeferred
that, when triggered, returns the path to an image file on disk (downloaded
and cached if necessary).
None
.
Parameters | item | a list item
(type: a subclass of elisa.core.components.model.Model
) |
theme | the frontend's current theme
(type: elisa.plugins.pigment.widgets.theme.Theme
) | |
Returns | a cancellable deferred or None
(type: elisa.core.utils.cancellable_defer.CancellableDeferred
) |
Return the path to an image file to display as a preview image for an item.
This call is synchronous, if no preview image is available yet for the item or if no other image than the default one is necessary, it should returnNone
.
Parameters | item | a list item
(type: a subclass of elisa.core.components.model.Model
) |
theme | the frontend's current theme
(type: elisa.plugins.pigment.widgets.theme.Theme
) | |
Returns | the path to an image file on disk or None
(type: str or None
) |