Struct gtk::AccelLabel

#[repr(transparent)]
pub struct AccelLabel { /* private fields */ }

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 AccelLabelExt::set_accel()). Instead, the AccelLabel displays the accelerators which have been added to a particular widget. This widget is set by calling AccelLabelExt::set_accel_widget().

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 AccelLabelExt::set_accel_widget() 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 MenuItem::with_label() (or one of the similar functions for CheckMenuItem and RadioMenuItem) automatically adds a AccelLabel to the MenuItem and calls AccelLabelExt::set_accel_widget() to set it up for you.

A AccelLabel will only display accelerators which have AccelFlags::VISIBLE 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.

⚠️ The following code is in C ⚠️

  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

⚠️ The following code is in plain ⚠️

label
╰── accelerator

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

Implements

AccelLabelExt, LabelExt, [MiscExt][trait@crate::prelude::MiscExt], WidgetExt, glib::ObjectExt, BuildableExt, WidgetExtManual, BuildableExtManual

Implementations

impl AccelLabel

pub const NONE: Option<&'static AccelLabel> = None

pub fn new(string: &str) -> AccelLabel

Creates a new AccelLabel.

string

the label string. Must be non-None.

Returns

a new AccelLabel.

pub fn builder() -> AccelLabelBuilder

Creates a new builder-pattern struct instance to construct AccelLabel objects.

This method returns an instance of AccelLabelBuilder which can be used to create AccelLabel objects.

Trait Implementations

impl Clone for AccelLabel

fn clone(&self) -> Self

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AccelLabel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AccelLabel

fn default() -> Self

Returns the “default value” for a type.

impl Display for AccelLabel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for AccelLabel

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for AccelLabel

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for AccelLabel

type Parent = Label

impl<OT: ObjectType> PartialEq<OT> for AccelLabel

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for AccelLabel

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AccelLabel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AccelLabel

impl IsA<Buildable> for AccelLabel

impl IsA<Label> for AccelLabel

impl IsA<Misc> for AccelLabel

impl IsA<Widget> for AccelLabel