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