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 "gtkprivate.h"
34 static void gtk_cell_renderer_accel_get_property (GObject *object,
38 static void gtk_cell_renderer_accel_set_property (GObject *object,
42 static void gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
44 const GdkRectangle *cell_area,
49 static GtkCellEditable *
50 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
54 const GdkRectangle *background_area,
55 const GdkRectangle *cell_area,
56 GtkCellRendererState flags);
57 static gchar *convert_keysym_state_to_string (GtkCellRendererAccel *accel,
76 struct _GtkCellRendererAccelPrivate
78 GtkCellRendererAccelMode accel_mode;
80 GtkWidget *edit_widget;
81 GtkWidget *grab_widget;
82 GtkWidget *sizing_label;
84 GdkDevice *grab_keyboard;
85 GdkDevice *grab_pointer;
87 GdkModifierType accel_mods;
93 static guint signals[LAST_SIGNAL] = { 0 };
95 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
98 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
102 cell_accel->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell_accel,
103 GTK_TYPE_CELL_RENDERER_ACCEL,
104 GtkCellRendererAccelPrivate);
106 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
107 g_object_set (cell_accel, "text", text, NULL);
112 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
114 GObjectClass *object_class;
115 GtkCellRendererClass *cell_renderer_class;
117 object_class = G_OBJECT_CLASS (cell_accel_class);
118 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
120 object_class->set_property = gtk_cell_renderer_accel_set_property;
121 object_class->get_property = gtk_cell_renderer_accel_get_property;
123 cell_renderer_class->get_size = gtk_cell_renderer_accel_get_size;
124 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
127 * GtkCellRendererAccel:accel-key:
129 * The keyval of the accelerator.
133 g_object_class_install_property (object_class,
135 g_param_spec_uint ("accel-key",
136 P_("Accelerator key"),
137 P_("The keyval of the accelerator"),
141 GTK_PARAM_READWRITE));
144 * GtkCellRendererAccel:accel-mods:
146 * The modifier mask of the accelerator.
150 g_object_class_install_property (object_class,
152 g_param_spec_flags ("accel-mods",
153 P_("Accelerator modifiers"),
154 P_("The modifier mask of the accelerator"),
155 GDK_TYPE_MODIFIER_TYPE,
157 GTK_PARAM_READWRITE));
160 * GtkCellRendererAccel:keycode:
162 * The hardware keycode of the accelerator. Note that the hardware keycode is
163 * only relevant if the key does not have a keyval. Normally, the keyboard
164 * configuration should assign keyvals to all keys.
168 g_object_class_install_property (object_class,
170 g_param_spec_uint ("keycode",
171 P_("Accelerator keycode"),
172 P_("The hardware keycode of the accelerator"),
176 GTK_PARAM_READWRITE));
179 * GtkCellRendererAccel:accel-mode:
181 * Determines if the edited accelerators are GTK+ accelerators. If
182 * they are, consumed modifiers are suppressed, only accelerators
183 * accepted by GTK+ are allowed, and the accelerators are rendered
184 * in the same way as they are in menus.
188 g_object_class_install_property (object_class,
190 g_param_spec_enum ("accel-mode",
191 P_("Accelerator Mode"),
192 P_("The type of accelerators"),
193 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
194 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
195 GTK_PARAM_READWRITE));
198 * GtkCellRendererAccel::accel-edited:
199 * @accel: the object reveiving the signal
200 * @path_string: the path identifying the row of the edited cell
201 * @accel_key: the new accelerator keyval
202 * @accel_mods: the new acclerator modifier mask
203 * @hardware_keycode: the keycode of the new accelerator
205 * Gets emitted when the user has selected a new accelerator.
209 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
210 GTK_TYPE_CELL_RENDERER_ACCEL,
212 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
214 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
218 GDK_TYPE_MODIFIER_TYPE,
222 * GtkCellRendererAccel::accel-cleared:
223 * @accel: the object reveiving the signal
224 * @path_string: the path identifying the row of the edited cell
226 * Gets emitted when the user has removed the accelerator.
230 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
231 GTK_TYPE_CELL_RENDERER_ACCEL,
233 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
235 g_cclosure_marshal_VOID__STRING,
239 g_type_class_add_private (cell_accel_class, sizeof (GtkCellRendererAccelPrivate));
244 * gtk_cell_renderer_accel_new:
246 * Creates a new #GtkCellRendererAccel.
248 * Returns: the new cell renderer
253 gtk_cell_renderer_accel_new (void)
255 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
259 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
261 GdkModifierType mask,
264 GtkCellRendererAccelPrivate *priv = accel->priv;
266 if (keysym == 0 && keycode == 0)
267 /* This label is displayed in a treeview cell displaying
268 * a disabled accelerator key combination.
270 return g_strdup (C_("Accelerator", "Disabled"));
273 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
275 if (!gtk_accelerator_valid (keysym, mask))
276 /* This label is displayed in a treeview cell displaying
277 * an accelerator key combination that is not valid according
278 * to gtk_accelerator_valid().
280 return g_strdup (C_("Accelerator", "Invalid"));
282 return gtk_accelerator_get_label (keysym, mask);
288 name = gtk_accelerator_get_label (keysym, mask);
290 name = gtk_accelerator_name (keysym, mask);
297 name = g_strdup_printf ("%s0x%02x", tmp, keycode);
307 gtk_cell_renderer_accel_get_property (GObject *object,
312 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (object)->priv;
317 g_value_set_uint (value, priv->accel_key);
320 case PROP_ACCEL_MODS:
321 g_value_set_flags (value, priv->accel_mods);
325 g_value_set_uint (value, priv->keycode);
328 case PROP_ACCEL_MODE:
329 g_value_set_enum (value, priv->accel_mode);
333 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
338 gtk_cell_renderer_accel_set_property (GObject *object,
343 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
344 GtkCellRendererAccelPrivate *priv = accel->priv;
345 gboolean changed = FALSE;
351 guint accel_key = g_value_get_uint (value);
353 if (priv->accel_key != accel_key)
355 priv->accel_key = accel_key;
361 case PROP_ACCEL_MODS:
363 guint accel_mods = g_value_get_flags (value);
365 if (priv->accel_mods != accel_mods)
367 priv->accel_mods = accel_mods;
374 guint keycode = g_value_get_uint (value);
376 if (priv->keycode != keycode)
378 priv->keycode = keycode;
384 case PROP_ACCEL_MODE:
385 priv->accel_mode = g_value_get_enum (value);
389 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
396 text = convert_keysym_state_to_string (accel, priv->accel_key, priv->accel_mods, priv->keycode);
397 g_object_set (accel, "text", text, NULL);
403 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
405 const GdkRectangle *cell_area,
412 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (cell)->priv;
413 GtkRequisition requisition;
415 if (priv->sizing_label == NULL)
416 priv->sizing_label = gtk_label_new (_("New accelerator..."));
418 gtk_widget_get_preferred_size (priv->sizing_label, &requisition, NULL);
420 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
421 x_offset, y_offset, width, height);
423 /* FIXME: need to take the cell_area et al. into account */
425 *width = MAX (*width, requisition.width);
427 *height = MAX (*height, requisition.height);
431 grab_key_callback (GtkWidget *widget,
433 GtkCellRendererAccel *accel)
435 GtkCellRendererAccelPrivate *priv = accel->priv;
436 GdkModifierType accel_mods = 0;
441 GdkModifierType consumed_modifiers;
444 display = gtk_widget_get_display (widget);
446 if (event->is_modifier)
452 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
453 event->hardware_keycode,
456 NULL, NULL, NULL, &consumed_modifiers);
458 accel_key = gdk_keyval_to_lower (event->keyval);
459 if (accel_key == GDK_KEY_ISO_Left_Tab)
460 accel_key = GDK_KEY_Tab;
462 accel_mods = event->state & gtk_accelerator_get_default_mod_mask ();
464 /* Filter consumed modifiers
466 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
467 accel_mods &= ~consumed_modifiers;
469 /* Put shift back if it changed the case of the key, not otherwise.
471 if (accel_key != event->keyval)
472 accel_mods |= GDK_SHIFT_MASK;
476 switch (event->keyval)
479 goto out; /* cancel */
480 case GDK_KEY_BackSpace:
481 /* clear the accelerator on Backspace */
489 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
491 if (!gtk_accelerator_valid (accel_key, accel_mods))
493 gtk_widget_error_bell (widget);
502 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
503 gdk_device_ungrab (priv->grab_keyboard, event->time);
504 gdk_device_ungrab (priv->grab_pointer, event->time);
506 path = g_strdup (g_object_get_data (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text"));
508 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (priv->edit_widget));
509 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (priv->edit_widget));
510 priv->edit_widget = NULL;
511 priv->grab_widget = NULL;
512 priv->grab_keyboard = NULL;
513 priv->grab_pointer = NULL;
516 g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
517 accel_key, accel_mods, event->hardware_keycode);
519 g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
527 ungrab_stuff (GtkWidget *widget,
528 GtkCellRendererAccel *accel)
530 GtkCellRendererAccelPrivate *priv = accel->priv;
532 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
533 gdk_device_ungrab (priv->grab_keyboard, GDK_CURRENT_TIME);
534 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
536 priv->grab_keyboard = NULL;
537 priv->grab_pointer = NULL;
539 g_signal_handlers_disconnect_by_func (priv->grab_widget,
540 G_CALLBACK (grab_key_callback),
545 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
548 /* do nothing, because we are pointless */
552 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
554 iface->start_editing = _gtk_cell_editable_event_box_start_editing;
557 typedef GtkEventBox GtkCellEditableEventBox;
558 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
560 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
561 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
566 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
571 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
575 static GtkCellEditable *
576 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
580 const GdkRectangle *background_area,
581 const GdkRectangle *cell_area,
582 GtkCellRendererState flags)
584 GtkCellRendererAccelPrivate *priv;
585 GtkCellRendererText *celltext;
586 GtkCellRendererAccel *accel;
590 GdkDevice *device, *keyb, *pointer;
595 celltext = GTK_CELL_RENDERER_TEXT (cell);
596 accel = GTK_CELL_RENDERER_ACCEL (cell);
599 /* If the cell isn't editable we return NULL. */
600 g_object_get (celltext, "editable", &editable, NULL);
601 if (editable == FALSE)
604 window = gtk_widget_get_window (widget);
605 style = gtk_widget_get_style (widget);
607 g_return_val_if_fail (window != NULL, NULL);
610 device = gdk_event_get_device (event);
612 device = gtk_get_current_event_device ();
617 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
620 pointer = gdk_device_get_associated_device (device);
625 keyb = gdk_device_get_associated_device (device);
628 time = gdk_event_get_time (event);
630 if (gdk_device_grab (keyb, window,
631 GDK_OWNERSHIP_WINDOW, FALSE,
632 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
633 NULL, time) != GDK_GRAB_SUCCESS)
636 if (gdk_device_grab (pointer, window,
637 GDK_OWNERSHIP_WINDOW, FALSE,
638 GDK_BUTTON_PRESS_MASK,
639 NULL, time) != GDK_GRAB_SUCCESS)
641 gdk_device_ungrab (keyb, time);
645 priv->grab_keyboard = keyb;
646 priv->grab_pointer = pointer;
647 priv->grab_widget = widget;
649 g_signal_connect (G_OBJECT (widget), "key-press-event",
650 G_CALLBACK (grab_key_callback),
653 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
654 priv->edit_widget = eventbox;
655 g_object_add_weak_pointer (G_OBJECT (priv->edit_widget),
656 (gpointer) &priv->edit_widget);
658 label = gtk_label_new (NULL);
659 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
663 gtk_widget_modify_bg (eventbox, GTK_STATE_NORMAL,
664 &style->bg[GTK_STATE_SELECTED]);
666 gtk_widget_modify_fg (label, GTK_STATE_NORMAL,
667 &style->fg[GTK_STATE_SELECTED]);
669 /* This label is displayed in a treeview cell displaying
670 * an accelerator when the cell is clicked to change the
673 gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
675 gtk_container_add (GTK_CONTAINER (eventbox), label);
677 g_object_set_data_full (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text",
678 g_strdup (path), g_free);
680 gtk_widget_show_all (priv->edit_widget);
682 gtk_device_grab_add (priv->grab_widget, pointer, TRUE);
684 g_signal_connect (priv->edit_widget, "unrealize",
685 G_CALLBACK (ungrab_stuff), accel);
687 return GTK_CELL_EDITABLE (priv->edit_widget);