sugarlabs/sugar-toolkit-gtk3
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve docstrings in sugar3.graphics.objectchooser

Browse Source
This commit is contained in:
mandarj7 2015-12-23 16:55:25 +05:30
parent 264ee2b5a3
commit c95d74eab4
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/sugar3/graphics/objectchooser.py
View File

@ -46,7 +46,9 @@ def get_preview_pixbuf(preview_data, width=-1, height=-1):
Retrive a pixbuf with the content of the preview field Retrive a pixbuf with the content of the preview field
Args: Args:
metadata (dictionary): the metadata dictionary. Can't be None, use metadata.get('preview', '') metadata (dictionary): preview data from the metadata dictionary. Can't
be None. Returned from the
sugar3.datastore.datastore.DSObject.get_metadata() method.
Keyword Args: Keyword Args:
width (int): the pixbuf width, if is not set, the default width will be used width (int): the pixbuf width, if is not set, the default width will be used
@ -55,6 +57,16 @@ def get_preview_pixbuf(preview_data, width=-1, height=-1):
Returns: Returns:
Pixbuf, the generated Pixbuf Pixbuf, the generated Pixbuf
None, if it could not be created None, if it could not be created
Example:
pixbuf = get_preview_pixbuf(metadata.get('preview', ''))
has_preview = pixbuf is not None
if has_preview:
im = Gtk.Image()
im.set_from_pixbuf(pixbuf)
box.add(im)
im.show()
""" """
if width == -1: if width == -1:
width = PREVIEW_SIZE[0] width = PREVIEW_SIZE[0]
@ -103,7 +115,7 @@ def get_preview_pixbuf(preview_data, width=-1, height=-1):
class ObjectChooser(object): class ObjectChooser(object):
""" """
UI interface for objec choosers. UI interface for object choosers.
Object choosers can be used by acivities to allow the user to select objects Object choosers can be used by acivities to allow the user to select objects
from the file system or from some other similar source. from the file system or from some other similar source.
@ -112,7 +124,7 @@ class ObjectChooser(object):
parent (:class:`Gtk.Widget`): the widget calling ObjectChooser parent (:class:`Gtk.Widget`): the widget calling ObjectChooser
what_filter (str): an activity bundle_id or a generic mime type as what_filter (str): an activity bundle_id or a generic mime type as
defined in mime.py used to determine which objects defined in :mod:`sugar3.mime` used to determine which objects
will be presented in the object chooser will be presented in the object chooser
filter_type (str): should be one of [None, FILTER_TYPE_GENERIC_MIME, filter_type (str): should be one of [None, FILTER_TYPE_GENERIC_MIME,