1 /* gtkcellrendereraccel.h
2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
20 #include "gtkcellrendereraccel.h"
23 #include "gtkaccelgroup.h"
24 #include "gtkmarshalers.h"
26 #include "gtkeventbox.h"
28 #include "gtksizerequest.h"
29 #include "gtktypebuiltins.h"
30 #include "gtkprivate.h"
34 * SECTION:gtkcellrendereraccel
35 * @Short_description: Renders a keyboard accelerator in a cell
36 * @Title: GtkCellRendererAccel
38 * #GtkCellRendererAccel displays a keyboard accelerator (i.e. a
39 * key combination like <keycombo><keycap>Control</keycap><keycap>a</keycap></keycombo>.
40 * If the cell renderer is editable, the accelerator can be changed by
41 * simply typing the new combination.
43 * The #GtkCellRendererAccel cell renderer was added in GTK+ 2.10.
48 static void gtk_cell_renderer_accel_get_property (GObject *object,
52 static void gtk_cell_renderer_accel_set_property (GObject *object,
56 static void gtk_cell_renderer_accel_get_preferred_width
57 (GtkCellRenderer *cell,
61 static GtkCellEditable *
62 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
66 const GdkRectangle *background_area,
67 const GdkRectangle *cell_area,
68 GtkCellRendererState flags);
69 static gchar *convert_keysym_state_to_string (GtkCellRendererAccel *accel,
88 struct _GtkCellRendererAccelPrivate
90 GtkWidget *edit_widget;
91 GtkWidget *grab_widget;
92 GtkWidget *sizing_label;
94 GdkDevice *grab_keyboard;
95 GdkDevice *grab_pointer;
97 GtkCellRendererAccelMode accel_mode;
99 GdkModifierType accel_mods;
105 static guint signals[LAST_SIGNAL] = { 0 };
107 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
110 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
114 cell_accel->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell_accel,
115 GTK_TYPE_CELL_RENDERER_ACCEL,
116 GtkCellRendererAccelPrivate);
118 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
119 g_object_set (cell_accel, "text", text, NULL);
124 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
126 GObjectClass *object_class;
127 GtkCellRendererClass *cell_renderer_class;
129 object_class = G_OBJECT_CLASS (cell_accel_class);
130 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
132 object_class->set_property = gtk_cell_renderer_accel_set_property;
133 object_class->get_property = gtk_cell_renderer_accel_get_property;
135 cell_renderer_class->get_preferred_width = gtk_cell_renderer_accel_get_preferred_width;
136 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
139 * GtkCellRendererAccel:accel-key:
141 * The keyval of the accelerator.
145 g_object_class_install_property (object_class,
147 g_param_spec_uint ("accel-key",
148 P_("Accelerator key"),
149 P_("The keyval of the accelerator"),
153 GTK_PARAM_READWRITE));
156 * GtkCellRendererAccel:accel-mods:
158 * The modifier mask of the accelerator.
162 g_object_class_install_property (object_class,
164 g_param_spec_flags ("accel-mods",
165 P_("Accelerator modifiers"),
166 P_("The modifier mask of the accelerator"),
167 GDK_TYPE_MODIFIER_TYPE,
169 GTK_PARAM_READWRITE));
172 * GtkCellRendererAccel:keycode:
174 * The hardware keycode of the accelerator. Note that the hardware keycode is
175 * only relevant if the key does not have a keyval. Normally, the keyboard
176 * configuration should assign keyvals to all keys.
180 g_object_class_install_property (object_class,
182 g_param_spec_uint ("keycode",
183 P_("Accelerator keycode"),
184 P_("The hardware keycode of the accelerator"),
188 GTK_PARAM_READWRITE));
191 * GtkCellRendererAccel:accel-mode:
193 * Determines if the edited accelerators are GTK+ accelerators. If
194 * they are, consumed modifiers are suppressed, only accelerators
195 * accepted by GTK+ are allowed, and the accelerators are rendered
196 * in the same way as they are in menus.
200 g_object_class_install_property (object_class,
202 g_param_spec_enum ("accel-mode",
203 P_("Accelerator Mode"),
204 P_("The type of accelerators"),
205 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
206 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
207 GTK_PARAM_READWRITE));
210 * GtkCellRendererAccel::accel-edited:
211 * @accel: the object reveiving the signal
212 * @path_string: the path identifying the row of the edited cell
213 * @accel_key: the new accelerator keyval
214 * @accel_mods: the new acclerator modifier mask
215 * @hardware_keycode: the keycode of the new accelerator
217 * Gets emitted when the user has selected a new accelerator.
221 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
222 GTK_TYPE_CELL_RENDERER_ACCEL,
224 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
226 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
230 GDK_TYPE_MODIFIER_TYPE,
234 * GtkCellRendererAccel::accel-cleared:
235 * @accel: the object reveiving the signal
236 * @path_string: the path identifying the row of the edited cell
238 * Gets emitted when the user has removed the accelerator.
242 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
243 GTK_TYPE_CELL_RENDERER_ACCEL,
245 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
247 g_cclosure_marshal_VOID__STRING,
251 g_type_class_add_private (cell_accel_class, sizeof (GtkCellRendererAccelPrivate));
256 * gtk_cell_renderer_accel_new:
258 * Creates a new #GtkCellRendererAccel.
260 * Returns: the new cell renderer
265 gtk_cell_renderer_accel_new (void)
267 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
271 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
273 GdkModifierType mask,
276 GtkCellRendererAccelPrivate *priv = accel->priv;
278 if (keysym == 0 && keycode == 0)
279 /* This label is displayed in a treeview cell displaying
280 * a disabled accelerator key combination.
282 return g_strdup (C_("Accelerator", "Disabled"));
285 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
287 if (!gtk_accelerator_valid (keysym, mask))
288 /* This label is displayed in a treeview cell displaying
289 * an accelerator key combination that is not valid according
290 * to gtk_accelerator_valid().
292 return g_strdup (C_("Accelerator", "Invalid"));
294 return gtk_accelerator_get_label (keysym, mask);
300 name = gtk_accelerator_get_label_with_keycode (NULL, keysym, keycode, mask);
302 name = gtk_accelerator_name_with_keycode (NULL, keysym, keycode, mask);
310 gtk_cell_renderer_accel_get_property (GObject *object,
315 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (object)->priv;
320 g_value_set_uint (value, priv->accel_key);
323 case PROP_ACCEL_MODS:
324 g_value_set_flags (value, priv->accel_mods);
328 g_value_set_uint (value, priv->keycode);
331 case PROP_ACCEL_MODE:
332 g_value_set_enum (value, priv->accel_mode);
336 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
341 gtk_cell_renderer_accel_set_property (GObject *object,
346 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
347 GtkCellRendererAccelPrivate *priv = accel->priv;
348 gboolean changed = FALSE;
354 guint accel_key = g_value_get_uint (value);
356 if (priv->accel_key != accel_key)
358 priv->accel_key = accel_key;
364 case PROP_ACCEL_MODS:
366 guint accel_mods = g_value_get_flags (value);
368 if (priv->accel_mods != accel_mods)
370 priv->accel_mods = accel_mods;
377 guint keycode = g_value_get_uint (value);
379 if (priv->keycode != keycode)
381 priv->keycode = keycode;
387 case PROP_ACCEL_MODE:
388 priv->accel_mode = g_value_get_enum (value);
392 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
399 text = convert_keysym_state_to_string (accel, priv->accel_key, priv->accel_mods, priv->keycode);
400 g_object_set (accel, "text", text, NULL);
406 gtk_cell_renderer_accel_get_preferred_width (GtkCellRenderer *cell,
412 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (cell)->priv;
413 GtkRequisition min_req, nat_req;
415 if (priv->sizing_label == NULL)
416 priv->sizing_label = gtk_label_new (_("New accelerator…"));
418 gtk_widget_get_preferred_size (priv->sizing_label, &min_req, &nat_req);
420 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_preferred_width (cell, widget,
421 minimum_size, natural_size);
423 /* FIXME: need to take the cell_area et al. into account */
425 *minimum_size = MAX (*minimum_size, min_req.width);
427 *natural_size = MAX (*natural_size, nat_req.width);
431 grab_key_callback (GtkWidget *widget,
433 GtkCellRendererAccel *accel)
435 GtkCellRendererAccelPrivate *priv = accel->priv;
436 GdkModifierType accel_mods = 0;
442 GdkModifierType consumed_modifiers;
445 display = gtk_widget_get_display (widget);
447 if (event->is_modifier)
453 accel_mods = event->state;
455 if (event->keyval == GDK_KEY_Sys_Req &&
456 (accel_mods & GDK_MOD1_MASK) != 0)
458 /* HACK: we don't want to use SysRq as a keybinding (but we do
459 * want Alt+Print), so we avoid translation from Alt+Print to SysRq
461 keyval = GDK_KEY_Print;
462 consumed_modifiers = 0;
466 _gtk_translate_keyboard_accel_state (gdk_keymap_get_for_display (display),
467 event->hardware_keycode,
469 gtk_accelerator_get_default_mod_mask (),
471 &keyval, NULL, NULL, &consumed_modifiers);
474 accel_key = gdk_keyval_to_lower (keyval);
475 if (accel_key == GDK_KEY_ISO_Left_Tab)
476 accel_key = GDK_KEY_Tab;
478 accel_mods &= gtk_accelerator_get_default_mod_mask ();
480 /* Filter consumed modifiers
482 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
483 accel_mods &= ~consumed_modifiers;
485 /* Put shift back if it changed the case of the key, not otherwise.
487 if (accel_key != keyval)
488 accel_mods |= GDK_SHIFT_MASK;
495 goto out; /* cancel */
496 case GDK_KEY_BackSpace:
497 /* clear the accelerator on Backspace */
505 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
507 if (!gtk_accelerator_valid (accel_key, accel_mods))
509 gtk_widget_error_bell (widget);
518 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
519 gdk_device_ungrab (priv->grab_keyboard, event->time);
520 gdk_device_ungrab (priv->grab_pointer, event->time);
522 path = g_strdup (g_object_get_data (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text"));
524 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (priv->edit_widget));
525 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (priv->edit_widget));
526 priv->edit_widget = NULL;
527 priv->grab_widget = NULL;
528 priv->grab_keyboard = NULL;
529 priv->grab_pointer = NULL;
532 g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
533 accel_key, accel_mods, event->hardware_keycode);
535 g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
543 ungrab_stuff (GtkWidget *widget,
544 GtkCellRendererAccel *accel)
546 GtkCellRendererAccelPrivate *priv = accel->priv;
548 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
549 gdk_device_ungrab (priv->grab_keyboard, GDK_CURRENT_TIME);
550 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
552 priv->grab_keyboard = NULL;
553 priv->grab_pointer = NULL;
555 g_signal_handlers_disconnect_by_func (priv->grab_widget,
556 G_CALLBACK (grab_key_callback),
561 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
564 /* do nothing, because we are pointless */
568 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
570 iface->start_editing = _gtk_cell_editable_event_box_start_editing;
573 typedef struct _GtkCellEditableEventBox GtkCellEditableEventBox;
574 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
576 struct _GtkCellEditableEventBox
579 gboolean editing_canceled;
582 GType _gtk_cell_editable_event_box_get_type (void);
584 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
585 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
590 PROP_EDITING_CANCELED
594 gtk_cell_editable_event_box_set_property (GObject *object,
599 GtkCellEditableEventBox *box = (GtkCellEditableEventBox*)object;
603 case PROP_EDITING_CANCELED:
604 box->editing_canceled = g_value_get_boolean (value);
607 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
613 gtk_cell_editable_event_box_get_property (GObject *object,
618 GtkCellEditableEventBox *box = (GtkCellEditableEventBox*)object;
622 case PROP_EDITING_CANCELED:
623 g_value_set_boolean (value, box->editing_canceled);
626 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
632 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
634 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
636 gobject_class->set_property = gtk_cell_editable_event_box_set_property;
637 gobject_class->get_property = gtk_cell_editable_event_box_get_property;
639 g_object_class_override_property (gobject_class,
640 PROP_EDITING_CANCELED,
645 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
649 static GtkCellEditable *
650 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
654 const GdkRectangle *background_area,
655 const GdkRectangle *cell_area,
656 GtkCellRendererState flags)
658 GtkCellRendererAccelPrivate *priv;
659 GtkCellRendererText *celltext;
660 GtkCellRendererAccel *accel;
661 GtkStyleContext *context;
665 GdkDevice *device, *keyb, *pointer;
670 celltext = GTK_CELL_RENDERER_TEXT (cell);
671 accel = GTK_CELL_RENDERER_ACCEL (cell);
674 /* If the cell isn't editable we return NULL. */
675 g_object_get (celltext, "editable", &editable, NULL);
676 if (editable == FALSE)
679 window = gtk_widget_get_window (widget);
680 context = gtk_widget_get_style_context (widget);
682 g_return_val_if_fail (window != NULL, NULL);
685 device = gdk_event_get_device (event);
687 device = gtk_get_current_event_device ();
692 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
695 pointer = gdk_device_get_associated_device (device);
700 keyb = gdk_device_get_associated_device (device);
703 time = gdk_event_get_time (event);
705 if (gdk_device_grab (keyb, window,
706 GDK_OWNERSHIP_WINDOW, FALSE,
707 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
708 NULL, time) != GDK_GRAB_SUCCESS)
711 if (gdk_device_grab (pointer, window,
712 GDK_OWNERSHIP_WINDOW, FALSE,
713 GDK_BUTTON_PRESS_MASK,
714 NULL, time) != GDK_GRAB_SUCCESS)
716 gdk_device_ungrab (keyb, time);
720 priv->grab_keyboard = keyb;
721 priv->grab_pointer = pointer;
722 priv->grab_widget = widget;
724 g_signal_connect (G_OBJECT (widget), "key-press-event",
725 G_CALLBACK (grab_key_callback),
728 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
729 priv->edit_widget = eventbox;
730 g_object_add_weak_pointer (G_OBJECT (priv->edit_widget),
731 (gpointer) &priv->edit_widget);
733 label = gtk_label_new (NULL);
734 gtk_widget_set_halign (label, GTK_ALIGN_START);
735 gtk_widget_set_valign (label, GTK_ALIGN_CENTER);
737 gtk_style_context_get_background_color (context, GTK_STATE_FLAG_SELECTED, &color);
738 gtk_widget_override_background_color (eventbox, 0, &color);
740 gtk_style_context_get_color (context, GTK_STATE_FLAG_SELECTED, &color);
741 gtk_widget_override_color (label, 0, &color);
743 /* This label is displayed in a treeview cell displaying
744 * an accelerator when the cell is clicked to change the
747 gtk_label_set_text (GTK_LABEL (label), _("New accelerator…"));
749 gtk_container_add (GTK_CONTAINER (eventbox), label);
751 g_object_set_data_full (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text",
752 g_strdup (path), g_free);
754 gtk_widget_show_all (priv->edit_widget);
756 gtk_device_grab_add (priv->grab_widget, pointer, TRUE);
758 g_signal_connect (priv->edit_widget, "unrealize",
759 G_CALLBACK (ungrab_stuff), accel);
761 return GTK_CELL_EDITABLE (priv->edit_widget);