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_size (GtkCellRenderer *cell,
58 const GdkRectangle *cell_area,
63 static GtkCellEditable *
64 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
68 const GdkRectangle *background_area,
69 const GdkRectangle *cell_area,
70 GtkCellRendererState flags);
71 static gchar *convert_keysym_state_to_string (GtkCellRendererAccel *accel,
90 struct _GtkCellRendererAccelPrivate
92 GtkWidget *edit_widget;
93 GtkWidget *grab_widget;
94 GtkWidget *sizing_label;
96 GdkDevice *grab_keyboard;
97 GdkDevice *grab_pointer;
99 GtkCellRendererAccelMode accel_mode;
101 GdkModifierType accel_mods;
107 static guint signals[LAST_SIGNAL] = { 0 };
109 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
112 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
116 cell_accel->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell_accel,
117 GTK_TYPE_CELL_RENDERER_ACCEL,
118 GtkCellRendererAccelPrivate);
120 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
121 g_object_set (cell_accel, "text", text, NULL);
126 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
128 GObjectClass *object_class;
129 GtkCellRendererClass *cell_renderer_class;
131 object_class = G_OBJECT_CLASS (cell_accel_class);
132 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
134 object_class->set_property = gtk_cell_renderer_accel_set_property;
135 object_class->get_property = gtk_cell_renderer_accel_get_property;
137 cell_renderer_class->get_size = gtk_cell_renderer_accel_get_size;
138 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
141 * GtkCellRendererAccel:accel-key:
143 * The keyval of the accelerator.
147 g_object_class_install_property (object_class,
149 g_param_spec_uint ("accel-key",
150 P_("Accelerator key"),
151 P_("The keyval of the accelerator"),
155 GTK_PARAM_READWRITE));
158 * GtkCellRendererAccel:accel-mods:
160 * The modifier mask of the accelerator.
164 g_object_class_install_property (object_class,
166 g_param_spec_flags ("accel-mods",
167 P_("Accelerator modifiers"),
168 P_("The modifier mask of the accelerator"),
169 GDK_TYPE_MODIFIER_TYPE,
171 GTK_PARAM_READWRITE));
174 * GtkCellRendererAccel:keycode:
176 * The hardware keycode of the accelerator. Note that the hardware keycode is
177 * only relevant if the key does not have a keyval. Normally, the keyboard
178 * configuration should assign keyvals to all keys.
182 g_object_class_install_property (object_class,
184 g_param_spec_uint ("keycode",
185 P_("Accelerator keycode"),
186 P_("The hardware keycode of the accelerator"),
190 GTK_PARAM_READWRITE));
193 * GtkCellRendererAccel:accel-mode:
195 * Determines if the edited accelerators are GTK+ accelerators. If
196 * they are, consumed modifiers are suppressed, only accelerators
197 * accepted by GTK+ are allowed, and the accelerators are rendered
198 * in the same way as they are in menus.
202 g_object_class_install_property (object_class,
204 g_param_spec_enum ("accel-mode",
205 P_("Accelerator Mode"),
206 P_("The type of accelerators"),
207 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
208 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
209 GTK_PARAM_READWRITE));
212 * GtkCellRendererAccel::accel-edited:
213 * @accel: the object reveiving the signal
214 * @path_string: the path identifying the row of the edited cell
215 * @accel_key: the new accelerator keyval
216 * @accel_mods: the new acclerator modifier mask
217 * @hardware_keycode: the keycode of the new accelerator
219 * Gets emitted when the user has selected a new accelerator.
223 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
224 GTK_TYPE_CELL_RENDERER_ACCEL,
226 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
228 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
232 GDK_TYPE_MODIFIER_TYPE,
236 * GtkCellRendererAccel::accel-cleared:
237 * @accel: the object reveiving the signal
238 * @path_string: the path identifying the row of the edited cell
240 * Gets emitted when the user has removed the accelerator.
244 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
245 GTK_TYPE_CELL_RENDERER_ACCEL,
247 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
249 g_cclosure_marshal_VOID__STRING,
253 g_type_class_add_private (cell_accel_class, sizeof (GtkCellRendererAccelPrivate));
258 * gtk_cell_renderer_accel_new:
260 * Creates a new #GtkCellRendererAccel.
262 * Returns: the new cell renderer
267 gtk_cell_renderer_accel_new (void)
269 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
273 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
275 GdkModifierType mask,
278 GtkCellRendererAccelPrivate *priv = accel->priv;
280 if (keysym == 0 && keycode == 0)
281 /* This label is displayed in a treeview cell displaying
282 * a disabled accelerator key combination.
284 return g_strdup (C_("Accelerator", "Disabled"));
287 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
289 if (!gtk_accelerator_valid (keysym, mask))
290 /* This label is displayed in a treeview cell displaying
291 * an accelerator key combination that is not valid according
292 * to gtk_accelerator_valid().
294 return g_strdup (C_("Accelerator", "Invalid"));
296 return gtk_accelerator_get_label (keysym, mask);
302 name = gtk_accelerator_get_label_with_keycode (NULL, keysym, keycode, mask);
304 name = gtk_accelerator_name_with_keycode (NULL, keysym, keycode, mask);
312 gtk_cell_renderer_accel_get_property (GObject *object,
317 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (object)->priv;
322 g_value_set_uint (value, priv->accel_key);
325 case PROP_ACCEL_MODS:
326 g_value_set_flags (value, priv->accel_mods);
330 g_value_set_uint (value, priv->keycode);
333 case PROP_ACCEL_MODE:
334 g_value_set_enum (value, priv->accel_mode);
338 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
343 gtk_cell_renderer_accel_set_property (GObject *object,
348 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
349 GtkCellRendererAccelPrivate *priv = accel->priv;
350 gboolean changed = FALSE;
356 guint accel_key = g_value_get_uint (value);
358 if (priv->accel_key != accel_key)
360 priv->accel_key = accel_key;
366 case PROP_ACCEL_MODS:
368 guint accel_mods = g_value_get_flags (value);
370 if (priv->accel_mods != accel_mods)
372 priv->accel_mods = accel_mods;
379 guint keycode = g_value_get_uint (value);
381 if (priv->keycode != keycode)
383 priv->keycode = keycode;
389 case PROP_ACCEL_MODE:
390 priv->accel_mode = g_value_get_enum (value);
394 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
401 text = convert_keysym_state_to_string (accel, priv->accel_key, priv->accel_mods, priv->keycode);
402 g_object_set (accel, "text", text, NULL);
408 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
410 const GdkRectangle *cell_area,
417 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (cell)->priv;
418 GtkRequisition requisition;
420 if (priv->sizing_label == NULL)
421 priv->sizing_label = gtk_label_new (_("New accelerator..."));
423 gtk_widget_get_preferred_size (priv->sizing_label, &requisition, NULL);
425 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
426 x_offset, y_offset, width, height);
428 /* FIXME: need to take the cell_area et al. into account */
430 *width = MAX (*width, requisition.width);
432 *height = MAX (*height, requisition.height);
436 grab_key_callback (GtkWidget *widget,
438 GtkCellRendererAccel *accel)
440 GtkCellRendererAccelPrivate *priv = accel->priv;
441 GdkModifierType accel_mods = 0;
447 GdkModifierType consumed_modifiers;
450 display = gtk_widget_get_display (widget);
452 if (event->is_modifier)
458 accel_mods = event->state;
460 _gtk_translate_keyboard_accel_state (gdk_keymap_get_for_display (display),
461 event->hardware_keycode,
463 gtk_accelerator_get_default_mod_mask (),
465 &keyval, NULL, NULL, &consumed_modifiers);
467 accel_key = gdk_keyval_to_lower (keyval);
468 if (accel_key == GDK_KEY_ISO_Left_Tab)
469 accel_key = GDK_KEY_Tab;
471 accel_mods &= gtk_accelerator_get_default_mod_mask ();
473 /* Filter consumed modifiers
475 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
476 accel_mods &= ~consumed_modifiers;
478 /* Put shift back if it changed the case of the key, not otherwise.
480 if (accel_key != keyval)
481 accel_mods |= GDK_SHIFT_MASK;
488 goto out; /* cancel */
489 case GDK_KEY_BackSpace:
490 /* clear the accelerator on Backspace */
498 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
500 if (!gtk_accelerator_valid (accel_key, accel_mods))
502 gtk_widget_error_bell (widget);
511 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
512 gdk_device_ungrab (priv->grab_keyboard, event->time);
513 gdk_device_ungrab (priv->grab_pointer, event->time);
515 path = g_strdup (g_object_get_data (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text"));
517 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (priv->edit_widget));
518 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (priv->edit_widget));
519 priv->edit_widget = NULL;
520 priv->grab_widget = NULL;
521 priv->grab_keyboard = NULL;
522 priv->grab_pointer = NULL;
525 g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
526 accel_key, accel_mods, event->hardware_keycode);
528 g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
536 ungrab_stuff (GtkWidget *widget,
537 GtkCellRendererAccel *accel)
539 GtkCellRendererAccelPrivate *priv = accel->priv;
541 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
542 gdk_device_ungrab (priv->grab_keyboard, GDK_CURRENT_TIME);
543 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
545 priv->grab_keyboard = NULL;
546 priv->grab_pointer = NULL;
548 g_signal_handlers_disconnect_by_func (priv->grab_widget,
549 G_CALLBACK (grab_key_callback),
554 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
557 /* do nothing, because we are pointless */
561 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
563 iface->start_editing = _gtk_cell_editable_event_box_start_editing;
566 typedef struct _GtkCellEditableEventBox GtkCellEditableEventBox;
567 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
569 struct _GtkCellEditableEventBox
572 gboolean editing_canceled;
575 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
576 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
581 PROP_EDITING_CANCELED
585 gtk_cell_editable_event_box_set_property (GObject *object,
590 GtkCellEditableEventBox *box = (GtkCellEditableEventBox*)object;
594 case PROP_EDITING_CANCELED:
595 box->editing_canceled = g_value_get_boolean (value);
598 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
604 gtk_cell_editable_event_box_get_property (GObject *object,
609 GtkCellEditableEventBox *box = (GtkCellEditableEventBox*)object;
613 case PROP_EDITING_CANCELED:
614 g_value_set_boolean (value, box->editing_canceled);
617 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
623 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
625 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
627 gobject_class->set_property = gtk_cell_editable_event_box_set_property;
628 gobject_class->get_property = gtk_cell_editable_event_box_get_property;
630 g_object_class_override_property (gobject_class,
631 PROP_EDITING_CANCELED,
636 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
640 static GtkCellEditable *
641 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
645 const GdkRectangle *background_area,
646 const GdkRectangle *cell_area,
647 GtkCellRendererState flags)
649 GtkCellRendererAccelPrivate *priv;
650 GtkCellRendererText *celltext;
651 GtkCellRendererAccel *accel;
652 GtkStyleContext *context;
656 GdkDevice *device, *keyb, *pointer;
661 celltext = GTK_CELL_RENDERER_TEXT (cell);
662 accel = GTK_CELL_RENDERER_ACCEL (cell);
665 /* If the cell isn't editable we return NULL. */
666 g_object_get (celltext, "editable", &editable, NULL);
667 if (editable == FALSE)
670 window = gtk_widget_get_window (widget);
671 context = gtk_widget_get_style_context (widget);
673 g_return_val_if_fail (window != NULL, NULL);
676 device = gdk_event_get_device (event);
678 device = gtk_get_current_event_device ();
683 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
686 pointer = gdk_device_get_associated_device (device);
691 keyb = gdk_device_get_associated_device (device);
694 time = gdk_event_get_time (event);
696 if (gdk_device_grab (keyb, window,
697 GDK_OWNERSHIP_WINDOW, FALSE,
698 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
699 NULL, time) != GDK_GRAB_SUCCESS)
702 if (gdk_device_grab (pointer, window,
703 GDK_OWNERSHIP_WINDOW, FALSE,
704 GDK_BUTTON_PRESS_MASK,
705 NULL, time) != GDK_GRAB_SUCCESS)
707 gdk_device_ungrab (keyb, time);
711 priv->grab_keyboard = keyb;
712 priv->grab_pointer = pointer;
713 priv->grab_widget = widget;
715 g_signal_connect (G_OBJECT (widget), "key-press-event",
716 G_CALLBACK (grab_key_callback),
719 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
720 priv->edit_widget = eventbox;
721 g_object_add_weak_pointer (G_OBJECT (priv->edit_widget),
722 (gpointer) &priv->edit_widget);
724 label = gtk_label_new (NULL);
725 gtk_widget_set_halign (label, GTK_ALIGN_START);
726 gtk_widget_set_valign (label, GTK_ALIGN_CENTER);
728 gtk_style_context_get_background_color (context, GTK_STATE_FLAG_SELECTED, &color);
729 gtk_widget_override_background_color (eventbox, 0, &color);
731 gtk_style_context_get_color (context, GTK_STATE_FLAG_SELECTED, &color);
732 gtk_widget_override_color (label, 0, &color);
734 /* This label is displayed in a treeview cell displaying
735 * an accelerator when the cell is clicked to change the
738 gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
740 gtk_container_add (GTK_CONTAINER (eventbox), label);
742 g_object_set_data_full (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text",
743 g_strdup (path), g_free);
745 gtk_widget_show_all (priv->edit_widget);
747 gtk_device_grab_add (priv->grab_widget, pointer, TRUE);
749 g_signal_connect (priv->edit_widget, "unrealize",
750 G_CALLBACK (ungrab_stuff), accel);
752 return GTK_CELL_EDITABLE (priv->edit_widget);