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"
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 const GdkRectangle *cell_area,
50 static GtkCellEditable *
51 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
55 const GdkRectangle *background_area,
56 const GdkRectangle *cell_area,
57 GtkCellRendererState flags);
58 static gchar *convert_keysym_state_to_string (GtkCellRendererAccel *accel,
77 struct _GtkCellRendererAccelPrivate
79 GtkCellRendererAccelMode accel_mode;
81 GtkWidget *edit_widget;
82 GtkWidget *grab_widget;
83 GtkWidget *sizing_label;
85 GdkDevice *grab_keyboard;
86 GdkDevice *grab_pointer;
88 GdkModifierType accel_mods;
94 static guint signals[LAST_SIGNAL] = { 0 };
96 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
99 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
103 cell_accel->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell_accel,
104 GTK_TYPE_CELL_RENDERER_ACCEL,
105 GtkCellRendererAccelPrivate);
107 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
108 g_object_set (cell_accel, "text", text, NULL);
113 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
115 GObjectClass *object_class;
116 GtkCellRendererClass *cell_renderer_class;
118 object_class = G_OBJECT_CLASS (cell_accel_class);
119 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
121 object_class->set_property = gtk_cell_renderer_accel_set_property;
122 object_class->get_property = gtk_cell_renderer_accel_get_property;
124 cell_renderer_class->get_size = gtk_cell_renderer_accel_get_size;
125 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
128 * GtkCellRendererAccel:accel-key:
130 * The keyval of the accelerator.
134 g_object_class_install_property (object_class,
136 g_param_spec_uint ("accel-key",
137 P_("Accelerator key"),
138 P_("The keyval of the accelerator"),
142 GTK_PARAM_READWRITE));
145 * GtkCellRendererAccel:accel-mods:
147 * The modifier mask of the accelerator.
151 g_object_class_install_property (object_class,
153 g_param_spec_flags ("accel-mods",
154 P_("Accelerator modifiers"),
155 P_("The modifier mask of the accelerator"),
156 GDK_TYPE_MODIFIER_TYPE,
158 GTK_PARAM_READWRITE));
161 * GtkCellRendererAccel:keycode:
163 * The hardware keycode of the accelerator. Note that the hardware keycode is
164 * only relevant if the key does not have a keyval. Normally, the keyboard
165 * configuration should assign keyvals to all keys.
169 g_object_class_install_property (object_class,
171 g_param_spec_uint ("keycode",
172 P_("Accelerator keycode"),
173 P_("The hardware keycode of the accelerator"),
177 GTK_PARAM_READWRITE));
180 * GtkCellRendererAccel:accel-mode:
182 * Determines if the edited accelerators are GTK+ accelerators. If
183 * they are, consumed modifiers are suppressed, only accelerators
184 * accepted by GTK+ are allowed, and the accelerators are rendered
185 * in the same way as they are in menus.
189 g_object_class_install_property (object_class,
191 g_param_spec_enum ("accel-mode",
192 P_("Accelerator Mode"),
193 P_("The type of accelerators"),
194 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
195 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
196 GTK_PARAM_READWRITE));
199 * GtkCellRendererAccel::accel-edited:
200 * @accel: the object reveiving the signal
201 * @path_string: the path identifying the row of the edited cell
202 * @accel_key: the new accelerator keyval
203 * @accel_mods: the new acclerator modifier mask
204 * @hardware_keycode: the keycode of the new accelerator
206 * Gets emitted when the user has selected a new accelerator.
210 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
211 GTK_TYPE_CELL_RENDERER_ACCEL,
213 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
215 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
219 GDK_TYPE_MODIFIER_TYPE,
223 * GtkCellRendererAccel::accel-cleared:
224 * @accel: the object reveiving the signal
225 * @path_string: the path identifying the row of the edited cell
227 * Gets emitted when the user has removed the accelerator.
231 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
232 GTK_TYPE_CELL_RENDERER_ACCEL,
234 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
236 g_cclosure_marshal_VOID__STRING,
240 g_type_class_add_private (cell_accel_class, sizeof (GtkCellRendererAccelPrivate));
245 * gtk_cell_renderer_accel_new:
247 * Creates a new #GtkCellRendererAccel.
249 * Returns: the new cell renderer
254 gtk_cell_renderer_accel_new (void)
256 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
260 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
262 GdkModifierType mask,
265 GtkCellRendererAccelPrivate *priv = accel->priv;
267 if (keysym == 0 && keycode == 0)
268 /* This label is displayed in a treeview cell displaying
269 * a disabled accelerator key combination.
271 return g_strdup (C_("Accelerator", "Disabled"));
274 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
276 if (!gtk_accelerator_valid (keysym, mask))
277 /* This label is displayed in a treeview cell displaying
278 * an accelerator key combination that is not valid according
279 * to gtk_accelerator_valid().
281 return g_strdup (C_("Accelerator", "Invalid"));
283 return gtk_accelerator_get_label (keysym, mask);
289 name = gtk_accelerator_get_label (keysym, mask);
291 name = gtk_accelerator_name (keysym, mask);
298 name = g_strdup_printf ("%s0x%02x", tmp, keycode);
308 gtk_cell_renderer_accel_get_property (GObject *object,
313 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (object)->priv;
318 g_value_set_uint (value, priv->accel_key);
321 case PROP_ACCEL_MODS:
322 g_value_set_flags (value, priv->accel_mods);
326 g_value_set_uint (value, priv->keycode);
329 case PROP_ACCEL_MODE:
330 g_value_set_enum (value, priv->accel_mode);
334 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
339 gtk_cell_renderer_accel_set_property (GObject *object,
344 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
345 GtkCellRendererAccelPrivate *priv = accel->priv;
346 gboolean changed = FALSE;
352 guint accel_key = g_value_get_uint (value);
354 if (priv->accel_key != accel_key)
356 priv->accel_key = accel_key;
362 case PROP_ACCEL_MODS:
364 guint accel_mods = g_value_get_flags (value);
366 if (priv->accel_mods != accel_mods)
368 priv->accel_mods = accel_mods;
375 guint keycode = g_value_get_uint (value);
377 if (priv->keycode != keycode)
379 priv->keycode = keycode;
385 case PROP_ACCEL_MODE:
386 priv->accel_mode = g_value_get_enum (value);
390 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
397 text = convert_keysym_state_to_string (accel, priv->accel_key, priv->accel_mods, priv->keycode);
398 g_object_set (accel, "text", text, NULL);
404 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
406 const GdkRectangle *cell_area,
413 GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (cell)->priv;
414 GtkRequisition requisition;
416 if (priv->sizing_label == NULL)
417 priv->sizing_label = gtk_label_new (_("New accelerator..."));
419 gtk_widget_get_preferred_size (priv->sizing_label, &requisition, NULL);
421 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
422 x_offset, y_offset, width, height);
424 /* FIXME: need to take the cell_area et al. into account */
426 *width = MAX (*width, requisition.width);
428 *height = MAX (*height, requisition.height);
432 grab_key_callback (GtkWidget *widget,
434 GtkCellRendererAccel *accel)
436 GtkCellRendererAccelPrivate *priv = accel->priv;
437 GdkModifierType accel_mods = 0;
442 GdkModifierType consumed_modifiers;
445 display = gtk_widget_get_display (widget);
447 if (event->is_modifier)
453 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
454 event->hardware_keycode,
457 NULL, NULL, NULL, &consumed_modifiers);
459 accel_key = gdk_keyval_to_lower (event->keyval);
460 if (accel_key == GDK_KEY_ISO_Left_Tab)
461 accel_key = GDK_KEY_Tab;
463 accel_mods = event->state & gtk_accelerator_get_default_mod_mask ();
465 /* Filter consumed modifiers
467 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
468 accel_mods &= ~consumed_modifiers;
470 /* Put shift back if it changed the case of the key, not otherwise.
472 if (accel_key != event->keyval)
473 accel_mods |= GDK_SHIFT_MASK;
477 switch (event->keyval)
480 goto out; /* cancel */
481 case GDK_KEY_BackSpace:
482 /* clear the accelerator on Backspace */
490 if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
492 if (!gtk_accelerator_valid (accel_key, accel_mods))
494 gtk_widget_error_bell (widget);
503 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
504 gdk_device_ungrab (priv->grab_keyboard, event->time);
505 gdk_device_ungrab (priv->grab_pointer, event->time);
507 path = g_strdup (g_object_get_data (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text"));
509 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (priv->edit_widget));
510 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (priv->edit_widget));
511 priv->edit_widget = NULL;
512 priv->grab_widget = NULL;
513 priv->grab_keyboard = NULL;
514 priv->grab_pointer = NULL;
517 g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
518 accel_key, accel_mods, event->hardware_keycode);
520 g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
528 ungrab_stuff (GtkWidget *widget,
529 GtkCellRendererAccel *accel)
531 GtkCellRendererAccelPrivate *priv = accel->priv;
533 gtk_device_grab_remove (priv->grab_widget, priv->grab_pointer);
534 gdk_device_ungrab (priv->grab_keyboard, GDK_CURRENT_TIME);
535 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
537 priv->grab_keyboard = NULL;
538 priv->grab_pointer = NULL;
540 g_signal_handlers_disconnect_by_func (priv->grab_widget,
541 G_CALLBACK (grab_key_callback),
546 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
549 /* do nothing, because we are pointless */
553 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
555 iface->start_editing = _gtk_cell_editable_event_box_start_editing;
558 typedef struct _GtkCellEditableEventBox GtkCellEditableEventBox;
559 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
561 struct _GtkCellEditableEventBox
564 gboolean editing_canceled;
567 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
568 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
573 PROP_EDITING_CANCELED
577 gtk_cell_editable_event_box_set_property (GObject *object,
582 GtkCellEditableEventBox *box = (GtkCellEditableEventBox*)object;
586 case PROP_EDITING_CANCELED:
587 box->editing_canceled = g_value_get_boolean (value);
590 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
596 gtk_cell_editable_event_box_get_property (GObject *object,
601 GtkCellEditableEventBox *box = (GtkCellEditableEventBox*)object;
605 case PROP_EDITING_CANCELED:
606 g_value_set_boolean (value, box->editing_canceled);
609 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
615 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
617 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
619 gobject_class->set_property = gtk_cell_editable_event_box_set_property;
620 gobject_class->get_property = gtk_cell_editable_event_box_get_property;
622 g_object_class_override_property (gobject_class,
623 PROP_EDITING_CANCELED,
628 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
632 static GtkCellEditable *
633 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
637 const GdkRectangle *background_area,
638 const GdkRectangle *cell_area,
639 GtkCellRendererState flags)
641 GtkCellRendererAccelPrivate *priv;
642 GtkCellRendererText *celltext;
643 GtkCellRendererAccel *accel;
647 GdkDevice *device, *keyb, *pointer;
652 celltext = GTK_CELL_RENDERER_TEXT (cell);
653 accel = GTK_CELL_RENDERER_ACCEL (cell);
656 /* If the cell isn't editable we return NULL. */
657 g_object_get (celltext, "editable", &editable, NULL);
658 if (editable == FALSE)
661 window = gtk_widget_get_window (widget);
662 style = gtk_widget_get_style (widget);
664 g_return_val_if_fail (window != NULL, NULL);
667 device = gdk_event_get_device (event);
669 device = gtk_get_current_event_device ();
674 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
677 pointer = gdk_device_get_associated_device (device);
682 keyb = gdk_device_get_associated_device (device);
685 time = gdk_event_get_time (event);
687 if (gdk_device_grab (keyb, window,
688 GDK_OWNERSHIP_WINDOW, FALSE,
689 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
690 NULL, time) != GDK_GRAB_SUCCESS)
693 if (gdk_device_grab (pointer, window,
694 GDK_OWNERSHIP_WINDOW, FALSE,
695 GDK_BUTTON_PRESS_MASK,
696 NULL, time) != GDK_GRAB_SUCCESS)
698 gdk_device_ungrab (keyb, time);
702 priv->grab_keyboard = keyb;
703 priv->grab_pointer = pointer;
704 priv->grab_widget = widget;
706 g_signal_connect (G_OBJECT (widget), "key-press-event",
707 G_CALLBACK (grab_key_callback),
710 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
711 priv->edit_widget = eventbox;
712 g_object_add_weak_pointer (G_OBJECT (priv->edit_widget),
713 (gpointer) &priv->edit_widget);
715 label = gtk_label_new (NULL);
716 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
720 gtk_widget_modify_bg (eventbox, GTK_STATE_NORMAL,
721 &style->bg[GTK_STATE_SELECTED]);
723 gtk_widget_modify_fg (label, GTK_STATE_NORMAL,
724 &style->fg[GTK_STATE_SELECTED]);
726 /* This label is displayed in a treeview cell displaying
727 * an accelerator when the cell is clicked to change the
730 gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
732 gtk_container_add (GTK_CONTAINER (eventbox), label);
734 g_object_set_data_full (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text",
735 g_strdup (path), g_free);
737 gtk_widget_show_all (priv->edit_widget);
739 gtk_device_grab_add (priv->grab_widget, pointer, TRUE);
741 g_signal_connect (priv->edit_widget, "unrealize",
742 G_CALLBACK (ungrab_stuff), accel);
744 return GTK_CELL_EDITABLE (priv->edit_widget);