827ab7218a
CanvasIcon and CanvasInvoker were removed in a previous GTK3-porting commit as they were based on hippocanvas. However, this leaves the toolkit with some missing functionality: there is no longer a trivial way to show an icon which can receive mouse events and pop up a palette. Such functionality is used in various places throughout the shell and activities. Reimplement this functionality as EventIcon and CursorInvoker. Instead of reimplementing much of the Icon class (like CanvasIcon did), EventIcon opts for a more simplistic encapsulation of an Icon object. This means trivial API changes for CanvasIcon users who must now use the 'icon' property with the Icon API. Signed-off-by: Daniel Drake <dsd@laptop.org> Acked-by: Simon Schampijer <simon@laptop.org>
447 lines
14 KiB
Python
447 lines
14 KiB
Python
# Copyright (C) 2007, Eduardo Silva <edsiper@gmail.com>
|
|
# Copyright (C) 2008, One Laptop Per Child
|
|
# Copyright (C) 2009, Tomeu Vizoso
|
|
#
|
|
# 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.
|
|
|
|
"""
|
|
STABLE.
|
|
"""
|
|
|
|
from gi.repository import Gtk
|
|
from gi.repository import GObject
|
|
from gi.repository import Pango
|
|
|
|
from sugar3.graphics import palettegroup
|
|
from sugar3.graphics import animator
|
|
from sugar3.graphics import style
|
|
from sugar3.graphics.icon import Icon
|
|
from sugar3.graphics.palettewindow import PaletteWindow
|
|
from gi.repository import SugarExt
|
|
|
|
# DEPRECATED
|
|
# Import these for backwards compatibility
|
|
from sugar3.graphics.palettewindow import MouseSpeedDetector, Invoker, \
|
|
WidgetInvoker, CursorInvoker, ToolInvoker, CellRendererInvoker
|
|
|
|
|
|
class Palette(PaletteWindow):
|
|
PRIMARY = 0
|
|
SECONDARY = 1
|
|
|
|
__gtype_name__ = 'SugarPalette'
|
|
|
|
def __init__(self, label=None, accel_path=None, menu_after_content=False,
|
|
text_maxlen=60, **kwargs):
|
|
# DEPRECATED: label is passed with the primary-text property,
|
|
# accel_path is set via the invoker property, and menu_after_content
|
|
# is not used
|
|
|
|
self._primary_text = None
|
|
self._secondary_text = None
|
|
self._icon = None
|
|
self._icon_visible = True
|
|
self._palette_state = self.PRIMARY
|
|
|
|
palette_box = Gtk.VBox()
|
|
|
|
primary_box = Gtk.HBox()
|
|
palette_box.pack_start(primary_box, False, True, 0)
|
|
primary_box.show()
|
|
|
|
self._icon_box = Gtk.HBox()
|
|
self._icon_box.set_size_request(style.GRID_CELL_SIZE, -1)
|
|
primary_box.pack_start(self._icon_box, False, True, 0)
|
|
|
|
labels_box = Gtk.VBox()
|
|
self._label_alignment = Gtk.Alignment(xalign=0, yalign=0.5, xscale=1,
|
|
yscale=0.33)
|
|
self._label_alignment.set_padding(0, 0, style.DEFAULT_SPACING,
|
|
style.DEFAULT_SPACING)
|
|
self._label_alignment.add(labels_box)
|
|
self._label_alignment.show()
|
|
primary_box.pack_start(self._label_alignment, True, True, 0)
|
|
labels_box.show()
|
|
|
|
self._label = Gtk.AccelLabel(label='')
|
|
self._label.set_alignment(0, 0.5)
|
|
|
|
if text_maxlen > 0:
|
|
self._label.set_max_width_chars(text_maxlen)
|
|
self._label.set_ellipsize(Pango.EllipsizeMode.MIDDLE)
|
|
labels_box.pack_start(self._label, True, True, 0)
|
|
|
|
self._secondary_label = Gtk.Label()
|
|
self._secondary_label.set_alignment(0, 0.5)
|
|
|
|
if text_maxlen > 0:
|
|
self._secondary_label.set_max_width_chars(text_maxlen)
|
|
self._secondary_label.set_ellipsize(Pango.EllipsizeMode.END)
|
|
|
|
labels_box.pack_start(self._secondary_label, True, True, 0)
|
|
|
|
self._secondary_box = Gtk.VBox()
|
|
palette_box.pack_start(self._secondary_box, True, True, 0)
|
|
|
|
self._separator = Gtk.HSeparator()
|
|
self._secondary_box.pack_start(self._separator, True, True, 0)
|
|
|
|
self._menu_content_separator = Gtk.HSeparator()
|
|
|
|
self._secondary_anim = animator.Animator(2.0, 10)
|
|
self._secondary_anim.add(_SecondaryAnimation(self))
|
|
|
|
# we init after initializing all of our containers
|
|
PaletteWindow.__init__(self, **kwargs)
|
|
|
|
primary_box.set_size_request(-1, style.GRID_CELL_SIZE
|
|
- 2 * self.get_border_width())
|
|
|
|
self._full_request = [0, 0]
|
|
self._menu_box = None
|
|
self._content = None
|
|
|
|
# we set these for backward compatibility
|
|
if label is not None:
|
|
self.props.primary_text = label
|
|
|
|
self._add_menu()
|
|
self._secondary_box.pack_start(self._menu_content_separator, True, True, 0)
|
|
self._add_content()
|
|
|
|
self.action_bar = PaletteActionBar()
|
|
self._secondary_box.pack_start(self.action_bar, True, True, 0)
|
|
self.action_bar.show()
|
|
|
|
self.add(palette_box)
|
|
palette_box.show()
|
|
|
|
# The menu is not shown here until an item is added
|
|
self.menu = _Menu(self)
|
|
self.menu.connect('item-inserted', self.__menu_item_inserted_cb)
|
|
|
|
self.connect('realize', self.__realize_cb)
|
|
self.connect('show', self.__show_cb)
|
|
self.connect('hide', self.__hide_cb)
|
|
self.connect('notify::invoker', self.__notify_invoker_cb)
|
|
self.connect('destroy', self.__destroy_cb)
|
|
|
|
def _invoker_right_click_cb(self, invoker):
|
|
self.popup(immediate=True, state=self.SECONDARY)
|
|
|
|
def do_style_set(self, previous_style):
|
|
# Prevent a warning from pygtk
|
|
if previous_style is not None:
|
|
Gtk.Window.do_style_set(self, previous_style)
|
|
self.set_border_width(self.get_style().xthickness)
|
|
|
|
def __menu_item_inserted_cb(self, menu):
|
|
self._update_separators()
|
|
|
|
def __destroy_cb(self, palette):
|
|
self._secondary_anim.stop()
|
|
self.popdown(immediate=True)
|
|
# Break the reference cycle. It looks like the gc is not able to free
|
|
# it, possibly because Gtk.Menu memory handling is very special.
|
|
self.menu.disconnect_by_func(self.__menu_item_inserted_cb)
|
|
self.menu = None
|
|
|
|
def __show_cb(self, widget):
|
|
self.menu.set_active(True)
|
|
|
|
def __hide_cb(self, widget):
|
|
self.menu.set_active(False)
|
|
self.menu.cancel()
|
|
self._secondary_anim.stop()
|
|
|
|
def __notify_invoker_cb(self, palette, pspec):
|
|
invoker = self.props.invoker
|
|
if invoker is not None and hasattr(invoker.props, 'widget'):
|
|
self._update_accel_widget()
|
|
self._invoker.connect('notify::widget',
|
|
self.__invoker_widget_changed_cb)
|
|
|
|
def __invoker_widget_changed_cb(self, invoker, spec):
|
|
self._update_accel_widget()
|
|
|
|
def get_full_size_request(self):
|
|
return self._full_request
|
|
|
|
def popup(self, immediate=False, state=None):
|
|
if self._invoker is not None:
|
|
self._update_full_request()
|
|
|
|
PaletteWindow.popup(self, immediate)
|
|
|
|
if state is None:
|
|
state = self.PRIMARY
|
|
self.set_palette_state(state)
|
|
|
|
if state == self.PRIMARY:
|
|
self._secondary_anim.start()
|
|
else:
|
|
self._secondary_anim.stop()
|
|
|
|
def popdown(self, immediate=False):
|
|
if immediate:
|
|
self._secondary_anim.stop()
|
|
self._popdown_submenus()
|
|
# to suppress glitches while later re-opening
|
|
self.set_palette_state(self.PRIMARY)
|
|
PaletteWindow.popdown(self, immediate)
|
|
|
|
def _popdown_submenus(self):
|
|
# TODO explicit hiding of subitems
|
|
# should be removed after fixing #1301
|
|
if self.menu is not None:
|
|
for menu_item in self.menu.get_children():
|
|
if menu_item.props.submenu is not None:
|
|
menu_item.props.submenu.popdown()
|
|
|
|
def on_enter(self, event):
|
|
PaletteWindow.on_enter(self, event)
|
|
self._secondary_anim.start()
|
|
|
|
def _add_menu(self):
|
|
self._menu_box = Gtk.VBox()
|
|
self._secondary_box.pack_start(self._menu_box, True, True, 0)
|
|
self._menu_box.show()
|
|
|
|
def _add_content(self):
|
|
# The content is not shown until a widget is added
|
|
self._content = Gtk.VBox()
|
|
self._content.set_border_width(style.DEFAULT_SPACING)
|
|
self._secondary_box.pack_start(self._content, True, True, 0)
|
|
|
|
def _update_accel_widget(self):
|
|
assert self.props.invoker is not None
|
|
self._label.props.accel_widget = self.props.invoker.props.widget
|
|
|
|
def set_primary_text(self, label, accel_path=None):
|
|
self._primary_text = label
|
|
|
|
if label is not None:
|
|
self._label.set_markup('<b>%s</b>' % label)
|
|
self._label.show()
|
|
|
|
def get_primary_text(self):
|
|
return self._primary_text
|
|
|
|
primary_text = GObject.property(type=str,
|
|
getter=get_primary_text,
|
|
setter=set_primary_text)
|
|
|
|
def set_secondary_text(self, label):
|
|
if label is not None:
|
|
label = label.split('\n', 1)[0]
|
|
self._secondary_text = label
|
|
|
|
if label is None:
|
|
self._secondary_label.hide()
|
|
else:
|
|
self._secondary_label.set_text(label)
|
|
self._secondary_label.show()
|
|
|
|
def get_secondary_text(self):
|
|
return self._secondary_text
|
|
|
|
secondary_text = GObject.property(type=str, getter=get_secondary_text,
|
|
setter=set_secondary_text)
|
|
|
|
def _show_icon(self):
|
|
self._label_alignment.set_padding(0, 0, 0, style.DEFAULT_SPACING)
|
|
self._icon_box.show()
|
|
|
|
def _hide_icon(self):
|
|
self._icon_box.hide()
|
|
self._label_alignment.set_padding(0, 0, style.DEFAULT_SPACING,
|
|
style.DEFAULT_SPACING)
|
|
|
|
def set_icon(self, icon):
|
|
if icon is None:
|
|
self._icon = None
|
|
self._hide_icon()
|
|
else:
|
|
if self._icon:
|
|
self._icon_box.remove(self._icon_box.get_children()[0])
|
|
|
|
event_box = Gtk.EventBox()
|
|
event_box.connect('button-release-event',
|
|
self.__icon_button_release_event_cb)
|
|
self._icon_box.pack_start(event_box, True, True, 0)
|
|
event_box.show()
|
|
|
|
self._icon = icon
|
|
self._icon.props.icon_size = Gtk.IconSize.LARGE_TOOLBAR
|
|
event_box.add(self._icon)
|
|
self._icon.show()
|
|
self._show_icon()
|
|
|
|
def get_icon(self):
|
|
return self._icon
|
|
|
|
icon = GObject.property(type=object, getter=get_icon, setter=set_icon)
|
|
|
|
def __icon_button_release_event_cb(self, icon, event):
|
|
self.emit('activate')
|
|
|
|
def set_icon_visible(self, visible):
|
|
self._icon_visible = visible
|
|
|
|
if visible and self._icon is not None:
|
|
self._show_icon()
|
|
else:
|
|
self._hide_icon()
|
|
|
|
def get_icon_visible(self):
|
|
return self._icon_visilbe
|
|
|
|
icon_visible = GObject.property(type=bool,
|
|
default=True,
|
|
getter=get_icon_visible,
|
|
setter=set_icon_visible)
|
|
|
|
def set_content(self, widget):
|
|
if self._content.get_children():
|
|
self._content.remove(self._content.get_children()[0])
|
|
|
|
if widget is not None:
|
|
self._content.add(widget)
|
|
self._content.show()
|
|
else:
|
|
self._content.hide()
|
|
|
|
self._update_accept_focus()
|
|
self._update_separators()
|
|
|
|
def do_size_request(self, requisition):
|
|
PaletteWindow.do_size_request(self, requisition)
|
|
|
|
# Gtk.AccelLabel request doesn't include the accelerator.
|
|
label_width = self._label_alignment.size_request()[0] + \
|
|
self._label.get_accel_width() + \
|
|
2 * self.get_border_width()
|
|
|
|
requisition.width = max(requisition.width,
|
|
label_width,
|
|
self._full_request[0])
|
|
|
|
def _update_separators(self):
|
|
visible = self.menu.get_children() or \
|
|
self._content.get_children()
|
|
self._separator.props.visible = visible
|
|
|
|
visible = self.menu.get_children() and \
|
|
self._content.get_children()
|
|
self._menu_content_separator.props.visible = visible
|
|
|
|
def _update_accept_focus(self):
|
|
accept_focus = len(self._content.get_children())
|
|
window = self.get_window()
|
|
if window:
|
|
window.set_accept_focus(accept_focus)
|
|
|
|
def __realize_cb(self, widget):
|
|
self._update_accept_focus()
|
|
|
|
def _update_full_request(self):
|
|
if self._palette_state == self.PRIMARY:
|
|
self.menu.embed(self._menu_box)
|
|
self._secondary_box.show()
|
|
|
|
self._full_request = self.size_request()
|
|
|
|
if self._palette_state == self.PRIMARY:
|
|
self.menu.unembed()
|
|
self._secondary_box.hide()
|
|
|
|
def _set_palette_state(self, state):
|
|
if self._palette_state == state:
|
|
return
|
|
|
|
if state == self.PRIMARY:
|
|
self.menu.unembed()
|
|
self._secondary_box.hide()
|
|
elif state == self.SECONDARY:
|
|
self.menu.embed(self._menu_box)
|
|
self._secondary_box.show()
|
|
self.update_position()
|
|
|
|
self._palette_state = state
|
|
|
|
|
|
class PaletteActionBar(Gtk.HButtonBox):
|
|
|
|
def add_action(self, label, icon_name=None):
|
|
button = Gtk.Button(label)
|
|
|
|
if icon_name:
|
|
icon = Icon(icon_name)
|
|
button.set_image(icon)
|
|
icon.show()
|
|
|
|
self.pack_start(button, True, True, 0)
|
|
button.show()
|
|
|
|
|
|
class _Menu(SugarExt.Menu):
|
|
|
|
__gtype_name__ = 'SugarPaletteMenu'
|
|
|
|
__gsignals__ = {
|
|
'item-inserted': (GObject.SignalFlags.RUN_FIRST, None, ([])),
|
|
}
|
|
|
|
def __init__(self, palette):
|
|
SugarExt.Menu.__init__(self)
|
|
self._palette = palette
|
|
|
|
def do_insert(self, item, position):
|
|
SugarExt.Menu.do_insert(self, item, position)
|
|
self.emit('item-inserted')
|
|
self.show()
|
|
|
|
def attach(self, child, left_attach, right_attach,
|
|
top_attach, bottom_attach):
|
|
SugarExt.Menu.attach(self, child, left_attach, right_attach,
|
|
top_attach, bottom_attach)
|
|
self.emit('item-inserted')
|
|
self.show()
|
|
|
|
def do_expose_event(self, event):
|
|
# Ignore the Menu expose, just do the MenuShell expose to prevent any
|
|
# border from being drawn here. A border is drawn by the palette object
|
|
# around everything.
|
|
Gtk.MenuShell.do_expose_event(self, event)
|
|
|
|
def do_grab_notify(self, was_grabbed):
|
|
# Ignore grab_notify as the menu would close otherwise
|
|
pass
|
|
|
|
def do_deactivate(self):
|
|
self._palette.hide()
|
|
|
|
|
|
class _SecondaryAnimation(animator.Animation):
|
|
|
|
def __init__(self, palette):
|
|
animator.Animation.__init__(self, 0.0, 1.0)
|
|
self._palette = palette
|
|
|
|
def next_frame(self, current):
|
|
if current == 1.0:
|
|
self._palette.set_palette_state(Palette.SECONDARY)
|