sugar-toolkit-gtk3/src/sugar3/graphics/alert.py

469 lines
16 KiB
Python
Raw Normal View History

2008-09-21 04:22:56 +02:00
"""
Alerts appear at the top of the body of your activity.
At a high level, Alert and its different variations (TimeoutAlert,
ConfirmationAlert, etc.) have a title, an alert message and then several
buttons that the user can click. The Alert class will pass "response" events
to your activity when any of these buttons are clicked, along with a
response_id to help you identify what button was clicked.
Example:
Create a simple alert message.
2008-09-21 04:22:56 +02:00
.. code-block:: python
from sugar3.graphics.alert import Alert
2008-09-21 04:22:56 +02:00
# Create a new simple alert
2008-09-21 04:22:56 +02:00
alert = Alert()
# Populate the title and text body of the alert.
alert.props.title = _('Title of Alert Goes Here')
2008-09-21 04:22:56 +02:00
alert.props.msg = _('Text message of alert goes here')
# Call the add_alert() method (inherited via the sugar3.graphics.Window
2008-09-22 10:55:05 +02:00
# superclass of Activity) to add this alert to the activity window.
2008-09-21 04:22:56 +02:00
self.add_alert(alert)
alert.show()
STABLE.
2008-09-21 04:22:56 +02:00
"""
# Copyright (C) 2007, One Laptop Per Child
# Copyright (C) 2010, Anish Mangal <anishmangal2002@gmail.com>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.
2008-02-09 12:27:22 +01:00
import gettext
from gi.repository import Gtk
from gi.repository import GObject
from gi.repository import GLib
import math
from sugar3.graphics import style
from sugar3.graphics.icon import Icon
_ = lambda msg: gettext.dgettext('sugar-toolkit-gtk3', msg)
2009-08-25 21:12:40 +02:00
class Alert(Gtk.EventBox):
2008-09-21 04:22:56 +02:00
"""
UI interface for Alerts
Alerts are used inside the activity window instead of being a
separate popup window. They do not hide canvas content. You can
use `add_alert()` and `remove_alert()` inside your activity
to add and remove the alert. The position of the alert is below the
toolbox or top in fullscreen mode.
Args:
title (str): the title of the alert
message (str): the message of the alert
icon (str): the icon that appears at the far left
"""
__gtype_name__ = 'SugarAlert'
__gsignals__ = {
'response': (GObject.SignalFlags.RUN_FIRST, None, ([object])),
2009-08-25 21:12:40 +02:00
}
__gproperties__ = {
'title': (str, None, None, None, GObject.PARAM_READWRITE),
'msg': (str, None, None, None, GObject.PARAM_READWRITE),
'icon': (object, None, None, GObject.PARAM_WRITABLE),
2009-08-25 21:12:40 +02:00
}
def __init__(self, **kwargs):
self._title = None
self._msg = None
self._icon = None
self._buttons = {}
self._hbox = Gtk.HBox()
self._hbox.set_border_width(style.DEFAULT_SPACING)
self._hbox.set_spacing(style.DEFAULT_SPACING)
self._msg_box = Gtk.VBox()
self._title_label = Gtk.Label()
self._title_label.set_alignment(0, 0.5)
self._msg_box.pack_start(self._title_label, False, False, 0)
self._msg_label = Gtk.Label()
self._msg_label.set_alignment(0, 0.5)
self._msg_box.pack_start(self._msg_label, False, False, 0)
self._hbox.pack_start(self._msg_box, False, False, 0)
self._buttons_box = Gtk.HButtonBox()
self._buttons_box.set_layout(Gtk.ButtonBoxStyle.END)
self._buttons_box.set_spacing(style.DEFAULT_SPACING)
self._hbox.pack_start(self._buttons_box, True, True, 0)
GObject.GObject.__init__(self, **kwargs)
self.set_visible_window(True)
self.add(self._hbox)
self._title_label.show()
self._msg_label.show()
self._buttons_box.show()
self._msg_box.show()
self._hbox.show()
self.show()
def do_set_property(self, pspec, value):
2008-09-16 16:10:36 +02:00
"""
Set alert property, GObject internal method.
Use the `alert.props` object, eg::
2008-09-16 16:10:36 +02:00
alert.props.title = 'Are you happy?'
2008-09-16 16:10:36 +02:00
"""
if pspec.name == 'title':
if self._title != value:
self._title = value
self._title_label.set_markup('<b>' + self._title + '</b>')
elif pspec.name == 'msg':
if self._msg != value:
self._msg = value
self._msg_label.set_markup(self._msg)
2008-08-14 21:31:42 +02:00
self._msg_label.set_line_wrap(True)
elif pspec.name == 'icon':
if self._icon != value:
self._icon = value
self._hbox.pack_start(self._icon, False, False, 0)
self._hbox.reorder_child(self._icon, 0)
def do_get_property(self, pspec):
2008-09-16 16:10:36 +02:00
"""
Set alert property, GObject internal method.
Use the `alert.props` object, eg::
2008-09-16 16:10:36 +02:00
title = alert.props.title
2008-09-16 16:10:36 +02:00
"""
if pspec.name == 'title':
return self._title
elif pspec.name == 'msg':
return self._msg
def add_button(self, response_id, label, icon=None, position=-1):
2008-09-16 16:10:36 +02:00
"""
Add a button to the alert
Args:
response_id (int): will be emitted with the response signal a
response ID should one of the pre-defined GTK Response Type
Constants or a positive number
label (str): that will occure right to the buttom
icon (:class:`sugar3.graphics.icon.Icon` or :class:`Gtk.Image`, optional):
icon for the button, placed before the text
postion (int, optional): the position of the button in the box
2008-09-16 16:10:36 +02:00
Returns:
Gtk.Button: the button added to the alert
2008-09-16 16:10:36 +02:00
"""
button = Gtk.Button()
self._buttons[response_id] = button
if icon is not None:
button.set_image(icon)
button.set_label(label)
self._buttons_box.pack_start(button, True, True, 0)
button.show()
button.connect('clicked', self.__button_clicked_cb, response_id)
if position != -1:
self._buttons_box.reorder_child(button, position)
return button
def remove_button(self, response_id):
2008-09-16 16:10:36 +02:00
"""
Remove a button from the alert by the given response id
Args:
response_id (int): the same response id passed to add_button
2008-09-16 16:10:36 +02:00
Returns:
None
2008-09-16 16:10:36 +02:00
"""
self._buttons_box.remove(self._buttons[response_id])
def _response(self, response_id):
"""
Emitting response when we have a result
A result can be that a user has clicked a button or
a timeout has occured, the id identifies the button
that has been clicked and -1 for a timeout
"""
self.emit('response', response_id)
def __button_clicked_cb(self, button, response_id):
self._response(response_id)
class ConfirmationAlert(Alert):
2008-09-21 04:22:56 +02:00
"""
This is a ready-made two button (Cancel, Ok) alert.
2008-09-21 04:22:56 +02:00
A confirmation alert is a nice shortcut from a standard Alert because it
comes with 'OK' and 'Cancel' buttons already built-in. When clicked, the
'OK' button will emit a response with a response_id of
:class:`Gtk.ResponseType.OK`, while the 'Cancel' button will emit
:class:`Gtk.ResponseType.CANCEL`.
2008-09-21 04:22:56 +02:00
Args:
**kwargs: options for :class:`sugar3.graphics.alert.Alert`
2008-09-21 04:22:56 +02:00
.. code-block:: python
from sugar3.graphics.alert import ConfirmationAlert
# Create a Confirmation alert (with ok and cancel buttons standard)
# then add it to the UI.
2008-09-21 04:22:56 +02:00
def _alert_confirmation(self):
alert = ConfirmationAlert()
alert.props.title=_('Title of Alert Goes Here')
alert.props.msg = _('Text message of alert goes here')
alert.connect('response', self._alert_response_cb)
self.add_alert(alert)
# Called when an alert object throws a response event.
2008-09-21 04:22:56 +02:00
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
2008-09-21 04:22:56 +02:00
self.remove_alert(alert)
# Do any work that is specific to the type of button clicked.
if response_id is Gtk.ResponseType.OK:
2008-09-21 04:22:56 +02:00
print 'Ok Button was clicked. Do any work upon ok here ...'
elif response_id is Gtk.ResponseType.CANCEL:
2008-09-21 04:22:56 +02:00
print 'Cancel Button was clicked.'
"""
def __init__(self, **kwargs):
Alert.__init__(self, **kwargs)
icon = Icon(icon_name='dialog-cancel')
self.add_button(Gtk.ResponseType.CANCEL, _('Cancel'), icon)
icon.show()
icon = Icon(icon_name='dialog-ok')
self.add_button(Gtk.ResponseType.OK, _('Ok'), icon)
icon.show()
class ErrorAlert(Alert):
"""
This is a ready-made one button (Ok) alert.
An error alert is a nice shortcut from a standard Alert because it
comes with the 'OK' button already built-in. When clicked, the
'OK' button will emit a response with a response_id of
:class:`Gtk.ResponseType.OK`.
Args:
**kwargs: options for :class:`sugar3.graphics.alert.Alert`
.. code-block:: python
from sugar3.graphics.alert import ErrorAlert
# Create a Error alert (with ok button standard)
# and add it to the UI.
def _alert_error(self):
alert = ErrorAlert()
alert.props.title=_('Title of Alert Goes Here')
alert.props.msg = _('Text message of alert goes here')
alert.connect('response', self._alert_response_cb)
self.add_alert(alert)
# 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 response_id.
if response_id is Gtk.ResponseType.OK:
print 'Ok Button was clicked. Do any work upon ok here'
"""
def __init__(self, **kwargs):
Alert.__init__(self, **kwargs)
icon = Icon(icon_name='dialog-ok')
self.add_button(Gtk.ResponseType.OK, _('Ok'), icon)
icon.show()
class _TimeoutIcon(Gtk.Alignment):
__gtype_name__ = 'SugarTimeoutIcon'
def __init__(self):
Gtk.Alignment.__init__(self, xalign=0, yalign=0, xscale=1, yscale=1)
self.set_app_paintable(True)
self._text = Gtk.Label()
self._text.set_alignment(0.5, 0.5)
self.add(self._text)
self._text.show()
self.connect('draw', self.__draw_cb)
def __draw_cb(self, widget, context):
self._draw(context)
return False
def do_get_preferred_width(self):
width = Gtk.icon_size_lookup(Gtk.IconSize.BUTTON)[1]
return width, width
def do_get_preferred_height(self):
height = Gtk.icon_size_lookup(Gtk.IconSize.BUTTON)[2]
return height, height
def _draw(self, context):
w = self.get_allocated_width()
h = self.get_allocated_height()
x = w * 0.5
y = h * 0.5
radius = w / 2
context.arc(x, y, radius, 0, 2 * math.pi)
widget_style = self.get_style_context()
color = widget_style.get_background_color(self.get_state_flags())
context.set_source_rgb(color.red, color.green, color.blue)
context.fill_preserve()
def set_text(self, text):
self._text.set_markup('<b>%s</b>' % GLib.markup_escape_text(str(text)))
class TimeoutAlert(Alert):
2008-09-21 16:01:48 +02:00
"""
This is a ready-made two button (Cancel, Continue) alert. The continue
button contains a visual countdown indicating the time remaining to the
user. If the user does not select a button before the timeout, the
response callback is called and the alert is usually removed.
2008-09-21 16:01:48 +02:00
Args:
timeout (int, optional): the length in seconds for the timeout to
last, defaults to 5 seconds
**kwargs: options for :class:`sugar3.graphics.alert.Alert`
2008-09-21 16:01:48 +02:00
.. code-block:: python
2008-09-21 16:01:48 +02:00
from sugar3.graphics.alert import TimeoutAlert
2008-09-21 16:01:48 +02:00
# Create a Timeout alert (with ok and cancel buttons standard) then
# add it to the UI
2008-09-21 16:01:48 +02:00
def _alert_timeout(self):
# Notice that for a TimeoutAlert, you pass the number of seconds
# in which to timeout. By default, this is 5.
2008-09-21 16:01:48 +02:00
alert = TimeoutAlert(10)
alert.props.title = _('Title of Alert Goes Here')
2008-09-21 16:01:48 +02:00
alert.props.msg = _('Text message of timeout alert goes here')
alert.connect('response', self.__alert_response_cb)
2008-09-21 16:01:48 +02:00
self.add_alert(alert)
# 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
2008-09-21 16:01:48 +02:00
self.remove_alert(alert)
# Do any work that is specific to the type of button clicked.
if response_id is Gtk.ResponseType.OK:
2008-09-21 16:01:48 +02:00
print 'Ok Button was clicked. Do any work upon ok here ...'
elif response_id is Gtk.ResponseType.CANCEL:
2008-09-21 16:01:48 +02:00
print 'Cancel Button was clicked.'
elif response_id == -1:
print 'Timout occurred'
"""
def __init__(self, timeout=5, **kwargs):
Alert.__init__(self, **kwargs)
self._timeout = timeout
icon = Icon(icon_name='dialog-cancel')
self.add_button(Gtk.ResponseType.CANCEL, _('Cancel'), icon)
icon.show()
self._timeout_text = _TimeoutIcon()
self._timeout_text.set_text(self._timeout)
self.add_button(Gtk.ResponseType.OK, _('Continue'), self._timeout_text)
self._timeout_text.show()
self._timeout_sid = GLib.timeout_add(1000, self.__timeout)
def __timeout(self):
self._timeout -= 1
self._timeout_text.set_text(self._timeout)
if self._timeout == 0:
Alert._response(self, Gtk.ResponseType.OK)
return False
return True
def _response(self, *args):
GLib.source_remove(self._timeout_sid)
Alert._response(self, *args)
class NotifyAlert(Alert):
2008-09-21 16:01:48 +02:00
"""
Timeout alert with only an "OK" button. This should be used just for
notifications and not for user interaction. The alert will timeout after
a given length, simmilar to a :class:`sugar3.graphics.alert.TimeoutAlert`.
2008-09-21 16:01:48 +02:00
Args:
timeout (int, optional): the length in seconds for the timeout to
last, defaults to 5 seconds
**kwargs: options for :class:`sugar3.graphics.alert.Alert`
2008-09-21 16:01:48 +02:00
.. code-block:: python
from sugar3.graphics.alert import NotifyAlert
# create a Notify alert (with only an 'OK' button) then show it
2008-09-21 16:01:48 +02:00
def _alert_notify(self):
alert = NotifyAlert()
alert.props.title = _('Title of Alert Goes Here')
2008-09-21 16:01:48 +02:00
alert.props.msg = _('Text message of notify alert goes here')
alert.connect('response', self._alert_response_cb)
self.add_alert(alert)
def __alert_response_cb(self, alert, response_id):
# Hide the alert from the user
self.remove_alert(alert)
assert response_id == Gtk.ResponseType.OK
2008-09-21 16:01:48 +02:00
"""
def __init__(self, timeout=5, **kwargs):
Alert.__init__(self, **kwargs)
self._timeout = timeout
self._timeout_text = _TimeoutIcon()
self._timeout_text.set_text(self._timeout)
self.add_button(Gtk.ResponseType.OK, _('Ok'), self._timeout_text)
self._timeout_text.show()
GLib.timeout_add(1000, self.__timeout)
def __timeout(self):
self._timeout -= 1
self._timeout_text.set_text(self._timeout)
if self._timeout == 0:
self._response(Gtk.ResponseType.OK)
return False
return True