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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 #include "gtkcellrendereraccel.h"
25 #include "gtkaccelgroup.h"
26 #include "gtkmarshalers.h"
28 #include "gtkeventbox.h"
30 #include "gtksizerequest.h"
31 #include "gtktypebuiltins.h"
32 #include "gtkprivate.h"
36 * SECTION:gtkcellrendereraccel
37 * @Short_description: Renders a keyboard accelerator in a cell
38 * @Title: GtkCellRendererAccel
40 * #GtkCellRendererAccel displays a keyboard accelerator (i.e. a
41 * key combination like <keycombo><keycap>Control</keycap><keycap>a</keycap></keycombo>.
42 * If the cell renderer is editable, the accelerator can be changed by
43 * simply typing the new combination.
45 * The #GtkCellRendererAccel cell renderer was added in GTK+ 2.10.
50 static void gtk_cell_renderer_accel_get_property (GObject *object,
54 static void gtk_cell_renderer_accel_set_property (GObject *object,
58 static void gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
60 const GdkRectangle *cell_area,
65 static GtkCellEditable *
66 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
70 const GdkRectangle *background_area,
71 const GdkRectangle *cell_area,
72 GtkCellRendererState flags);
73 static gchar *convert_keysym_state_to_string (GtkCellRendererAccel *accel,
92 struct _GtkCellRendererAccelPrivate
94 GtkWidget *edit_widget;
95 GtkWidget *grab_widget;
96 GtkWidget *sizing_label;
98 GdkDevice *grab_keyboard;
99 GdkDevice *grab_pointer;
101 GtkCellRendererAccelMode accel_mode;
103 GdkModifierType accel_mods;
109 static guint signals[LAST_SIGNAL] = { 0 };
111 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
114 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
118 cell_accel->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell_accel,
119 GTK_TYPE_CELL_RENDERER_ACCEL,
120 GtkCellRendererAccelPrivate);
122 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
123 g_object_set (cell_accel, "text", text, NULL);
128 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
130 GObjectClass *object_class;
131 GtkCellRendererClass *cell_renderer_class;
133 object_class = G_OBJECT_CLASS (cell_accel_class);
134 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
136 object_class->set_property = gtk_cell_renderer_accel_set_property;
137 object_class->get_property = gtk_cell_renderer_accel_get_property;
139 cell_renderer_class->get_size = gtk_cell_renderer_accel_get_size;
140 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
143 * GtkCellRendererAccel:accel-key:
145 * The keyval of the accelerator.
149 g_object_class_install_property (object_class,
151 g_param_spec_uint ("accel-key",
152 P_("Accelerator key"),
153 P_("The keyval of the accelerator"),
157 GTK_PARAM_READWRITE));
160 * GtkCellRendererAccel:accel-mods:
162 * The modifier mask of the accelerator.
166 g_object_class_install_property (object_class,
168 g_param_spec_flags ("accel-mods",
169 P_("Accelerator modifiers"),
170 P_("The modifier mask of the accelerator"),
171 GDK_TYPE_MODIFIER_TYPE,
173 GTK_PARAM_READWRITE));
176 * GtkCellRendererAccel:keycode:
178 * The hardware keycode of the accelerator. Note that the hardware keycode is
179 * only relevant if the key does not have a keyval. Normally, the keyboard
180 * configuration should assign keyvals to all keys.
184 g_object_class_install_property (object_class,
186 g_param_spec_uint ("keycode",
187 P_("Accelerator keycode"),
188 P_("The hardware keycode of the accelerator"),
192 GTK_PARAM_READWRITE));
195 * GtkCellRendererAccel:accel-mode:
197 * Determines if the edited accelerators are GTK+ accelerators. If
198 * they are, consumed modifiers are suppressed, only accelerators
199 * accepted by GTK+ are allowed, and the accelerators are rendered
200 * in the same way as they are in menus.
204 g_object_class_install_property (object_class,
206 g_param_spec_enum ("accel-mode",
207 P_("Accelerator Mode"),
208 P_("The type of accelerators"),
209 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
210 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
211 GTK_PARAM_READWRITE));
214 * GtkCellRendererAccel::accel-edited:
215 * @accel: the object reveiving the signal
216 * @path_string: the path identifying the row of the edited cell
217 * @accel_key: the new accelerator keyval
218 * @accel_mods: the new acclerator modifier mask
219 * @hardware_keycode: the keycode of the new accelerator
221 * Gets emitted when the user has selected a new accelerator.
225 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
226 GTK_TYPE_CELL_RENDERER_ACCEL,
228 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
230 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
234 GDK_TYPE_MODIFIER_TYPE,
238 * GtkCellRendererAccel::accel-cleared:
239 * @accel: the object reveiving the signal
240 * @path_string: the path identifying the row of the edited cell
242 * Gets emitted when the user has removed the accelerator.
246 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
247 GTK_TYPE_CELL_RENDERER_ACCEL,
249 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
251 g_cclosure_marshal_VOID__STRING,
255 g_type_class_add_private (cell_accel_class, sizeof (GtkCellRendererAccelPrivate));
260 * gtk_cell_renderer_accel_new:
262 * Creates a new #GtkCellRendererAccel.
264 * Returns: the new cell renderer
269 gtk_cell_renderer_accel_new (void)
271 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
275 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
277 GdkModifierType mask,
280 GtkCellRendererAccelPrivate *priv = accel->priv;
282 if (keysym == 0 && keycode == 0)
283 /* This label is displayed in a treeview cell displaying
284 * a disabled accelerator key combination.
286 return g_strdup (C_("Accelerator", "Disabled"));
289 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
291 if (!gtk_accelerator_valid (keysym, mask))
292 /* This label is displayed in a treeview cell displaying
293 * an accelerator key combination that is not valid according
294 * to gtk_accelerator_valid().
296 return g_strdup (C_("Accelerator", "Invalid"));
298 return gtk_accelerator_get_label (keysym, mask);
304 name = gtk_accelerator_get_label (keysym, mask);
306 name = gtk_accelerator_name (keysym, mask);
313 name = g_strdup_printf ("%s0x%02x", tmp, keycode);
323 gtk_cell_renderer_accel_get_property (GObject *object,
328 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (object)->priv;
333 g_value_set_uint (value, priv->accel_key);
336 case PROP_ACCEL_MODS:
337 g_value_set_flags (value, priv->accel_mods);
341 g_value_set_uint (value, priv->keycode);
344 case PROP_ACCEL_MODE:
345 g_value_set_enum (value, priv->accel_mode);
349 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
354 gtk_cell_renderer_accel_set_property (GObject *object,
359 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
360 GtkCellRendererAccelPrivate *priv = accel->priv;
361 gboolean changed = FALSE;
367 guint accel_key = g_value_get_uint (value);
369 if (priv->accel_key != accel_key)
371 priv->accel_key = accel_key;
377 case PROP_ACCEL_MODS:
379 guint accel_mods = g_value_get_flags (value);
381 if (priv->accel_mods != accel_mods)
383 priv->accel_mods = accel_mods;
390 guint keycode = g_value_get_uint (value);
392 if (priv->keycode != keycode)
394 priv->keycode = keycode;
400 case PROP_ACCEL_MODE:
401 priv->accel_mode = g_value_get_enum (value);
405 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
412 text = convert_keysym_state_to_string (accel, priv->accel_key, priv->accel_mods, priv->keycode);
413 g_object_set (accel, "text", text, NULL);
419 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
421 const GdkRectangle *cell_area,
428 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (cell)->priv;
429 GtkRequisition requisition;
431 if (priv->sizing_label == NULL)
432 priv->sizing_label = gtk_label_new (_("New accelerator..."));
434 gtk_widget_get_preferred_size (priv->sizing_label, &requisition, NULL);
436 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
437 x_offset, y_offset, width, height);
439 /* FIXME: need to take the cell_area et al. into account */
441 *width = MAX (*width, requisition.width);
443 *height = MAX (*height, requisition.height);
447 grab_key_callback (GtkWidget *widget,
449 GtkCellRendererAccel *accel)
451 GtkCellRendererAccelPrivate *priv = accel->priv;
452 GdkModifierType accel_mods = 0;
457 GdkModifierType consumed_modifiers;
460 display = gtk_widget_get_display (widget);
462 if (event->is_modifier)
468 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
469 event->hardware_keycode,
472 NULL, NULL, NULL, &consumed_modifiers);
474 accel_key = gdk_keyval_to_lower (event->keyval);
475 if (accel_key == GDK_KEY_ISO_Left_Tab)
476 accel_key = GDK_KEY_Tab;
478 accel_mods = event->state & 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 != event->keyval)
488 accel_mods |= GDK_SHIFT_MASK;
492 switch (event->keyval)
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 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
583 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
588 PROP_EDITING_CANCELED
592 gtk_cell_editable_event_box_set_property (GObject *object,
597 GtkCellEditableEventBox *box = (GtkCellEditableEventBox*)object;
601 case PROP_EDITING_CANCELED:
602 box->editing_canceled = g_value_get_boolean (value);
605 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
611 gtk_cell_editable_event_box_get_property (GObject *object,
616 GtkCellEditableEventBox *box = (GtkCellEditableEventBox*)object;
620 case PROP_EDITING_CANCELED:
621 g_value_set_boolean (value, box->editing_canceled);
624 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
630 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
632 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
634 gobject_class->set_property = gtk_cell_editable_event_box_set_property;
635 gobject_class->get_property = gtk_cell_editable_event_box_get_property;
637 g_object_class_override_property (gobject_class,
638 PROP_EDITING_CANCELED,
643 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
647 static GtkCellEditable *
648 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
652 const GdkRectangle *background_area,
653 const GdkRectangle *cell_area,
654 GtkCellRendererState flags)
656 GtkCellRendererAccelPrivate *priv;
657 GtkCellRendererText *celltext;
658 GtkCellRendererAccel *accel;
659 GtkStyleContext *context;
663 GdkDevice *device, *keyb, *pointer;
668 celltext = GTK_CELL_RENDERER_TEXT (cell);
669 accel = GTK_CELL_RENDERER_ACCEL (cell);
672 /* If the cell isn't editable we return NULL. */
673 g_object_get (celltext, "editable", &editable, NULL);
674 if (editable == FALSE)
677 window = gtk_widget_get_window (widget);
678 context = gtk_widget_get_style_context (widget);
680 g_return_val_if_fail (window != NULL, NULL);
683 device = gdk_event_get_device (event);
685 device = gtk_get_current_event_device ();
690 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
693 pointer = gdk_device_get_associated_device (device);
698 keyb = gdk_device_get_associated_device (device);
701 time = gdk_event_get_time (event);
703 if (gdk_device_grab (keyb, window,
704 GDK_OWNERSHIP_WINDOW, FALSE,
705 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
706 NULL, time) != GDK_GRAB_SUCCESS)
709 if (gdk_device_grab (pointer, window,
710 GDK_OWNERSHIP_WINDOW, FALSE,
711 GDK_BUTTON_PRESS_MASK,
712 NULL, time) != GDK_GRAB_SUCCESS)
714 gdk_device_ungrab (keyb, time);
718 priv->grab_keyboard = keyb;
719 priv->grab_pointer = pointer;
720 priv->grab_widget = widget;
722 g_signal_connect (G_OBJECT (widget), "key-press-event",
723 G_CALLBACK (grab_key_callback),
726 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
727 priv->edit_widget = eventbox;
728 g_object_add_weak_pointer (G_OBJECT (priv->edit_widget),
729 (gpointer) &priv->edit_widget);
731 label = gtk_label_new (NULL);
732 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
734 gtk_style_context_get_background_color (context, GTK_STATE_FLAG_SELECTED, &color);
735 gtk_widget_override_background_color (label, 0, &color);
737 gtk_style_context_get_color (context, GTK_STATE_FLAG_SELECTED, &color);
738 gtk_widget_override_color (label, 0, &color);
740 /* This label is displayed in a treeview cell displaying
741 * an accelerator when the cell is clicked to change the
744 gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
746 gtk_container_add (GTK_CONTAINER (eventbox), label);
748 g_object_set_data_full (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text",
749 g_strdup (path), g_free);
751 gtk_widget_show_all (priv->edit_widget);
753 gtk_device_grab_add (priv->grab_widget, pointer, TRUE);
755 g_signal_connect (priv->edit_widget, "unrealize",
756 G_CALLBACK (ungrab_stuff), accel);
758 return GTK_CELL_EDITABLE (priv->edit_widget);