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 "gtkaccelgroup.h"
23 #include "gtkmarshalers.h"
24 #include "gtkcellrendereraccel.h"
26 #include "gtkeventbox.h"
28 #include "gtkprivate.h"
29 #include "gdk/gdkkeysyms.h"
32 static void gtk_cell_renderer_accel_get_property (GObject *object,
36 static void gtk_cell_renderer_accel_set_property (GObject *object,
40 static void gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
42 GdkRectangle *cell_area,
47 static GtkCellEditable *
48 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
52 GdkRectangle *background_area,
53 GdkRectangle *cell_area,
54 GtkCellRendererState flags);
55 static gchar *convert_keysym_state_to_string (GtkCellRendererAccel *accel,
74 struct _GtkCellRendererAccelPrivate
76 GtkCellRendererAccelMode accel_mode;
78 GtkWidget *edit_widget;
79 GtkWidget *grab_widget;
80 GtkWidget *sizing_label;
82 GdkDevice *grab_keyboard;
83 GdkDevice *grab_pointer;
85 GdkModifierType accel_mods;
91 static guint signals[LAST_SIGNAL] = { 0 };
93 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
96 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
100 cell_accel->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell_accel,
101 GTK_TYPE_CELL_RENDERER_ACCEL,
102 GtkCellRendererAccelPrivate);
104 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
105 g_object_set (cell_accel, "text", text, NULL);
110 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
112 GObjectClass *object_class;
113 GtkCellRendererClass *cell_renderer_class;
115 object_class = G_OBJECT_CLASS (cell_accel_class);
116 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
118 object_class->set_property = gtk_cell_renderer_accel_set_property;
119 object_class->get_property = gtk_cell_renderer_accel_get_property;
121 cell_renderer_class->get_size = gtk_cell_renderer_accel_get_size;
122 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
125 * GtkCellRendererAccel:accel-key:
127 * The keyval of the accelerator.
131 g_object_class_install_property (object_class,
133 g_param_spec_uint ("accel-key",
134 P_("Accelerator key"),
135 P_("The keyval of the accelerator"),
139 GTK_PARAM_READWRITE));
142 * GtkCellRendererAccel:accel-mods:
144 * The modifier mask of the accelerator.
148 g_object_class_install_property (object_class,
150 g_param_spec_flags ("accel-mods",
151 P_("Accelerator modifiers"),
152 P_("The modifier mask of the accelerator"),
153 GDK_TYPE_MODIFIER_TYPE,
155 GTK_PARAM_READWRITE));
158 * GtkCellRendererAccel:keycode:
160 * The hardware keycode of the accelerator. Note that the hardware keycode is
161 * only relevant if the key does not have a keyval. Normally, the keyboard
162 * configuration should assign keyvals to all keys.
166 g_object_class_install_property (object_class,
168 g_param_spec_uint ("keycode",
169 P_("Accelerator keycode"),
170 P_("The hardware keycode of the accelerator"),
174 GTK_PARAM_READWRITE));
177 * GtkCellRendererAccel:accel-mode:
179 * Determines if the edited accelerators are GTK+ accelerators. If
180 * they are, consumed modifiers are suppressed, only accelerators
181 * accepted by GTK+ are allowed, and the accelerators are rendered
182 * in the same way as they are in menus.
186 g_object_class_install_property (object_class,
188 g_param_spec_enum ("accel-mode",
189 P_("Accelerator Mode"),
190 P_("The type of accelerators"),
191 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
192 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
193 GTK_PARAM_READWRITE));
196 * GtkCellRendererAccel::accel-edited:
197 * @accel: the object reveiving the signal
198 * @path_string: the path identifying the row of the edited cell
199 * @accel_key: the new accelerator keyval
200 * @accel_mods: the new acclerator modifier mask
201 * @hardware_keycode: the keycode of the new accelerator
203 * Gets emitted when the user has selected a new accelerator.
207 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
208 GTK_TYPE_CELL_RENDERER_ACCEL,
210 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
212 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
216 GDK_TYPE_MODIFIER_TYPE,
220 * GtkCellRendererAccel::accel-cleared:
221 * @accel: the object reveiving the signal
222 * @path_string: the path identifying the row of the edited cell
224 * Gets emitted when the user has removed the accelerator.
228 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
229 GTK_TYPE_CELL_RENDERER_ACCEL,
231 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
233 g_cclosure_marshal_VOID__STRING,
237 g_type_class_add_private (cell_accel_class, sizeof (GtkCellRendererAccelPrivate));
242 * gtk_cell_renderer_accel_new:
244 * Creates a new #GtkCellRendererAccel.
246 * Returns: the new cell renderer
251 gtk_cell_renderer_accel_new (void)
253 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
257 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
259 GdkModifierType mask,
262 GtkCellRendererAccelPrivate *priv = accel->priv;
264 if (keysym == 0 && keycode == 0)
265 /* This label is displayed in a treeview cell displaying
266 * a disabled accelerator key combination.
268 return g_strdup (C_("Accelerator", "Disabled"));
271 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
273 if (!gtk_accelerator_valid (keysym, mask))
274 /* This label is displayed in a treeview cell displaying
275 * an accelerator key combination that is not valid according
276 * to gtk_accelerator_valid().
278 return g_strdup (C_("Accelerator", "Invalid"));
280 return gtk_accelerator_get_label (keysym, mask);
286 name = gtk_accelerator_get_label (keysym, mask);
288 name = gtk_accelerator_name (keysym, mask);
295 name = g_strdup_printf ("%s0x%02x", tmp, keycode);
305 gtk_cell_renderer_accel_get_property (GObject *object,
310 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (object)->priv;
315 g_value_set_uint (value, priv->accel_key);
318 case PROP_ACCEL_MODS:
319 g_value_set_flags (value, priv->accel_mods);
323 g_value_set_uint (value, priv->keycode);
326 case PROP_ACCEL_MODE:
327 g_value_set_enum (value, priv->accel_mode);
331 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
336 gtk_cell_renderer_accel_set_property (GObject *object,
341 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
342 GtkCellRendererAccelPrivate *priv = accel->priv;
343 gboolean changed = FALSE;
349 guint accel_key = g_value_get_uint (value);
351 if (priv->accel_key != accel_key)
353 priv->accel_key = accel_key;
359 case PROP_ACCEL_MODS:
361 guint accel_mods = g_value_get_flags (value);
363 if (priv->accel_mods != accel_mods)
365 priv->accel_mods = accel_mods;
372 guint keycode = g_value_get_uint (value);
374 if (priv->keycode != keycode)
376 priv->keycode = keycode;
382 case PROP_ACCEL_MODE:
383 priv->accel_mode = g_value_get_enum (value);
387 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
394 text = convert_keysym_state_to_string (accel, priv->accel_key, priv->accel_mods, priv->keycode);
395 g_object_set (accel, "text", text, NULL);
401 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
403 GdkRectangle *cell_area,
410 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (cell)->priv;
411 GtkRequisition requisition;
413 if (priv->sizing_label == NULL)
414 priv->sizing_label = gtk_label_new (_("New accelerator..."));
416 gtk_widget_size_request (priv->sizing_label, &requisition);
418 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
419 x_offset, y_offset, width, height);
421 /* FIXME: need to take the cell_area et al. into account */
423 *width = MAX (*width, requisition.width);
425 *height = MAX (*height, requisition.height);
429 grab_key_callback (GtkWidget *widget,
431 GtkCellRendererAccel *accel)
433 GtkCellRendererAccelPrivate *priv = accel->priv;
434 GdkModifierType accel_mods = 0;
439 GdkModifierType consumed_modifiers;
442 display = gtk_widget_get_display (widget);
444 if (event->is_modifier)
450 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
451 event->hardware_keycode,
454 NULL, NULL, NULL, &consumed_modifiers);
456 accel_key = gdk_keyval_to_lower (event->keyval);
457 if (accel_key == GDK_ISO_Left_Tab)
460 accel_mods = event->state & gtk_accelerator_get_default_mod_mask ();
462 /* Filter consumed modifiers
464 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
465 accel_mods &= ~consumed_modifiers;
467 /* Put shift back if it changed the case of the key, not otherwise.
469 if (accel_key != event->keyval)
470 accel_mods |= GDK_SHIFT_MASK;
474 switch (event->keyval)
477 goto out; /* cancel */
479 /* clear the accelerator on Backspace */
487 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
489 if (!gtk_accelerator_valid (accel_key, accel_mods))
491 gtk_widget_error_bell (widget);
500 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
501 gdk_device_ungrab (priv->grab_keyboard, event->time);
502 gdk_device_ungrab (priv->grab_pointer, event->time);
504 path = g_strdup (g_object_get_data (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text"));
506 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (priv->edit_widget));
507 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (priv->edit_widget));
508 priv->edit_widget = NULL;
509 priv->grab_widget = NULL;
510 priv->grab_keyboard = NULL;
511 priv->grab_pointer = NULL;
514 g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
515 accel_key, accel_mods, event->hardware_keycode);
517 g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
525 ungrab_stuff (GtkWidget *widget,
526 GtkCellRendererAccel *accel)
528 GtkCellRendererAccelPrivate *priv = accel->priv;
530 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
531 gdk_device_ungrab (priv->grab_keyboard, GDK_CURRENT_TIME);
532 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
534 priv->grab_keyboard = NULL;
535 priv->grab_pointer = NULL;
537 g_signal_handlers_disconnect_by_func (priv->grab_widget,
538 G_CALLBACK (grab_key_callback),
543 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
546 /* do nothing, because we are pointless */
550 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
552 iface->start_editing = _gtk_cell_editable_event_box_start_editing;
555 typedef GtkEventBox GtkCellEditableEventBox;
556 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
558 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
559 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
564 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
569 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
573 static GtkCellEditable *
574 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
578 GdkRectangle *background_area,
579 GdkRectangle *cell_area,
580 GtkCellRendererState flags)
582 GtkCellRendererAccelPrivate *priv;
583 GtkCellRendererText *celltext;
584 GtkCellRendererAccel *accel;
588 GdkDevice *device, *keyb, *pointer;
593 celltext = GTK_CELL_RENDERER_TEXT (cell);
594 accel = GTK_CELL_RENDERER_ACCEL (cell);
597 /* If the cell isn't editable we return NULL. */
598 g_object_get (celltext, "editable", &editable, NULL);
599 if (editable == FALSE)
602 window = gtk_widget_get_window (widget);
603 style = gtk_widget_get_style (widget);
605 g_return_val_if_fail (window != NULL, NULL);
608 device = gdk_event_get_device (event);
610 device = gtk_get_current_event_device ();
615 if (device->source == GDK_SOURCE_KEYBOARD)
618 pointer = gdk_device_get_associated_device (device);
623 keyb = gdk_device_get_associated_device (device);
626 time = gdk_event_get_time (event);
628 if (gdk_device_grab (keyb, window,
629 GDK_OWNERSHIP_WINDOW, FALSE,
630 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
631 NULL, time) != GDK_GRAB_SUCCESS)
634 if (gdk_device_grab (pointer, window,
635 GDK_OWNERSHIP_WINDOW, FALSE,
636 GDK_BUTTON_PRESS_MASK,
637 NULL, time) != GDK_GRAB_SUCCESS)
639 gdk_device_ungrab (keyb, time);
643 priv->grab_keyboard = keyb;
644 priv->grab_pointer = pointer;
645 priv->grab_widget = widget;
647 g_signal_connect (G_OBJECT (widget), "key-press-event",
648 G_CALLBACK (grab_key_callback),
651 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
652 priv->edit_widget = eventbox;
653 g_object_add_weak_pointer (G_OBJECT (priv->edit_widget),
654 (gpointer) &priv->edit_widget);
656 label = gtk_label_new (NULL);
657 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
661 gtk_widget_modify_bg (eventbox, GTK_STATE_NORMAL,
662 &style->bg[GTK_STATE_SELECTED]);
664 gtk_widget_modify_fg (label, GTK_STATE_NORMAL,
665 &style->fg[GTK_STATE_SELECTED]);
667 /* This label is displayed in a treeview cell displaying
668 * an accelerator when the cell is clicked to change the
671 gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
673 gtk_container_add (GTK_CONTAINER (eventbox), label);
675 g_object_set_data_full (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text",
676 g_strdup (path), g_free);
678 gtk_widget_show_all (priv->edit_widget);
680 gtk_device_grab_add (priv->grab_widget, pointer, TRUE);
682 g_signal_connect (priv->edit_widget, "unrealize",
683 G_CALLBACK (ungrab_stuff), accel);
685 return GTK_CELL_EDITABLE (priv->edit_widget);