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

API docstrings from pydocweb

Browse Source
This commit is contained in:
David Farning 2008-09-21 09:01:48 -05:00
parent 3a69d3e777
commit 88295072bd
2 changed files with 255 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
src/sugar/graphics/alert.py
View File

@ -314,9 +314,43 @@ class _TimeoutIcon(hippo.CanvasText, hippo.CanvasItem):
class TimeoutAlert(Alert):
"""This is a ready-made two button (Cancel,Continue) alert
"""
This is a ready-made two button (Cancel,Continue) alert
It times out with a positive response after the given amount of seconds.
Examples
--------
.. code-block:: python
from sugar.graphics.alert import TimeoutAlert
...
#### Method: _alert_timeout, create a Timeout alert (with ok and cancel buttons standard)
# and add it to the UI.
def _alert_timeout(self):
#Notice that for a TimeoutAlert, you pass the number of seconds in which to timeout. By
#default, this is 5.
alert = TimeoutAlert(10)
alert.props.title=_('Title of Alert Goes Here')
alert.props.msg = _('Text message of timeout alert goes here')
alert.connect('response', self._alert_response_cb)
self.add_alert(alert)
#### Method: _alert_response_cb, called when an alert object throws a response event.
def _alert_response_cb(self, alert, response_id):
#remove the alert from the screen, since either a response button was clicked or
#there was a timeout
self.remove_alert(alert)
#Do any work that is specific to the type of button clicked.
if response_id is gtk.RESPONSE_OK:
print 'Ok Button was clicked. Do any work upon ok here ...'
elif response_id is gtk.RESPONSE_CANCEL:
print 'Cancel Button was clicked.'
elif response_id == -1:
print 'Timout occurred'
It times out with a positive reponse after the given amount of seconds.
"""
def __init__(self, timeout=5, **kwargs):
@ -349,7 +383,27 @@ class TimeoutAlert(Alert):
class NotifyAlert(Alert):
"""Timeout alert with only an "OK" button - just for notifications"""
"""
Timeout alert with only an "OK" button - just for notifications
Examples
--------
.. code-block:: python
from sugar.graphics.alert import NotifyAlert
...
#### Method: _alert_notify, create a Notify alert (with only an 'OK' button)
# and add it to the UI.
def _alert_notify(self):
#Notice that for a NotifyAlert, you pass the number of seconds in which to notify. By
#default, this is 5.
alert = NotifyAlert(10)
alert.props.title=_('Title of Alert Goes Here')
alert.props.msg = _('Text message of notify alert goes here')
alert.connect('response', self._alert_response_cb)
self.add_alert(alert)
"""
def __init__(self, timeout=5, **kwargs):
Alert.__init__(self, **kwargs)

198
src/sugar/graphics/icon.py
View File

@ -1,3 +1,7 @@
"""
A small fixed size picture, typically used to decorate components.
"""
# Copyright (C) 2006-2007 Red Hat, Inc.
#
# This library is free software; you can redistribute it and/or
@ -498,28 +502,80 @@ class CanvasIcon(hippo.CanvasBox, hippo.CanvasItem):
self._palette_invoker.detach()
def set_file_name(self, value):
"""
Parameters
----------
value:
Returns
-------
None
\"\"\"
"""
if self._buffer.file_name != value:
self._buffer.file_name = value
self.emit_paint_needed(0, 0, -1, -1)
def get_file_name(self):
"""
Parameters
----------
None
Returns
-------
file name :
"""
return self._buffer.file_name
file_name = gobject.property(
type=str, getter=get_file_name, setter=set_file_name)
def set_icon_name(self, value):
"""
Parameters
----------
value:
Returns
-------
None
"""
if self._buffer.icon_name != value:
self._buffer.icon_name = value
self.emit_paint_needed(0, 0, -1, -1)
def get_icon_name(self):
"""
Parameters
----------
None
Returns
-------
icon name :
"""
return self._buffer.icon_name
icon_name = gobject.property(
type=str, getter=get_icon_name, setter=set_icon_name)
def set_xo_color(self, value):
"""
Parameters
----------
value:
Returns
-------
None
"""
if self._buffer.xo_color != value:
self._buffer.xo_color = value
self.emit_paint_needed(0, 0, -1, -1)
@ -528,40 +584,110 @@ class CanvasIcon(hippo.CanvasBox, hippo.CanvasItem):
type=object, getter=None, setter=set_xo_color)
def set_fill_color(self, value):
"""
Parameters
----------
value:
Returns
-------
None
"""
if self._buffer.fill_color != value:
self._buffer.fill_color = value
self.emit_paint_needed(0, 0, -1, -1)
def get_fill_color(self):
"""
Parameters
----------
None
Returns
-------
fill color :
"""
return self._buffer.fill_color
fill_color = gobject.property(
type=object, getter=get_fill_color, setter=set_fill_color)
def set_stroke_color(self, value):
"""
Parameters
----------
value:
Returns
-------
None
"""
if self._buffer.stroke_color != value:
self._buffer.stroke_color = value
self.emit_paint_needed(0, 0, -1, -1)
def get_stroke_color(self):
"""
Parameters
----------
None
Returns
-------
stroke color :
"""
return self._buffer.stroke_color
stroke_color = gobject.property(
type=object, getter=get_stroke_color, setter=set_stroke_color)
def set_size(self, value):
"""
Parameters
----------
value:
Returns
-------
None
"""
if self._buffer.width != value:
self._buffer.width = value
self._buffer.height = value
self.emit_request_changed()
def get_size(self):
"""
Parameters
----------
None
Returns
-------
size :
"""
return self._buffer.width
size = gobject.property(
type=int, getter=get_size, setter=set_size)
def set_scale(self, value):
"""
Parameters
----------
value:
Returns
-------
None
"""
logging.warning(
'CanvasIcon: the scale parameter is currently unsupported')
if self._buffer.scale != value:
@ -569,32 +695,94 @@ class CanvasIcon(hippo.CanvasBox, hippo.CanvasItem):
self.emit_request_changed()
def get_scale(self):
"""
Parameters
----------
None
Returns
-------
scale :
"""
return self._buffer.scale
scale = gobject.property(
type=float, getter=get_scale, setter=set_scale)
def set_cache(self, value):
"""
Parameters
----------
cache
Returns
-------
None
"""
self._buffer.cache = value
def get_cache(self):
"""
Parameters
----------
None
Returns
-------
cache :
"""
return self._buffer.cache
cache = gobject.property(
type=bool, default=False, getter=get_cache, setter=set_cache)
def set_badge_name(self, value):
"""
Parameters
----------
value :
Returns
-------
None
"""
if self._buffer.badge_name != value:
self._buffer.badge_name = value
self.emit_paint_needed(0, 0, -1, -1)
def get_badge_name(self):
"""
Parameters
----------
None
Returns
-------
badge name :
"""
return self._buffer.badge_name
badge_name = gobject.property(
type=str, getter=get_badge_name, setter=set_badge_name)
def do_paint_below_children(self, cr, damaged_box):
"""
Parameters
----------
cr :
damaged_box :
Returns
-------
None
"""
surface = self._buffer.get_surface()
if surface:
width, height = self.get_allocation()
@ -606,6 +794,16 @@ class CanvasIcon(hippo.CanvasBox, hippo.CanvasItem):
cr.paint()
def do_get_content_width_request(self):
"""
Parameters
----------
None
Returns
-------
width :
"""
surface = self._buffer.get_surface()
if surface:
size = surface.get_width()