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