]> Pileus Git - ~andy/gtk/blob - gtk/gtkcellrendereraccel.c
e1ad0f8b0dedbcc22631605ef9a6fb27ef45cc0d
[~andy/gtk] / gtk / gtkcellrendereraccel.c
1 /* gtkcellrendereraccel.h
2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #include "config.h"
21
22 #include "gtkcellrendereraccel.h"
23
24 #include "gtkintl.h"
25 #include "gtkaccelgroup.h"
26 #include "gtkmarshalers.h"
27 #include "gtklabel.h"
28 #include "gtkeventbox.h"
29 #include "gtkmain.h"
30 #include "gtksizerequest.h"
31 #include "gtkprivate.h"
32
33
34 static void gtk_cell_renderer_accel_get_property (GObject         *object,
35                                                   guint            param_id,
36                                                   GValue          *value,
37                                                   GParamSpec      *pspec);
38 static void gtk_cell_renderer_accel_set_property (GObject         *object,
39                                                   guint            param_id,
40                                                   const GValue    *value,
41                                                   GParamSpec      *pspec);
42 static void gtk_cell_renderer_accel_get_size     (GtkCellRenderer    *cell,
43                                                   GtkWidget          *widget,
44                                                   const GdkRectangle *cell_area,
45                                                   gint               *x_offset,
46                                                   gint               *y_offset,
47                                                   gint               *width,
48                                                   gint               *height);
49 static GtkCellEditable *
50            gtk_cell_renderer_accel_start_editing (GtkCellRenderer      *cell,
51                                                   GdkEvent             *event,
52                                                   GtkWidget            *widget,
53                                                   const gchar          *path,
54                                                   const GdkRectangle   *background_area,
55                                                   const GdkRectangle   *cell_area,
56                                                   GtkCellRendererState  flags);
57 static gchar *convert_keysym_state_to_string     (GtkCellRendererAccel *accel,
58                                                   guint                 keysym,
59                                                   GdkModifierType       mask,
60                                                   guint                 keycode);
61
62 enum {
63   ACCEL_EDITED,
64   ACCEL_CLEARED,
65   LAST_SIGNAL
66 };
67
68 enum {
69   PROP_0,
70   PROP_ACCEL_KEY,
71   PROP_ACCEL_MODS,
72   PROP_KEYCODE,
73   PROP_ACCEL_MODE
74 };
75
76 struct _GtkCellRendererAccelPrivate
77 {
78   GtkCellRendererAccelMode accel_mode;
79
80   GtkWidget *edit_widget;
81   GtkWidget *grab_widget;
82   GtkWidget *sizing_label;
83
84   GdkDevice *grab_keyboard;
85   GdkDevice *grab_pointer;
86
87   GdkModifierType accel_mods;
88
89   guint accel_key;
90   guint keycode;
91 };
92
93 static guint signals[LAST_SIGNAL] = { 0 };
94
95 G_DEFINE_TYPE (GtkCellRendererAccel, gtk_cell_renderer_accel, GTK_TYPE_CELL_RENDERER_TEXT)
96
97 static void
98 gtk_cell_renderer_accel_init (GtkCellRendererAccel *cell_accel)
99 {
100   gchar *text;
101
102   cell_accel->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell_accel,
103                                                   GTK_TYPE_CELL_RENDERER_ACCEL,
104                                                   GtkCellRendererAccelPrivate);
105
106   text = convert_keysym_state_to_string (cell_accel, 0, 0, 0);
107   g_object_set (cell_accel, "text", text, NULL);
108   g_free (text);
109 }
110
111 static void
112 gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class)
113 {
114   GObjectClass *object_class;
115   GtkCellRendererClass *cell_renderer_class;
116
117   object_class = G_OBJECT_CLASS (cell_accel_class);
118   cell_renderer_class = GTK_CELL_RENDERER_CLASS (cell_accel_class);
119
120   object_class->set_property = gtk_cell_renderer_accel_set_property;
121   object_class->get_property = gtk_cell_renderer_accel_get_property;
122
123   cell_renderer_class->get_size      = gtk_cell_renderer_accel_get_size;
124   cell_renderer_class->start_editing = gtk_cell_renderer_accel_start_editing;
125
126   /**
127    * GtkCellRendererAccel:accel-key:
128    *
129    * The keyval of the accelerator.
130    *
131    * Since: 2.10
132    */
133   g_object_class_install_property (object_class,
134                                    PROP_ACCEL_KEY,
135                                    g_param_spec_uint ("accel-key",
136                                                      P_("Accelerator key"),
137                                                      P_("The keyval of the accelerator"),
138                                                       0,
139                                                       G_MAXINT,
140                                                       0,
141                                                       GTK_PARAM_READWRITE));
142   
143   /**
144    * GtkCellRendererAccel:accel-mods:
145    *
146    * The modifier mask of the accelerator.
147    *
148    * Since: 2.10
149    */
150   g_object_class_install_property (object_class,
151                                    PROP_ACCEL_MODS,
152                                    g_param_spec_flags ("accel-mods",
153                                                        P_("Accelerator modifiers"),
154                                                        P_("The modifier mask of the accelerator"),
155                                                        GDK_TYPE_MODIFIER_TYPE,
156                                                        0,
157                                                        GTK_PARAM_READWRITE));
158
159   /**
160    * GtkCellRendererAccel:keycode:
161    *
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.
165    *
166    * Since: 2.10
167    */ 
168   g_object_class_install_property (object_class,
169                                    PROP_KEYCODE,
170                                    g_param_spec_uint ("keycode",
171                                                       P_("Accelerator keycode"),
172                                                       P_("The hardware keycode of the accelerator"),
173                                                       0,
174                                                       G_MAXINT,
175                                                       0,
176                                                       GTK_PARAM_READWRITE));
177
178   /**
179    * GtkCellRendererAccel:accel-mode:
180    *
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.
185    *
186    * Since: 2.10
187    */
188   g_object_class_install_property (object_class,
189                                    PROP_ACCEL_MODE,
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));
196   
197   /**
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
204    *
205    * Gets emitted when the user has selected a new accelerator.
206    *
207    * Since: 2.10
208    */
209   signals[ACCEL_EDITED] = g_signal_new (I_("accel-edited"),
210                                         GTK_TYPE_CELL_RENDERER_ACCEL,
211                                         G_SIGNAL_RUN_LAST,
212                                         G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_edited),
213                                         NULL, NULL,
214                                         _gtk_marshal_VOID__STRING_UINT_FLAGS_UINT,
215                                         G_TYPE_NONE, 4,
216                                         G_TYPE_STRING,
217                                         G_TYPE_UINT,
218                                         GDK_TYPE_MODIFIER_TYPE,
219                                         G_TYPE_UINT);
220
221   /**
222    * GtkCellRendererAccel::accel-cleared:
223    * @accel: the object reveiving the signal
224    * @path_string: the path identifying the row of the edited cell
225    *
226    * Gets emitted when the user has removed the accelerator.
227    *
228    * Since: 2.10
229    */
230   signals[ACCEL_CLEARED] = g_signal_new (I_("accel-cleared"),
231                                          GTK_TYPE_CELL_RENDERER_ACCEL,
232                                          G_SIGNAL_RUN_LAST,
233                                          G_STRUCT_OFFSET (GtkCellRendererAccelClass, accel_cleared),
234                                          NULL, NULL,
235                                          g_cclosure_marshal_VOID__STRING,
236                                          G_TYPE_NONE, 1,
237                                          G_TYPE_STRING);
238
239   g_type_class_add_private (cell_accel_class, sizeof (GtkCellRendererAccelPrivate));
240 }
241
242
243 /**
244  * gtk_cell_renderer_accel_new:
245  *
246  * Creates a new #GtkCellRendererAccel.
247  * 
248  * Returns: the new cell renderer
249  *
250  * Since: 2.10
251  */
252 GtkCellRenderer *
253 gtk_cell_renderer_accel_new (void)
254 {
255   return g_object_new (GTK_TYPE_CELL_RENDERER_ACCEL, NULL);
256 }
257
258 static gchar *
259 convert_keysym_state_to_string (GtkCellRendererAccel *accel,
260                                 guint                 keysym,
261                                 GdkModifierType       mask,
262                                 guint                 keycode)
263 {
264   GtkCellRendererAccelPrivate *priv = accel->priv;
265
266   if (keysym == 0 && keycode == 0)
267     /* This label is displayed in a treeview cell displaying
268      * a disabled accelerator key combination.
269      */
270     return g_strdup (C_("Accelerator", "Disabled"));
271   else 
272     {
273       if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
274         {
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().
279              */
280             return g_strdup (C_("Accelerator", "Invalid"));
281
282           return gtk_accelerator_get_label (keysym, mask);
283         }
284       else 
285         {
286           gchar *name;
287
288           name = gtk_accelerator_get_label (keysym, mask);
289           if (name == NULL)
290             name = gtk_accelerator_name (keysym, mask);
291
292           if (keysym == 0)
293             {
294               gchar *tmp;
295
296               tmp = name;
297               name = g_strdup_printf ("%s0x%02x", tmp, keycode);
298               g_free (tmp);
299             }
300
301           return name;
302         }
303     }
304 }
305
306 static void
307 gtk_cell_renderer_accel_get_property  (GObject    *object,
308                                        guint       param_id,
309                                        GValue     *value,
310                                        GParamSpec *pspec)
311 {
312   GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (object)->priv;
313
314   switch (param_id)
315     {
316     case PROP_ACCEL_KEY:
317       g_value_set_uint (value, priv->accel_key);
318       break;
319
320     case PROP_ACCEL_MODS:
321       g_value_set_flags (value, priv->accel_mods);
322       break;
323
324     case PROP_KEYCODE:
325       g_value_set_uint (value, priv->keycode);
326       break;
327
328     case PROP_ACCEL_MODE:
329       g_value_set_enum (value, priv->accel_mode);
330       break;
331
332     default:
333       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
334     }
335 }
336
337 static void
338 gtk_cell_renderer_accel_set_property  (GObject      *object,
339                                        guint         param_id,
340                                        const GValue *value,
341                                        GParamSpec   *pspec)
342 {
343   GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
344   GtkCellRendererAccelPrivate *priv = accel->priv;
345   gboolean changed = FALSE;
346
347   switch (param_id)
348     {
349     case PROP_ACCEL_KEY:
350       {
351         guint accel_key = g_value_get_uint (value);
352
353         if (priv->accel_key != accel_key)
354           {
355             priv->accel_key = accel_key;
356             changed = TRUE;
357           }
358       }
359       break;
360
361     case PROP_ACCEL_MODS:
362       {
363         guint accel_mods = g_value_get_flags (value);
364
365         if (priv->accel_mods != accel_mods)
366           {
367             priv->accel_mods = accel_mods;
368             changed = TRUE;
369           }
370       }
371       break;
372     case PROP_KEYCODE:
373       {
374         guint keycode = g_value_get_uint (value);
375
376         if (priv->keycode != keycode)
377           {
378             priv->keycode = keycode;
379             changed = TRUE;
380           }
381       }
382       break;
383
384     case PROP_ACCEL_MODE:
385       priv->accel_mode = g_value_get_enum (value);
386       break;
387       
388     default:
389       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
390     }
391
392   if (changed)
393     {
394       gchar *text;
395
396       text = convert_keysym_state_to_string (accel, priv->accel_key, priv->accel_mods, priv->keycode);
397       g_object_set (accel, "text", text, NULL);
398       g_free (text);
399     }
400 }
401
402 static void
403 gtk_cell_renderer_accel_get_size (GtkCellRenderer    *cell,
404                                   GtkWidget          *widget,
405                                   const GdkRectangle *cell_area,
406                                   gint               *x_offset,
407                                   gint               *y_offset,
408                                   gint               *width,
409                                   gint               *height)
410
411 {
412   GtkCellRendererAccelPrivate *priv = GTK_CELL_RENDERER_ACCEL (cell)->priv;
413   GtkRequisition requisition;
414
415   if (priv->sizing_label == NULL)
416     priv->sizing_label = gtk_label_new (_("New accelerator..."));
417
418   gtk_widget_get_preferred_size (priv->sizing_label, &requisition, NULL);
419
420   GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
421                                                                             x_offset, y_offset, width, height);
422
423   /* FIXME: need to take the cell_area et al. into account */
424   if (width)
425     *width = MAX (*width, requisition.width);
426   if (height)
427     *height = MAX (*height, requisition.height);
428 }
429
430 static gboolean
431 grab_key_callback (GtkWidget            *widget,
432                    GdkEventKey          *event,
433                    GtkCellRendererAccel *accel)
434 {
435   GtkCellRendererAccelPrivate *priv = accel->priv;
436   GdkModifierType accel_mods = 0;
437   guint accel_key;
438   gchar *path;
439   gboolean edited;
440   gboolean cleared;
441   GdkModifierType consumed_modifiers;
442   GdkDisplay *display;
443
444   display = gtk_widget_get_display (widget);
445
446   if (event->is_modifier)
447     return TRUE;
448
449   edited = FALSE;
450   cleared = FALSE;
451
452   gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
453                                        event->hardware_keycode,
454                                        event->state,
455                                        event->group,
456                                        NULL, NULL, NULL, &consumed_modifiers);
457
458   accel_key = gdk_keyval_to_lower (event->keyval);
459   if (accel_key == GDK_KEY_ISO_Left_Tab) 
460     accel_key = GDK_KEY_Tab;
461
462   accel_mods = event->state & gtk_accelerator_get_default_mod_mask ();
463
464   /* Filter consumed modifiers 
465    */
466   if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
467     accel_mods &= ~consumed_modifiers;
468   
469   /* Put shift back if it changed the case of the key, not otherwise.
470    */
471   if (accel_key != event->keyval)
472     accel_mods |= GDK_SHIFT_MASK;
473     
474   if (accel_mods == 0)
475     {
476       switch (event->keyval)
477         {
478         case GDK_KEY_Escape:
479           goto out; /* cancel */
480         case GDK_KEY_BackSpace:
481           /* clear the accelerator on Backspace */
482           cleared = TRUE;
483           goto out;
484         default:
485           break;
486         }
487     }
488
489   if (priv->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
490     {
491       if (!gtk_accelerator_valid (accel_key, accel_mods))
492         {
493           gtk_widget_error_bell (widget);
494
495           return TRUE;
496         }
497     }
498
499   edited = TRUE;
500
501  out:
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);
505
506   path = g_strdup (g_object_get_data (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text"));
507
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;
514
515   if (edited)
516     g_signal_emit (accel, signals[ACCEL_EDITED], 0, path, 
517                    accel_key, accel_mods, event->hardware_keycode);
518   else if (cleared)
519     g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
520
521   g_free (path);
522
523   return TRUE;
524 }
525
526 static void
527 ungrab_stuff (GtkWidget            *widget,
528               GtkCellRendererAccel *accel)
529 {
530   GtkCellRendererAccelPrivate *priv = accel->priv;
531
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);
535
536   priv->grab_keyboard = NULL;
537   priv->grab_pointer = NULL;
538
539   g_signal_handlers_disconnect_by_func (priv->grab_widget,
540                                         G_CALLBACK (grab_key_callback),
541                                         accel);
542 }
543
544 static void
545 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
546                                             GdkEvent        *event)
547 {
548   /* do nothing, because we are pointless */
549 }
550
551 static void
552 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
553 {
554   iface->start_editing = _gtk_cell_editable_event_box_start_editing;
555 }
556
557 typedef GtkEventBox      GtkCellEditableEventBox;
558 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
559
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)   \
562       })
563
564
565 static void
566 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
567 {
568 }
569
570 static void
571 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
572 {
573 }
574
575 static GtkCellEditable *
576 gtk_cell_renderer_accel_start_editing (GtkCellRenderer      *cell,
577                                        GdkEvent             *event,
578                                        GtkWidget            *widget,
579                                        const gchar          *path,
580                                        const GdkRectangle   *background_area,
581                                        const GdkRectangle   *cell_area,
582                                        GtkCellRendererState  flags)
583 {
584   GtkCellRendererAccelPrivate *priv;
585   GtkCellRendererText *celltext;
586   GtkCellRendererAccel *accel;
587   GtkStyle *style;
588   GtkWidget *label;
589   GtkWidget *eventbox;
590   GdkDevice *device, *keyb, *pointer;
591   GdkWindow *window;
592   gboolean editable;
593   guint32 time;
594
595   celltext = GTK_CELL_RENDERER_TEXT (cell);
596   accel = GTK_CELL_RENDERER_ACCEL (cell);
597   priv = accel->priv;
598
599   /* If the cell isn't editable we return NULL. */
600   g_object_get (celltext, "editable", &editable, NULL);
601   if (editable == FALSE)
602     return NULL;
603
604   window = gtk_widget_get_window (widget);
605   style = gtk_widget_get_style (widget);
606
607   g_return_val_if_fail (window != NULL, NULL);
608
609   if (event)
610     device = gdk_event_get_device (event);
611   else
612     device = gtk_get_current_event_device ();
613
614   if (!device)
615     return NULL;
616
617   if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
618     {
619       keyb = device;
620       pointer = gdk_device_get_associated_device (device);
621     }
622   else
623     {
624       pointer = device;
625       keyb = gdk_device_get_associated_device (device);
626     }
627
628   time = gdk_event_get_time (event);
629
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)
634     return NULL;
635
636   if (gdk_device_grab (pointer, window,
637                        GDK_OWNERSHIP_WINDOW, FALSE,
638                        GDK_BUTTON_PRESS_MASK,
639                        NULL, time) != GDK_GRAB_SUCCESS)
640     {
641       gdk_device_ungrab (keyb, time);
642       return NULL;
643     }
644
645   priv->grab_keyboard = keyb;
646   priv->grab_pointer = pointer;
647   priv->grab_widget = widget;
648
649   g_signal_connect (G_OBJECT (widget), "key-press-event",
650                     G_CALLBACK (grab_key_callback),
651                     accel);
652
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);
657   
658   label = gtk_label_new (NULL);
659   gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
660
661   
662
663   gtk_widget_modify_bg (eventbox, GTK_STATE_NORMAL,
664                         &style->bg[GTK_STATE_SELECTED]);
665
666   gtk_widget_modify_fg (label, GTK_STATE_NORMAL,
667                         &style->fg[GTK_STATE_SELECTED]);
668
669   /* This label is displayed in a treeview cell displaying
670    * an accelerator when the cell is clicked to change the 
671    * acelerator.
672    */
673   gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
674
675   gtk_container_add (GTK_CONTAINER (eventbox), label);
676   
677   g_object_set_data_full (G_OBJECT (priv->edit_widget), "gtk-cell-renderer-text",
678                           g_strdup (path), g_free);
679   
680   gtk_widget_show_all (priv->edit_widget);
681
682   gtk_device_grab_add (priv->grab_widget, pointer, TRUE);
683
684   g_signal_connect (priv->edit_widget, "unrealize",
685                     G_CALLBACK (ungrab_stuff), accel);
686   
687   return GTK_CELL_EDITABLE (priv->edit_widget);
688 }