GI.Gtk.Objects.AccelLabel

The AccelLabel widget is a subclass of Label that also displays an accelerator key on the right of the label text, e.g. “Ctrl+S”. It is commonly used in menus to show the keyboard short-cuts for commands.

The accelerator key to display is typically not set explicitly (although it can be, with accelLabelSetAccel). Instead, the AccelLabel displays the accelerators which have been added to a particular widget. This widget is set by calling accelLabelSetAccelWidget.

For example, a MenuItem widget may have an accelerator added to emit the “activate” signal when the “Ctrl+S” key combination is pressed. A AccelLabel is created and added to the MenuItem, and accelLabelSetAccelWidget is called with the MenuItem as the second argument. The AccelLabel will now display “Ctrl+S” after its label.

Note that creating a MenuItem with menuItemNewWithLabel (or one of the similar functions for CheckMenuItem and RadioMenuItem) automatically adds a AccelLabel to the MenuItem and calls accelLabelSetAccelWidget to set it up for you.

A AccelLabel will only display accelerators which have AccelFlagsVisible set (see AccelFlags). A AccelLabel can display multiple accelerators and even signal names, though it is almost always used to display just one accelerator key.

Creating a simple menu item with an accelerator key.

C code

 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);

CSS nodes

plain code

label
╰── accelerator

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

Exported types

newtype AccelLabel

Memory-managed wrapper type.

Constructors

AccelLabel (ManagedPtr AccelLabel)

Instances

GObject AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

Methods

gobjectType :: AccelLabel -> IO GType

IsImplementorIface AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

IsObject AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

IsBuildable AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

IsLabel AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

IsMisc AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

IsWidget AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

IsAccelLabel AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

class GObject o => IsAccelLabel o

Type class for types which can be safely cast to AccelLabel, for instance with toAccelLabel.

Instances

(GObject a, (UnknownAncestorError AccelLabel a :: Constraint)) => IsAccelLabel a

Defined in GI.Gtk.Objects.AccelLabel

IsAccelLabel AccelLabel

Defined in GI.Gtk.Objects.AccelLabel

toAccelLabel :: (MonadIO m, IsAccelLabel o) => o -> m AccelLabel

Cast to AccelLabel, for types for which this is known to be safe. For general casts, use castTo.

noAccelLabel :: Maybe AccelLabel

A convenience alias for Nothing :: Maybe AccelLabel.

Methods

getAccel

accelLabelGetAccel

Arguments

:: (HasCallStack, MonadIO m, IsAccelLabel a)

=> a

accelLabel: a AccelLabel

-> m (Word32, [ModifierType])

Gets the keyval and modifier mask set with accelLabelSetAccel.

Since: 3.12

getAccelWidget

accelLabelGetAccelWidget

Arguments

:: (HasCallStack, MonadIO m, IsAccelLabel a)

=> a

accelLabel: a AccelLabel

-> m (Maybe Widget)

Returns: the object monitored by the accelerator label, or Nothing.

Fetches the widget monitored by this accelerator label. See accelLabelSetAccelWidget.

getAccelWidth

accelLabelGetAccelWidth

Arguments

:: (HasCallStack, MonadIO m, IsAccelLabel a)

=> a

accelLabel: a AccelLabel.

-> m Word32

Returns: the width needed to display the accelerator key(s).

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

new

accelLabelNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

string: the label string. Must be non-Nothing.

-> m AccelLabel

Returns: a new AccelLabel.

Creates a new AccelLabel.

refetch

accelLabelRefetch

Arguments

:: (HasCallStack, MonadIO m, IsAccelLabel a)

=> a

accelLabel: a AccelLabel.

-> m Bool

Returns: always returns False.

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.

setAccel

accelLabelSetAccel

Arguments

:: (HasCallStack, MonadIO m, IsAccelLabel a)

=> a

accelLabel: a AccelLabel

-> Word32

acceleratorKey: a keyval, or 0

-> [ModifierType]

acceleratorMods: the modifier mask for the accel

-> m ()

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

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

Providing an acceleratorKey of 0 removes the manual setting.

Since: 3.6

setAccelClosure

accelLabelSetAccelClosure

Arguments

:: (HasCallStack, MonadIO m, IsAccelLabel a)

=> a

accelLabel: a AccelLabel

-> Maybe Closure

accelClosure: the closure to monitor for accelerator changes, or Nothing

-> m ()

Sets the closure to be monitored by this accelerator label. The closure must be connected to an accelerator group; see accelGroupConnect. Passing Nothing for accelClosure will dissociate accelLabel from its current closure, if any.

setAccelWidget

accelLabelSetAccelWidget

Arguments

:: (HasCallStack, MonadIO m, IsAccelLabel a, IsWidget b)

=> a

accelLabel: a AccelLabel

-> Maybe b

accelWidget: the widget to be monitored, or Nothing

-> m ()

Sets the widget to be monitored by this accelerator label. Passing Nothing for accelWidget will dissociate accelLabel from its current widget, if any.

Properties

accelClosure

No description available in the introspection data.

clearAccelLabelAccelClosure :: (MonadIO m, IsAccelLabel o) => o -> m ()

Set the value of the “accel-closure” property to Nothing. When overloading is enabled, this is equivalent to

clear #accelClosure

constructAccelLabelAccelClosure :: IsAccelLabel o => Closure -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “accel-closure” property. This is rarely needed directly, but it is used by new.

getAccelLabelAccelClosure :: (MonadIO m, IsAccelLabel o) => o -> m (Maybe Closure)

Get the value of the “accel-closure” property. When overloading is enabled, this is equivalent to

get accelLabel #accelClosure

setAccelLabelAccelClosure :: (MonadIO m, IsAccelLabel o) => o -> Closure -> m ()

Set the value of the “accel-closure” property. When overloading is enabled, this is equivalent to

set accelLabel [ #accelClosure := value ]

accelWidget

No description available in the introspection data.

clearAccelLabelAccelWidget :: (MonadIO m, IsAccelLabel o) => o -> m ()

Set the value of the “accel-widget” property to Nothing. When overloading is enabled, this is equivalent to

clear #accelWidget

constructAccelLabelAccelWidget :: (IsAccelLabel o, IsWidget a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “accel-widget” property. This is rarely needed directly, but it is used by new.

getAccelLabelAccelWidget :: (MonadIO m, IsAccelLabel o) => o -> m (Maybe Widget)

Get the value of the “accel-widget” property. When overloading is enabled, this is equivalent to

get accelLabel #accelWidget

setAccelLabelAccelWidget :: (MonadIO m, IsAccelLabel o, IsWidget a) => o -> a -> m ()

Set the value of the “accel-widget” property. When overloading is enabled, this is equivalent to

set accelLabel [ #accelWidget := value ]