GtkAccelLabel

Creating a simple menu item with an accelerator key.

CSS nodes

GtkWidget *window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
GtkWidget *menu = gtk_menu_new ();
GtkWidget *save_item;
GtkAccelGroup *accel_group;

// Create a GtkAccelGroup and add it to the window.
accel_group = gtk_accel_group_new ();
gtk_window_add_accel_group (GTK_WINDOW (window), accel_group);

// Create the menu item using the convenience function.
save_item = gtk_menu_item_new_with_label ("Save");
gtk_widget_show (save_item);
gtk_container_add (GTK_CONTAINER (menu), save_item);

// Now add the accelerator to the GtkMenuItem. Note that since we
// called gtk_menu_item_new_with_label() to create the GtkMenuItem
// the GtkAccelLabel is automatically set up to display the
// GtkMenuItem accelerators. We just need to make sure we use
// GTK_ACCEL_VISIBLE here.
gtk_widget_add_accelerator (save_item, "activate", accel_group,
                            GDK_KEY_s, GDK_CONTROL_MASK, GTK_ACCEL_VISIBLE);

Like GtkLabel, GtkAccelLabel has a main CSS node with the name label. It adds a subnode with name accelerator.

gtk_accel_label_new ()

GtkWidget *
gtk_accel_label_new (const gchar *string);

Creates a new GtkAccelLabel.

gtk_accel_label_set_accel_closure ()

void
gtk_accel_label_set_accel_closure (GtkAccelLabel *accel_label,
                                   GClosure *accel_closure);

Sets the closure to be monitored by this accelerator label. The closure must be connected to an accelerator group; see gtk_accel_group_connect(). Passing NULL for accel_closure will dissociate accel_label from its current closure, if any.

gtk_accel_label_get_accel_widget ()

GtkWidget *
gtk_accel_label_get_accel_widget (GtkAccelLabel *accel_label);

Fetches the widget monitored by this accelerator label. See gtk_accel_label_set_accel_widget().

gtk_accel_label_set_accel_widget ()

void
gtk_accel_label_set_accel_widget (GtkAccelLabel *accel_label,
                                  GtkWidget *accel_widget);

Sets the widget to be monitored by this accelerator label. Passing NULL for accel_widget will dissociate accel_label from its current widget, if any.

gtk_accel_label_get_accel_width ()

guint
gtk_accel_label_get_accel_width (GtkAccelLabel *accel_label);

Returns the width needed to display the accelerator key(s). This is used by menus to align all of the GtkMenuItem widgets, and shouldn't be needed by applications.

gtk_accel_label_set_accel ()

void
gtk_accel_label_set_accel (GtkAccelLabel *accel_label,
                           guint accelerator_key,
                           GdkModifierType accelerator_mods);

Manually sets a keyval and modifier mask as the accelerator rendered by accel_label .

If a keyval and modifier are explicitly set then these values are used regardless of any associated accel closure or widget.

Providing an accelerator_key of 0 removes the manual setting.

Since: 3.6

gtk_accel_label_get_accel ()

void
gtk_accel_label_get_accel (GtkAccelLabel *accel_label,
                           guint *accelerator_key,
                           GdkModifierType *accelerator_mods);

Gets the keyval and modifier mask set with gtk_accel_label_set_accel().

Since: 3.12

gtk_accel_label_refetch ()

gboolean
gtk_accel_label_refetch (GtkAccelLabel *accel_label);

Recreates the string representing the accelerator keys. This should not be needed since the string is automatically updated whenever accelerators are added or removed from the associated widget.

struct GtkAccelLabel

struct GtkAccelLabel;

The GtkAccelLabel contains private data only, and should be accessed using the functions below.

The “accel-closure” property

  “accel-closure”            GClosure *

The closure to be monitored for accelerator changes.

Owner: GtkAccelLabel

Flags: Read / Write

The “accel-widget” property

  “accel-widget”             GtkWidget *

The widget to be monitored for accelerator changes.

Owner: GtkAccelLabel

Flags: Read / Write