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"
24 #include "gdk/gdkkeysyms.h"
27 #include "gtkaccelgroup.h"
28 #include "gtkmarshalers.h"
30 #include "gtkeventbox.h"
32 #include "gtksizerequest.h"
33 #include "gtkprivate.h"
36 static void gtk_cell_renderer_accel_get_property (GObject *object,
40 static void gtk_cell_renderer_accel_set_property (GObject *object,
44 static void gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
46 GdkRectangle *cell_area,
51 static GtkCellEditable *
52 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
56 GdkRectangle *background_area,
57 GdkRectangle *cell_area,
58 GtkCellRendererState flags);
59 static gchar *convert_keysym_state_to_string (GtkCellRendererAccel *accel,
78 struct _GtkCellRendererAccelPrivate
80 GtkCellRendererAccelMode accel_mode;
82 GtkWidget *edit_widget;
83 GtkWidget *grab_widget;
84 GtkWidget *sizing_label;
86 GdkDevice *grab_keyboard;
87 GdkDevice *grab_pointer;
89 GdkModifierType accel_mods;
95 static guint signals[LAST_SIGNAL] = { 0 };
97 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
100 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
104 cell_accel->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell_accel,
105 GTK_TYPE_CELL_RENDERER_ACCEL,
106 GtkCellRendererAccelPrivate);
108 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
109 g_object_set (cell_accel, "text", text, NULL);
114 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
116 GObjectClass *object_class;
117 GtkCellRendererClass *cell_renderer_class;
119 object_class = G_OBJECT_CLASS (cell_accel_class);
120 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
122 object_class->set_property = gtk_cell_renderer_accel_set_property;
123 object_class->get_property = gtk_cell_renderer_accel_get_property;
125 cell_renderer_class->get_size = gtk_cell_renderer_accel_get_size;
126 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
129 * GtkCellRendererAccel:accel-key:
131 * The keyval of the accelerator.
135 g_object_class_install_property (object_class,
137 g_param_spec_uint ("accel-key",
138 P_("Accelerator key"),
139 P_("The keyval of the accelerator"),
143 GTK_PARAM_READWRITE));
146 * GtkCellRendererAccel:accel-mods:
148 * The modifier mask of the accelerator.
152 g_object_class_install_property (object_class,
154 g_param_spec_flags ("accel-mods",
155 P_("Accelerator modifiers"),
156 P_("The modifier mask of the accelerator"),
157 GDK_TYPE_MODIFIER_TYPE,
159 GTK_PARAM_READWRITE));
162 * GtkCellRendererAccel:keycode:
164 * The hardware keycode of the accelerator. Note that the hardware keycode is
165 * only relevant if the key does not have a keyval. Normally, the keyboard
166 * configuration should assign keyvals to all keys.
170 g_object_class_install_property (object_class,
172 g_param_spec_uint ("keycode",
173 P_("Accelerator keycode"),
174 P_("The hardware keycode of the accelerator"),
178 GTK_PARAM_READWRITE));
181 * GtkCellRendererAccel:accel-mode:
183 * Determines if the edited accelerators are GTK+ accelerators. If
184 * they are, consumed modifiers are suppressed, only accelerators
185 * accepted by GTK+ are allowed, and the accelerators are rendered
186 * in the same way as they are in menus.
190 g_object_class_install_property (object_class,
192 g_param_spec_enum ("accel-mode",
193 P_("Accelerator Mode"),
194 P_("The type of accelerators"),
195 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
196 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
197 GTK_PARAM_READWRITE));
200 * GtkCellRendererAccel::accel-edited:
201 * @accel: the object reveiving the signal
202 * @path_string: the path identifying the row of the edited cell
203 * @accel_key: the new accelerator keyval
204 * @accel_mods: the new acclerator modifier mask
205 * @hardware_keycode: the keycode of the new accelerator
207 * Gets emitted when the user has selected a new accelerator.
211 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
212 GTK_TYPE_CELL_RENDERER_ACCEL,
214 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
216 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
220 GDK_TYPE_MODIFIER_TYPE,
224 * GtkCellRendererAccel::accel-cleared:
225 * @accel: the object reveiving the signal
226 * @path_string: the path identifying the row of the edited cell
228 * Gets emitted when the user has removed the accelerator.
232 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
233 GTK_TYPE_CELL_RENDERER_ACCEL,
235 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
237 g_cclosure_marshal_VOID__STRING,
241 g_type_class_add_private (cell_accel_class, sizeof (GtkCellRendererAccelPrivate));
246 * gtk_cell_renderer_accel_new:
248 * Creates a new #GtkCellRendererAccel.
250 * Returns: the new cell renderer
255 gtk_cell_renderer_accel_new (void)
257 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
261 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
263 GdkModifierType mask,
266 GtkCellRendererAccelPrivate *priv = accel->priv;
268 if (keysym == 0 && keycode == 0)
269 /* This label is displayed in a treeview cell displaying
270 * a disabled accelerator key combination.
272 return g_strdup (C_("Accelerator", "Disabled"));
275 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
277 if (!gtk_accelerator_valid (keysym, mask))
278 /* This label is displayed in a treeview cell displaying
279 * an accelerator key combination that is not valid according
280 * to gtk_accelerator_valid().
282 return g_strdup (C_("Accelerator", "Invalid"));
284 return gtk_accelerator_get_label (keysym, mask);
290 name = gtk_accelerator_get_label (keysym, mask);
292 name = gtk_accelerator_name (keysym, mask);
299 name = g_strdup_printf ("%s0x%02x", tmp, keycode);
309 gtk_cell_renderer_accel_get_property (GObject *object,
314 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (object)->priv;
319 g_value_set_uint (value, priv->accel_key);
322 case PROP_ACCEL_MODS:
323 g_value_set_flags (value, priv->accel_mods);
327 g_value_set_uint (value, priv->keycode);
330 case PROP_ACCEL_MODE:
331 g_value_set_enum (value, priv->accel_mode);
335 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
340 gtk_cell_renderer_accel_set_property (GObject *object,
345 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
346 GtkCellRendererAccelPrivate *priv = accel->priv;
347 gboolean changed = FALSE;
353 guint accel_key = g_value_get_uint (value);
355 if (priv->accel_key != accel_key)
357 priv->accel_key = accel_key;
363 case PROP_ACCEL_MODS:
365 guint accel_mods = g_value_get_flags (value);
367 if (priv->accel_mods != accel_mods)
369 priv->accel_mods = accel_mods;
376 guint keycode = g_value_get_uint (value);
378 if (priv->keycode != keycode)
380 priv->keycode = keycode;
386 case PROP_ACCEL_MODE:
387 priv->accel_mode = g_value_get_enum (value);
391 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
398 text = convert_keysym_state_to_string (accel, priv->accel_key, priv->accel_mods, priv->keycode);
399 g_object_set (accel, "text", text, NULL);
405 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
407 GdkRectangle *cell_area,
414 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (cell)->priv;
415 GtkRequisition requisition;
417 if (priv->sizing_label == NULL)
418 priv->sizing_label = gtk_label_new (_("New accelerator..."));
420 gtk_widget_get_preferred_size (priv->sizing_label, &requisition, NULL);
422 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
423 x_offset, y_offset, width, height);
425 /* FIXME: need to take the cell_area et al. into account */
427 *width = MAX (*width, requisition.width);
429 *height = MAX (*height, requisition.height);
433 grab_key_callback (GtkWidget *widget,
435 GtkCellRendererAccel *accel)
437 GtkCellRendererAccelPrivate *priv = accel->priv;
438 GdkModifierType accel_mods = 0;
443 GdkModifierType consumed_modifiers;
446 display = gtk_widget_get_display (widget);
448 if (event->is_modifier)
454 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
455 event->hardware_keycode,
458 NULL, NULL, NULL, &consumed_modifiers);
460 accel_key = gdk_keyval_to_lower (event->keyval);
461 if (accel_key == GDK_KEY_ISO_Left_Tab)
462 accel_key = GDK_KEY_Tab;
464 accel_mods = event->state & gtk_accelerator_get_default_mod_mask ();
466 /* Filter consumed modifiers
468 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
469 accel_mods &= ~consumed_modifiers;
471 /* Put shift back if it changed the case of the key, not otherwise.
473 if (accel_key != event->keyval)
474 accel_mods |= GDK_SHIFT_MASK;
478 switch (event->keyval)
481 goto out; /* cancel */
482 case GDK_KEY_BackSpace:
483 /* clear the accelerator on Backspace */
491 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
493 if (!gtk_accelerator_valid (accel_key, accel_mods))
495 gtk_widget_error_bell (widget);
504 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
505 gdk_device_ungrab (priv->grab_keyboard, event->time);
506 gdk_device_ungrab (priv->grab_pointer, event->time);
508 path = g_strdup (g_object_get_data (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text"));
510 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (priv->edit_widget));
511 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (priv->edit_widget));
512 priv->edit_widget = NULL;
513 priv->grab_widget = NULL;
514 priv->grab_keyboard = NULL;
515 priv->grab_pointer = NULL;
518 g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
519 accel_key, accel_mods, event->hardware_keycode);
521 g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
529 ungrab_stuff (GtkWidget *widget,
530 GtkCellRendererAccel *accel)
532 GtkCellRendererAccelPrivate *priv = accel->priv;
534 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
535 gdk_device_ungrab (priv->grab_keyboard, GDK_CURRENT_TIME);
536 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
538 priv->grab_keyboard = NULL;
539 priv->grab_pointer = NULL;
541 g_signal_handlers_disconnect_by_func (priv->grab_widget,
542 G_CALLBACK (grab_key_callback),
547 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
550 /* do nothing, because we are pointless */
554 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
556 iface->start_editing = _gtk_cell_editable_event_box_start_editing;
559 typedef GtkEventBox GtkCellEditableEventBox;
560 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
562 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
563 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
568 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
573 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
577 static GtkCellEditable *
578 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
582 GdkRectangle *background_area,
583 GdkRectangle *cell_area,
584 GtkCellRendererState flags)
586 GtkCellRendererAccelPrivate *priv;
587 GtkCellRendererText *celltext;
588 GtkCellRendererAccel *accel;
592 GdkDevice *device, *keyb, *pointer;
597 celltext = GTK_CELL_RENDERER_TEXT (cell);
598 accel = GTK_CELL_RENDERER_ACCEL (cell);
601 /* If the cell isn't editable we return NULL. */
602 g_object_get (celltext, "editable", &editable, NULL);
603 if (editable == FALSE)
606 window = gtk_widget_get_window (widget);
607 style = gtk_widget_get_style (widget);
609 g_return_val_if_fail (window != NULL, NULL);
612 device = gdk_event_get_device (event);
614 device = gtk_get_current_event_device ();
619 if (device->source == GDK_SOURCE_KEYBOARD)
622 pointer = gdk_device_get_associated_device (device);
627 keyb = gdk_device_get_associated_device (device);
630 time = gdk_event_get_time (event);
632 if (gdk_device_grab (keyb, window,
633 GDK_OWNERSHIP_WINDOW, FALSE,
634 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
635 NULL, time) != GDK_GRAB_SUCCESS)
638 if (gdk_device_grab (pointer, window,
639 GDK_OWNERSHIP_WINDOW, FALSE,
640 GDK_BUTTON_PRESS_MASK,
641 NULL, time) != GDK_GRAB_SUCCESS)
643 gdk_device_ungrab (keyb, time);
647 priv->grab_keyboard = keyb;
648 priv->grab_pointer = pointer;
649 priv->grab_widget = widget;
651 g_signal_connect (G_OBJECT (widget), "key-press-event",
652 G_CALLBACK (grab_key_callback),
655 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
656 priv->edit_widget = eventbox;
657 g_object_add_weak_pointer (G_OBJECT (priv->edit_widget),
658 (gpointer) &priv->edit_widget);
660 label = gtk_label_new (NULL);
661 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
665 gtk_widget_modify_bg (eventbox, GTK_STATE_NORMAL,
666 &style->bg[GTK_STATE_SELECTED]);
668 gtk_widget_modify_fg (label, GTK_STATE_NORMAL,
669 &style->fg[GTK_STATE_SELECTED]);
671 /* This label is displayed in a treeview cell displaying
672 * an accelerator when the cell is clicked to change the
675 gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
677 gtk_container_add (GTK_CONTAINER (eventbox), label);
679 g_object_set_data_full (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text",
680 g_strdup (path), g_free);
682 gtk_widget_show_all (priv->edit_widget);
684 gtk_device_grab_add (priv->grab_widget, pointer, TRUE);
686 g_signal_connect (priv->edit_widget, "unrealize",
687 G_CALLBACK (ungrab_stuff), accel);
689 return GTK_CELL_EDITABLE (priv->edit_widget);