GtkCellRendererAccel

GtkCellRendererAccel — Renders a keyboard accelerator in a cell

Synopsis


#include <gtk/gtk.h>

                    GtkCellRendererAccel;
enum                GtkCellRendererAccelMode;
GtkCellRenderer*    gtk_cell_renderer_accel_new         (void);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkCellRenderer
                     +----GtkCellRendererText
                           +----GtkCellRendererAccel

Properties

  "accel-key"                guint                 : Read / Write
  "accel-mode"               GtkCellRendererAccelMode  : Read / Write
  "accel-mods"               GdkModifierType       : Read / Write
  "keycode"                  guint                 : Read / Write

Signals

  "accel-cleared"                                  : Run Last
  "accel-edited"                                   : Run Last

Description

GtkCellRendererAccel displays a keyboard accelerator (i.e. a key combination like <Control>-a). If the cell renderer is editable, the accelerator can be changed by simply typing the new combination.

The GtkCellRendererAccel cell renderer was added in GTK+ 2.10.

Details

GtkCellRendererAccel

typedef struct _GtkCellRendererAccel GtkCellRendererAccel;

enum GtkCellRendererAccelMode

typedef enum
{
  GTK_CELL_RENDERER_ACCEL_MODE_GTK,
  GTK_CELL_RENDERER_ACCEL_MODE_OTHER
} GtkCellRendererAccelMode;

gtk_cell_renderer_accel_new ()

GtkCellRenderer*    gtk_cell_renderer_accel_new         (void);

Creates a new GtkCellRendererAccel.

Returns : the new cell renderer

Since 2.10

Property Details

The "accel-key" property

  "accel-key"                guint                 : Read / Write

The keyval of the accelerator.

Allowed values: <= G_MAXINT

Default value: 0

Since 2.10

The "accel-mode" property

  "accel-mode"               GtkCellRendererAccelMode  : Read / Write

Determines if the edited accelerators are GTK+ accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK+ are allowed, and the accelerators are rendered in the same way as they are in menus.

Default value: GTK_CELL_RENDERER_ACCEL_MODE_GTK

Since 2.10

The "accel-mods" property

  "accel-mods"               GdkModifierType       : Read / Write

The modifier mask of the accelerator.

Since 2.10

The "keycode" property

  "keycode"                  guint                 : Read / Write

The hardware keycode of the accelerator. Note that the hardware keycode is only relevant if the key does not have a keyval. Normally, the keyboard configuration should assign keyvals to all keys.

Allowed values: <= G_MAXINT

Default value: 0

Since 2.10

Signal Details

The "accel-cleared" signal

void                user_function                      (GtkCellRendererAccel *accel,
                                                        gchar                *path_string,
                                                        gpointer              user_data)        : Run Last

Gets emitted when the user has removed the accelerator.

accel : the object reveiving the signal
path_string : the path identifying the row of the edited cell
user_data : user data set when the signal handler was connected.

Since 2.10

The "accel-edited" signal

void                user_function                      (GtkCellRendererAccel *accel,
                                                        gchar                *path_string,
                                                        guint                 accel_key,
                                                        GdkModifierType       accel_mods,
                                                        guint                 hardware_keycode,
                                                        gpointer              user_data)             : Run Last

Gets emitted when the user has selected a new accelerator.

accel : the object reveiving the signal
path_string : the path identifying the row of the edited cell
accel_key : the new accelerator keyval
accel_mods : the new acclerator modifier mask
hardware_keycode : the keycode of the new accelerator
user_data : user data set when the signal handler was connected.

Since 2.10

Generated by GTK-Doc V1.10