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"
27 #include "gtkprivate.h"
28 #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 static guint signals[LAST_SIGNAL] = { 0 };
76 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
79 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
83 text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
84 g_object_set (cell_accel, "text", text, NULL);
89 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
91 GObjectClass *object_class;
92 GtkCellRendererClass *cell_renderer_class;
94 object_class = G_OBJECT_CLASS (cell_accel_class);
95 cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
97 object_class->set_property = gtk_cell_renderer_accel_set_property;
98 object_class->get_property = gtk_cell_renderer_accel_get_property;
100 cell_renderer_class->get_size = gtk_cell_renderer_accel_get_size;
101 cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
104 * GtkCellRendererAccel:accel-key:
106 * The keyval of the accelerator.
110 g_object_class_install_property (object_class,
112 g_param_spec_uint ("accel-key",
113 P_("Accelerator key"),
114 P_("The keyval of the accelerator"),
118 GTK_PARAM_READWRITE));
121 * GtkCellRendererAccel:accel-mods:
123 * The modifier mask of the accelerator.
127 g_object_class_install_property (object_class,
129 g_param_spec_flags ("accel-mods",
130 P_("Accelerator modifiers"),
131 P_("The modifier mask of the accelerator"),
132 GDK_TYPE_MODIFIER_TYPE,
134 GTK_PARAM_READWRITE));
137 * GtkCellRendererAccel:keycode:
139 * The hardware keycode of the accelerator. Note that the hardware keycode is
140 * only relevant if the key does not have a keyval. Normally, the keyboard
141 * configuration should assign keyvals to all keys.
145 g_object_class_install_property (object_class,
147 g_param_spec_uint ("keycode",
148 P_("Accelerator keycode"),
149 P_("The hardware keycode of the accelerator"),
153 GTK_PARAM_READWRITE));
156 * GtkCellRendererAccel:accel-mode:
158 * Determines if the edited accelerators are GTK+ accelerators. If
159 * they are, consumed modifiers are suppressed, only accelerators
160 * accepted by GTK+ are allowed, and the accelerators are rendered
161 * in the same way as they are in menus.
165 g_object_class_install_property (object_class,
167 g_param_spec_enum ("accel-mode",
168 P_("Accelerator Mode"),
169 P_("The type of accelerators"),
170 GTK_TYPE_CELL_RENDERER_ACCEL_MODE,
171 GTK_CELL_RENDERER_ACCEL_MODE_GTK,
172 GTK_PARAM_READWRITE));
175 * GtkCellRendererAccel::accel-edited:
176 * @accel: the object reveiving the signal
177 * @path_string: the path identifying the row of the edited cell
178 * @accel_key: the new accelerator keyval
179 * @accel_mods: the new acclerator modifier mask
180 * @hardware_keycode: the keycode of the new accelerator
182 * Gets emitted when the user has selected a new accelerator.
186 signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
187 GTK_TYPE_CELL_RENDERER_ACCEL,
189 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
191 _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
195 GDK_TYPE_MODIFIER_TYPE,
199 * GtkCellRendererAccel::accel-cleared:
200 * @accel: the object reveiving the signal
201 * @path_string: the path identifying the row of the edited cell
203 * Gets emitted when the user has removed the accelerator.
207 signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
208 GTK_TYPE_CELL_RENDERER_ACCEL,
210 G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
212 g_cclosure_marshal_VOID__STRING,
219 * gtk_cell_renderer_accel_new:
221 * Creates a new #GtkCellRendererAccel.
223 * Returns: the new cell renderer
228 gtk_cell_renderer_accel_new (void)
230 return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
234 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
236 GdkModifierType mask,
239 if (keysym == 0 && keycode == 0)
240 /* This label is displayed in a treeview cell displaying
241 * a disabled accelerator key combination.
243 return g_strdup (C_("Accelerator", "Disabled"));
246 if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
247 return gtk_accelerator_get_label (keysym, mask);
252 name = gtk_accelerator_name (keysym, mask);
258 name = g_strdup_printf ("%s0x%02x", tmp, keycode);
268 gtk_cell_renderer_accel_get_property (GObject *object,
273 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
278 g_value_set_uint (value, accel->accel_key);
281 case PROP_ACCEL_MODS:
282 g_value_set_flags (value, accel->accel_mods);
286 g_value_set_uint (value, accel->keycode);
289 case PROP_ACCEL_MODE:
290 g_value_set_enum (value, accel->accel_mode);
294 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
299 gtk_cell_renderer_accel_set_property (GObject *object,
304 GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
305 gboolean changed = FALSE;
311 guint accel_key = g_value_get_uint (value);
313 if (accel->accel_key != accel_key)
315 accel->accel_key = accel_key;
321 case PROP_ACCEL_MODS:
323 guint accel_mods = g_value_get_flags (value);
325 if (accel->accel_mods != accel_mods)
327 accel->accel_mods = accel_mods;
334 guint keycode = g_value_get_uint (value);
336 if (accel->keycode != keycode)
338 accel->keycode = keycode;
344 case PROP_ACCEL_MODE:
345 accel->accel_mode = g_value_get_enum (value);
349 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
356 text = convert_keysym_state_to_string (accel, accel->accel_key, accel->accel_mods, accel->keycode);
357 g_object_set (accel, "text", text, NULL);
363 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
365 GdkRectangle *cell_area,
372 GtkCellRendererAccel *accel = (GtkCellRendererAccel *) cell;
373 GtkRequisition requisition;
375 if (accel->sizing_label == NULL)
376 accel->sizing_label = gtk_label_new (_("New accelerator..."));
378 gtk_widget_size_request (accel->sizing_label, &requisition);
380 GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
381 x_offset, y_offset, width, height);
383 /* FIXME: need to take the cell_area et al. into account */
385 *width = MAX (*width, requisition.width);
387 *height = MAX (*height, requisition.height);
391 grab_key_callback (GtkWidget *widget,
393 GtkCellRendererAccel *accel)
395 GdkModifierType accel_mods = 0;
400 GdkModifierType consumed_modifiers;
403 display = gtk_widget_get_display (widget);
405 if (event->is_modifier)
411 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
412 event->hardware_keycode,
415 NULL, NULL, NULL, &consumed_modifiers);
417 accel_key = gdk_keyval_to_lower (event->keyval);
418 if (accel_key == GDK_ISO_Left_Tab)
421 accel_mods = event->state & gtk_accelerator_get_default_mod_mask ();
423 /* Filter consumed modifiers
425 if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
426 accel_mods &= ~consumed_modifiers;
428 /* Put shift back if it changed the case of the key, not otherwise.
430 if (accel_key != event->keyval)
431 accel_mods |= GDK_SHIFT_MASK;
435 switch (event->keyval)
438 goto out; /* cancel */
440 /* clear the accelerator on Backspace */
448 if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
450 if (!gtk_accelerator_valid (accel_key, accel_mods))
452 gtk_widget_error_bell (widget);
461 gdk_display_keyboard_ungrab (display, event->time);
462 gdk_display_pointer_ungrab (display, event->time);
464 path = g_strdup (g_object_get_data (G_OBJECT (accel->edit_widget), "gtk-cell-renderer-text"));
466 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (accel->edit_widget));
467 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (accel->edit_widget));
468 accel->edit_widget = NULL;
469 accel->grab_widget = NULL;
472 g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
473 accel_key, accel_mods, event->hardware_keycode);
475 g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
483 ungrab_stuff (GtkWidget *widget,
484 GtkCellRendererAccel *accel)
486 GdkDisplay *display = gtk_widget_get_display (widget);
488 gdk_display_keyboard_ungrab (display, GDK_CURRENT_TIME);
489 gdk_display_pointer_ungrab (display, GDK_CURRENT_TIME);
491 g_signal_handlers_disconnect_by_func (G_OBJECT (accel->grab_widget),
492 G_CALLBACK (grab_key_callback),
497 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
500 /* do nothing, because we are pointless */
504 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
506 iface->start_editing = _gtk_cell_editable_event_box_start_editing;
509 typedef GtkEventBox GtkCellEditableEventBox;
510 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
512 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
513 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init) \
518 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
523 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
527 static GtkCellEditable *
528 gtk_cell_renderer_accel_start_editing (GtkCellRenderer *cell,
532 GdkRectangle *background_area,
533 GdkRectangle *cell_area,
534 GtkCellRendererState flags)
536 GtkCellRendererText *celltext;
537 GtkCellRendererAccel *accel;
541 celltext = GTK_CELL_RENDERER_TEXT (cell);
542 accel = GTK_CELL_RENDERER_ACCEL (cell);
544 /* If the cell isn't editable we return NULL. */
545 if (celltext->editable == FALSE)
548 g_return_val_if_fail (widget->window != NULL, NULL);
550 if (gdk_keyboard_grab (widget->window, FALSE,
551 gdk_event_get_time (event)) != GDK_GRAB_SUCCESS)
554 if (gdk_pointer_grab (widget->window, FALSE,
555 GDK_BUTTON_PRESS_MASK,
557 gdk_event_get_time (event)) != GDK_GRAB_SUCCESS)
559 gdk_display_keyboard_ungrab (gtk_widget_get_display (widget),
560 gdk_event_get_time (event));
564 accel->grab_widget = widget;
566 g_signal_connect (G_OBJECT (widget), "key-press-event",
567 G_CALLBACK (grab_key_callback),
570 eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
571 accel->edit_widget = eventbox;
572 g_object_add_weak_pointer (G_OBJECT (accel->edit_widget),
573 (gpointer) &accel->edit_widget);
575 label = gtk_label_new (NULL);
576 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
578 gtk_widget_modify_bg (eventbox, GTK_STATE_NORMAL,
579 &widget->style->bg[GTK_STATE_SELECTED]);
581 gtk_widget_modify_fg (label, GTK_STATE_NORMAL,
582 &widget->style->fg[GTK_STATE_SELECTED]);
584 /* This label is displayed in a treeview cell displaying
585 * an accelerator when the cell is clicked to change the
588 gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
590 gtk_container_add (GTK_CONTAINER (eventbox), label);
592 g_object_set_data_full (G_OBJECT (accel->edit_widget), "gtk-cell-renderer-text",
593 g_strdup (path), g_free);
595 gtk_widget_show_all (accel->edit_widget);
597 g_signal_connect (G_OBJECT (accel->edit_widget), "unrealize",
598 G_CALLBACK (ungrab_stuff), accel);
600 return GTK_CELL_EDITABLE (accel->edit_widget);
604 #define __GTK_CELL_RENDERER_ACCEL_C__
605 #include "gtkaliasdef.c"