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"
33 #define GTK_CELL_RENDERER_ACCEL_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_CELL_RENDERER_ACCEL, GtkCellRendererAccelPrivate))
35 static void gtk_cell_renderer_accel_get_property (GObject *object,
39 static void gtk_cell_renderer_accel_set_property (GObject *object,
43 static void gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
45 GdkRectangle *cell_area,
50 static GtkCellEditable *
51 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
55 GdkRectangle *background_area,
56 GdkRectangle *cell_area,
57 GtkCellRendererState flags);
58 static gchar *convert_keysym_state_to_string (GtkCellRendererAccel *accel,
77 typedef struct GtkCellRendererAccelPrivate GtkCellRendererAccelPrivate;
79 struct GtkCellRendererAccelPrivate
81 GdkDevice *grab_keyboard;
82 GdkDevice *grab_pointer;
85 static guint signals[LAST_SIGNAL] = { 0 };
87 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
90 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
94 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
95 g_object_set (cell_accel, "text", text, NULL);
100 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
102 GObjectClass *object_class;
103 GtkCellRendererClass *cell_renderer_class;
105 object_class = G_OBJECT_CLASS (cell_accel_class);
106 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
108 object_class->set_property = gtk_cell_renderer_accel_set_property;
109 object_class->get_property = gtk_cell_renderer_accel_get_property;
111 cell_renderer_class->get_size = gtk_cell_renderer_accel_get_size;
112 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
115 * GtkCellRendererAccel:accel-key:
117 * The keyval of the accelerator.
121 g_object_class_install_property (object_class,
123 g_param_spec_uint ("accel-key",
124 P_("Accelerator key"),
125 P_("The keyval of the accelerator"),
129 GTK_PARAM_READWRITE));
132 * GtkCellRendererAccel:accel-mods:
134 * The modifier mask of the accelerator.
138 g_object_class_install_property (object_class,
140 g_param_spec_flags ("accel-mods",
141 P_("Accelerator modifiers"),
142 P_("The modifier mask of the accelerator"),
143 GDK_TYPE_MODIFIER_TYPE,
145 GTK_PARAM_READWRITE));
148 * GtkCellRendererAccel:keycode:
150 * The hardware keycode of the accelerator. Note that the hardware keycode is
151 * only relevant if the key does not have a keyval. Normally, the keyboard
152 * configuration should assign keyvals to all keys.
156 g_object_class_install_property (object_class,
158 g_param_spec_uint ("keycode",
159 P_("Accelerator keycode"),
160 P_("The hardware keycode of the accelerator"),
164 GTK_PARAM_READWRITE));
167 * GtkCellRendererAccel:accel-mode:
169 * Determines if the edited accelerators are GTK+ accelerators. If
170 * they are, consumed modifiers are suppressed, only accelerators
171 * accepted by GTK+ are allowed, and the accelerators are rendered
172 * in the same way as they are in menus.
176 g_object_class_install_property (object_class,
178 g_param_spec_enum ("accel-mode",
179 P_("Accelerator Mode"),
180 P_("The type of accelerators"),
181 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
182 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
183 GTK_PARAM_READWRITE));
186 * GtkCellRendererAccel::accel-edited:
187 * @accel: the object reveiving the signal
188 * @path_string: the path identifying the row of the edited cell
189 * @accel_key: the new accelerator keyval
190 * @accel_mods: the new acclerator modifier mask
191 * @hardware_keycode: the keycode of the new accelerator
193 * Gets emitted when the user has selected a new accelerator.
197 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
198 GTK_TYPE_CELL_RENDERER_ACCEL,
200 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
202 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
206 GDK_TYPE_MODIFIER_TYPE,
210 * GtkCellRendererAccel::accel-cleared:
211 * @accel: the object reveiving the signal
212 * @path_string: the path identifying the row of the edited cell
214 * Gets emitted when the user has removed the accelerator.
218 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
219 GTK_TYPE_CELL_RENDERER_ACCEL,
221 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
223 g_cclosure_marshal_VOID__STRING,
227 g_type_class_add_private (object_class, sizeof (GtkCellRendererAccelPrivate));
232 * gtk_cell_renderer_accel_new:
234 * Creates a new #GtkCellRendererAccel.
236 * Returns: the new cell renderer
241 gtk_cell_renderer_accel_new (void)
243 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
247 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
249 GdkModifierType mask,
252 if (keysym == 0 && keycode == 0)
253 /* This label is displayed in a treeview cell displaying
254 * a disabled accelerator key combination.
256 return g_strdup (C_("Accelerator", "Disabled"));
259 if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
261 if (!gtk_accelerator_valid (keysym, mask))
262 /* This label is displayed in a treeview cell displaying
263 * an accelerator key combination that is not valid according
264 * to gtk_accelerator_valid().
266 return g_strdup (C_("Accelerator", "Invalid"));
268 return gtk_accelerator_get_label (keysym, mask);
274 name = gtk_accelerator_get_label (keysym, mask);
276 name = gtk_accelerator_name (keysym, mask);
283 name = g_strdup_printf ("%s0x%02x", tmp, keycode);
293 gtk_cell_renderer_accel_get_property (GObject *object,
298 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
303 g_value_set_uint (value, accel->accel_key);
306 case PROP_ACCEL_MODS:
307 g_value_set_flags (value, accel->accel_mods);
311 g_value_set_uint (value, accel->keycode);
314 case PROP_ACCEL_MODE:
315 g_value_set_enum (value, accel->accel_mode);
319 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
324 gtk_cell_renderer_accel_set_property (GObject *object,
329 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
330 gboolean changed = FALSE;
336 guint accel_key = g_value_get_uint (value);
338 if (accel->accel_key != accel_key)
340 accel->accel_key = accel_key;
346 case PROP_ACCEL_MODS:
348 guint accel_mods = g_value_get_flags (value);
350 if (accel->accel_mods != accel_mods)
352 accel->accel_mods = accel_mods;
359 guint keycode = g_value_get_uint (value);
361 if (accel->keycode != keycode)
363 accel->keycode = keycode;
369 case PROP_ACCEL_MODE:
370 accel->accel_mode = g_value_get_enum (value);
374 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
381 text = convert_keysym_state_to_string (accel, accel->accel_key, accel->accel_mods, accel->keycode);
382 g_object_set (accel, "text", text, NULL);
388 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
390 GdkRectangle *cell_area,
397 GtkCellRendererAccel *accel = (GtkCellRendererAccel *) cell;
398 GtkRequisition requisition;
400 if (accel->sizing_label == NULL)
401 accel->sizing_label = gtk_label_new (_("New accelerator..."));
403 gtk_widget_size_request (accel->sizing_label, &requisition);
405 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
406 x_offset, y_offset, width, height);
408 /* FIXME: need to take the cell_area et al. into account */
410 *width = MAX (*width, requisition.width);
412 *height = MAX (*height, requisition.height);
416 grab_key_callback (GtkWidget *widget,
418 GtkCellRendererAccel *accel)
420 GtkCellRendererAccelPrivate *priv;
421 GdkModifierType accel_mods = 0;
426 GdkModifierType consumed_modifiers;
429 priv = GTK_CELL_RENDERER_ACCEL_GET_PRIVATE (accel);
430 display = gtk_widget_get_display (widget);
432 if (event->is_modifier)
438 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
439 event->hardware_keycode,
442 NULL, NULL, NULL, &consumed_modifiers);
444 accel_key = gdk_keyval_to_lower (event->keyval);
445 if (accel_key == GDK_ISO_Left_Tab)
448 accel_mods = event->state & gtk_accelerator_get_default_mod_mask ();
450 /* Filter consumed modifiers
452 if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
453 accel_mods &= ~consumed_modifiers;
455 /* Put shift back if it changed the case of the key, not otherwise.
457 if (accel_key != event->keyval)
458 accel_mods |= GDK_SHIFT_MASK;
462 switch (event->keyval)
465 goto out; /* cancel */
467 /* clear the accelerator on Backspace */
475 if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
477 if (!gtk_accelerator_valid (accel_key, accel_mods))
479 gtk_widget_error_bell (widget);
488 gtk_device_grab_remove (accel->grab_widget, priv->grab_pointer);
489 gdk_device_ungrab (priv->grab_keyboard, event->time);
490 gdk_device_ungrab (priv->grab_pointer, event->time);
492 path = g_strdup (g_object_get_data (G_OBJECT (accel->edit_widget), "gtk-cell-renderer-text"));
494 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (accel->edit_widget));
495 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (accel->edit_widget));
496 accel->edit_widget = NULL;
497 accel->grab_widget = NULL;
498 priv->grab_keyboard = NULL;
499 priv->grab_pointer = NULL;
502 g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
503 accel_key, accel_mods, event->hardware_keycode);
505 g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
513 ungrab_stuff (GtkWidget *widget,
514 GtkCellRendererAccel *accel)
516 GtkCellRendererAccelPrivate *priv;
518 priv = GTK_CELL_RENDERER_ACCEL_GET_PRIVATE (accel);
520 gtk_device_grab_remove (accel->grab_widget, priv->grab_pointer);
521 gdk_device_ungrab (priv->grab_keyboard, GDK_CURRENT_TIME);
522 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
524 priv->grab_keyboard = NULL;
525 priv->grab_pointer = NULL;
527 g_signal_handlers_disconnect_by_func (G_OBJECT (accel->grab_widget),
528 G_CALLBACK (grab_key_callback),
533 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
536 /* do nothing, because we are pointless */
540 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
542 iface->start_editing = _gtk_cell_editable_event_box_start_editing;
545 typedef GtkEventBox GtkCellEditableEventBox;
546 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
548 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
549 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
554 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
559 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
563 static GtkCellEditable *
564 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
568 GdkRectangle *background_area,
569 GdkRectangle *cell_area,
570 GtkCellRendererState flags)
572 GtkCellRendererAccelPrivate *priv;
573 GtkCellRendererText *celltext;
574 GtkCellRendererAccel *accel;
577 GdkDevice *device, *keyb, *pointer;
580 celltext = GTK_CELL_RENDERER_TEXT (cell);
581 accel = GTK_CELL_RENDERER_ACCEL (cell);
582 priv = GTK_CELL_RENDERER_ACCEL_GET_PRIVATE (cell);
584 /* If the cell isn't editable we return NULL. */
585 if (celltext->editable == FALSE)
588 g_return_val_if_fail (widget->window != NULL, NULL);
591 device = gdk_event_get_device (event);
593 device = gtk_get_current_event_device ();
598 if (device->source == GDK_SOURCE_KEYBOARD)
601 pointer = gdk_device_get_associated_device (device);
606 keyb = gdk_device_get_associated_device (device);
609 time = gdk_event_get_time (event);
611 if (gdk_device_grab (keyb, widget->window,
612 GDK_OWNERSHIP_WINDOW, FALSE,
613 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
614 NULL, time) != GDK_GRAB_SUCCESS)
617 if (gdk_device_grab (pointer, widget->window,
618 GDK_OWNERSHIP_WINDOW, FALSE,
619 GDK_BUTTON_PRESS_MASK,
620 NULL, time) != GDK_GRAB_SUCCESS)
622 gdk_device_ungrab (keyb, time);
626 priv->grab_keyboard = keyb;
627 priv->grab_pointer = pointer;
628 accel->grab_widget = widget;
630 g_signal_connect (G_OBJECT (widget), "key-press-event",
631 G_CALLBACK (grab_key_callback),
634 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
635 accel->edit_widget = eventbox;
636 g_object_add_weak_pointer (G_OBJECT (accel->edit_widget),
637 (gpointer) &accel->edit_widget);
639 label = gtk_label_new (NULL);
640 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
642 gtk_widget_modify_bg (eventbox, GTK_STATE_NORMAL,
643 &widget->style->bg[GTK_STATE_SELECTED]);
645 gtk_widget_modify_fg (label, GTK_STATE_NORMAL,
646 &widget->style->fg[GTK_STATE_SELECTED]);
648 /* This label is displayed in a treeview cell displaying
649 * an accelerator when the cell is clicked to change the
652 gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
654 gtk_container_add (GTK_CONTAINER (eventbox), label);
656 g_object_set_data_full (G_OBJECT (accel->edit_widget), "gtk-cell-renderer-text",
657 g_strdup (path), g_free);
659 gtk_widget_show_all (accel->edit_widget);
661 gtk_device_grab_add (accel->grab_widget, pointer, TRUE);
663 g_signal_connect (G_OBJECT (accel->edit_widget), "unrealize",
664 G_CALLBACK (ungrab_stuff), accel);
666 return GTK_CELL_EDITABLE (accel->edit_widget);
670 #define __GTK_CELL_RENDERER_ACCEL_C__
671 #include "gtkaliasdef.c"