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. Only include
 242      * the text after the | in the translation.
 243      */
 244     return g_strdup (Q_("Accelerator|Disabled"));
 245   else
 246     {
 247       if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
 248         return gtk_accelerator_get_label (keysym, mask);
 249       else
 250         {
 251           gchar *name;
 252
 253           name = gtk_accelerator_name (keysym, mask);
 254           if (keysym == 0)
 255             {
 256               gchar *tmp;
 257
 258               tmp = name;
 259               name = g_strdup_printf ("%s0x%02x", tmp, keycode);
 260               g_free (tmp);
 261             }
 262
 263           return name;
 264         }
 265     }
 266 }
 267
 268 static void
 269 gtk_cell_renderer_accel_get_property  (GObject    *object,
 270                                        guint       param_id,
 271                                        GValue     *value,
 272                                        GParamSpec *pspec)
 273 {
 274   GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
 275
 276   switch (param_id)
 277     {
 278     case PROP_ACCEL_KEY:
 279       g_value_set_uint (value, accel->accel_key);
 280       break;
 281
 282     case PROP_ACCEL_MODS:
 283       g_value_set_flags (value, accel->accel_mods);
 284       break;
 285
 286     case PROP_KEYCODE:
 287       g_value_set_uint (value, accel->keycode);
 288       break;
 289
 290     case PROP_ACCEL_MODE:
 291       g_value_set_enum (value, accel->accel_mode);
 292       break;
 293
 294     default:
 295       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 296     }
 297 }
 298
 299 static void
 300 gtk_cell_renderer_accel_set_property  (GObject      *object,
 301                                        guint         param_id,
 302                                        const GValue *value,
 303                                        GParamSpec   *pspec)
 304 {
 305   GtkCellRendererAccel *accel = GTK_CELL_RENDERER_ACCEL (object);
 306   gboolean changed = FALSE;
 307
 308   switch (param_id)
 309     {
 310     case PROP_ACCEL_KEY:
 311       {
 312         guint accel_key = g_value_get_uint (value);
 313
 314         if (accel->accel_key != accel_key)
 315           {
 316             accel->accel_key = accel_key;
 317             changed = TRUE;
 318           }
 319       }
 320       break;
 321
 322     case PROP_ACCEL_MODS:
 323       {
 324         guint accel_mods = g_value_get_flags (value);
 325
 326         if (accel->accel_mods != accel_mods)
 327           {
 328             accel->accel_mods = accel_mods;
 329             changed = TRUE;
 330           }
 331       }
 332       break;
 333     case PROP_KEYCODE:
 334       {
 335         guint keycode = g_value_get_uint (value);
 336
 337         if (accel->keycode != keycode)
 338           {
 339             accel->keycode = keycode;
 340             changed = TRUE;
 341           }
 342       }
 343       break;
 344
 345     case PROP_ACCEL_MODE:
 346       accel->accel_mode = g_value_get_enum (value);
 347       break;
 348
 349     default:
 350       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 351     }
 352
 353   if (changed)
 354     {
 355       gchar *text;
 356
 357       text = convert_keysym_state_to_string (accel, accel->accel_key, accel->accel_mods, accel->keycode);
 358       g_object_set (accel, "text", text, NULL);
 359       g_free (text);
 360     }
 361 }
 362
 363 static void
 364 gtk_cell_renderer_accel_get_size (GtkCellRenderer *cell,
 365                                   GtkWidget       *widget,
 366                                   GdkRectangle    *cell_area,
 367                                   gint            *x_offset,
 368                                   gint            *y_offset,
 369                                   gint            *width,
 370                                   gint            *height)
 371
 372 {
 373   GtkCellRendererAccel *accel = (GtkCellRendererAccel *) cell;
 374   GtkRequisition requisition;
 375
 376   if (accel->sizing_label == NULL)
 377     accel->sizing_label = gtk_label_new (_("New accelerator..."));
 378
 379   gtk_widget_size_request (accel->sizing_label, &requisition);
 380
 381   GTK_CELL_RENDERER_CLASS (gtk_cell_renderer_accel_parent_class)->get_size (cell, widget, cell_area,
 382                                                                             x_offset, y_offset, width, height);
 383
 384   /* FIXME: need to take the cell_area et al. into account */
 385   if (width)
 386     *width = MAX (*width, requisition.width);
 387   if (height)
 388     *height = MAX (*height, requisition.height);
 389 }
 390
 391 static gboolean
 392 grab_key_callback (GtkWidget            *widget,
 393                    GdkEventKey          *event,
 394                    GtkCellRendererAccel *accel)
 395 {
 396   GdkModifierType accel_mods = 0;
 397   guint accel_key;
 398   gchar *path;
 399   gboolean edited;
 400   gboolean cleared;
 401   GdkModifierType consumed_modifiers;
 402   GdkDisplay *display;
 403
 404   display = gtk_widget_get_display (widget);
 405
 406   if (event->is_modifier)
 407     return TRUE;
 408
 409   edited = FALSE;
 410   cleared = FALSE;
 411
 412   gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
 413                                        event->hardware_keycode,
 414                                        event->state,
 415                                        event->group,
 416                                        NULL, NULL, NULL, &consumed_modifiers);
 417
 418   accel_key = gdk_keyval_to_lower (event->keyval);
 419   if (accel_key == GDK_ISO_Left_Tab)
 420     accel_key = GDK_Tab;
 421
 422   accel_mods = event->state & gtk_accelerator_get_default_mod_mask ();
 423
 424   /* Filter consumed modifiers
 425    */
 426   if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
 427     accel_mods &= ~consumed_modifiers;
 428
 429   /* Put shift back if it changed the case of the key, not otherwise.
 430    */
 431   if (accel_key != event->keyval)
 432     accel_mods |= GDK_SHIFT_MASK;
 433
 434   if (accel_mods == 0)
 435     {
 436       switch (event->keyval)
 437         {
 438         case GDK_Escape:
 439           goto out; /* cancel */
 440         case GDK_BackSpace:
 441           /* clear the accelerator on Backspace */
 442           cleared = TRUE;
 443           goto out;
 444         default:
 445           break;
 446         }
 447     }
 448
 449   if (accel->accel_mode == GTK_CELL_RENDERER_ACCEL_MODE_GTK)
 450     {
 451       if (!gtk_accelerator_valid (accel_key, accel_mods))
 452         {
 453           gtk_widget_error_bell (widget);
 454
 455           return TRUE;
 456         }
 457     }
 458
 459   edited = TRUE;
 460
 461  out:
 462   gdk_display_keyboard_ungrab (display, event->time);
 463   gdk_display_pointer_ungrab (display, event->time);
 464
 465   path = g_strdup (g_object_get_data (G_OBJECT (accel->edit_widget), "gtk-cell-renderer-text"));
 466
 467   gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (accel->edit_widget));
 468   gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (accel->edit_widget));
 469   accel->edit_widget = NULL;
 470   accel->grab_widget = NULL;
 471
 472   if (edited)
 473     g_signal_emit (accel, signals[ACCEL_EDITED], 0, path,
 474                    accel_key, accel_mods, event->hardware_keycode);
 475   else if (cleared)
 476     g_signal_emit (accel, signals[ACCEL_CLEARED], 0, path);
 477
 478   g_free (path);
 479
 480   return TRUE;
 481 }
 482
 483 static void
 484 ungrab_stuff (GtkWidget            *widget,
 485               GtkCellRendererAccel *accel)
 486 {
 487   GdkDisplay *display = gtk_widget_get_display (widget);
 488
 489   gdk_display_keyboard_ungrab (display, GDK_CURRENT_TIME);
 490   gdk_display_pointer_ungrab (display, GDK_CURRENT_TIME);
 491
 492   g_signal_handlers_disconnect_by_func (G_OBJECT (accel->grab_widget),
 493                                         G_CALLBACK (grab_key_callback),
 494                                         accel);
 495 }
 496
 497 static void
 498 _gtk_cell_editable_event_box_start_editing (GtkCellEditable *cell_editable,
 499                                             GdkEvent        *event)
 500 {
 501   /* do nothing, because we are pointless */
 502 }
 503
 504 static void
 505 _gtk_cell_editable_event_box_cell_editable_init (GtkCellEditableIface *iface)
 506 {
 507   iface->start_editing = _gtk_cell_editable_event_box_start_editing;
 508 }
 509
 510 typedef GtkEventBox      GtkCellEditableEventBox;
 511 typedef GtkEventBoxClass GtkCellEditableEventBoxClass;
 512
 513 G_DEFINE_TYPE_WITH_CODE (GtkCellEditableEventBox, _gtk_cell_editable_event_box, GTK_TYPE_EVENT_BOX, { \
 514     G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE, _gtk_cell_editable_event_box_cell_editable_init)   \
 515       })
 516
 517
 518 static void
 519 _gtk_cell_editable_event_box_class_init (GtkCellEditableEventBoxClass *class)
 520 {
 521 }
 522
 523 static void
 524 _gtk_cell_editable_event_box_init (GtkCellEditableEventBox *box)
 525 {
 526 }
 527
 528 static GtkCellEditable *
 529 gtk_cell_renderer_accel_start_editing (GtkCellRenderer      *cell,
 530                                        GdkEvent             *event,
 531                                        GtkWidget            *widget,
 532                                        const gchar          *path,
 533                                        GdkRectangle         *background_area,
 534                                        GdkRectangle         *cell_area,
 535                                        GtkCellRendererState  flags)
 536 {
 537   GtkCellRendererText *celltext;
 538   GtkCellRendererAccel *accel;
 539   GtkWidget *label;
 540   GtkWidget *eventbox;
 541
 542   celltext = GTK_CELL_RENDERER_TEXT (cell);
 543   accel = GTK_CELL_RENDERER_ACCEL (cell);
 544
 545   /* If the cell isn't editable we return NULL. */
 546   if (celltext->editable == FALSE)
 547     return NULL;
 548
 549   g_return_val_if_fail (widget->window != NULL, NULL);
 550
 551   if (gdk_keyboard_grab (widget->window, FALSE,
 552                          gdk_event_get_time (event)) != GDK_GRAB_SUCCESS)
 553     return NULL;
 554
 555   if (gdk_pointer_grab (widget->window, FALSE,
 556                         GDK_BUTTON_PRESS_MASK,
 557                         NULL, NULL,
 558                         gdk_event_get_time (event)) != GDK_GRAB_SUCCESS)
 559     {
 560       gdk_display_keyboard_ungrab (gtk_widget_get_display (widget),
 561                                    gdk_event_get_time (event));
 562       return NULL;
 563     }
 564
 565   accel->grab_widget = widget;
 566
 567   g_signal_connect (G_OBJECT (widget), "key-press-event",
 568                     G_CALLBACK (grab_key_callback),
 569                     accel);
 570
 571   eventbox = g_object_new (_gtk_cell_editable_event_box_get_type (), NULL);
 572   accel->edit_widget = eventbox;
 573   g_object_add_weak_pointer (G_OBJECT (accel->edit_widget),
 574                              (gpointer) &accel->edit_widget);
 575
 576   label = gtk_label_new (NULL);
 577   gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
 578
 579   gtk_widget_modify_bg (eventbox, GTK_STATE_NORMAL,
 580                         &widget->style->bg[GTK_STATE_SELECTED]);
 581
 582   gtk_widget_modify_fg (label, GTK_STATE_NORMAL,
 583                         &widget->style->fg[GTK_STATE_SELECTED]);
 584
 585   /* This label is displayed in a treeview cell displaying
 586    * an accelerator when the cell is clicked to change the
 587    * acelerator.
 588    */
 589   gtk_label_set_text (GTK_LABEL (label), _("New accelerator..."));
 590
 591   gtk_container_add (GTK_CONTAINER (eventbox), label);
 592
 593   g_object_set_data_full (G_OBJECT (accel->edit_widget), "gtk-cell-renderer-text",
 594                           g_strdup (path), g_free);
 595
 596   gtk_widget_show_all (accel->edit_widget);
 597
 598   g_signal_connect (G_OBJECT (accel->edit_widget), "unrealize",
 599                     G_CALLBACK (ungrab_stuff), accel);
 600
 601   return GTK_CELL_EDITABLE (accel->edit_widget);
 602 }
 603
 604
 605 #define __GTK_CELL_RENDERER_ACCEL_C__
 606 #include "gtkaliasdef.c"