Struct gtk4::ShortcutsWindow

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

A ShortcutsWindow shows information about the keyboard shortcuts and gestures of an application.

The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application.

Additionally, the shortcuts can be filtered by the current view, to avoid showing information that is not relevant in the current application context.

The recommended way to construct a ShortcutsWindow is with Builder, by populating a ShortcutsWindow with one or more ShortcutsSection objects, which contain GtkShortcutsGroups that in turn contain objects of class ShortcutsShortcut.

A simple example:

This example has as single section. As you can see, the shortcut groups are arranged in columns, and spread across several pages if there are too many to find on a single page.

The .ui file for this example can be found here.

An example with multiple views:

This example shows a ShortcutsWindow that has been configured to show only the shortcuts relevant to the “stopwatch” view.

The .ui file for this example can be found here.

An example with multiple sections:

This example shows a ShortcutsWindow with two sections, “Editor Shortcuts” and “Terminal Shortcuts”.

The .ui file for this example can be found here.

Implements

GtkWindowExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, RootExt, ShortcutManagerExt, WidgetExtManual, AccessibleExtManual

Implementations

impl ShortcutsWindow

pub fn builder() -> ShortcutsWindowBuilder

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

This method returns an instance of ShortcutsWindowBuilder which can be used to create ShortcutsWindow objects.

pub fn section_name(&self) -> Option<GString>

The name of the section to show.

This should be the section-name of one of the ShortcutsSection objects that are in this shortcuts window.

pub fn set_section_name(&self, section_name: Option<&str>)

The name of the section to show.

This should be the section-name of one of the ShortcutsSection objects that are in this shortcuts window.

pub fn view_name(&self) -> Option<GString>

The view name by which to filter the contents.

This should correspond to the property::ShortcutsGroup::view property of some of the ShortcutsGroup objects that are inside this shortcuts window.

Set this to None to show all groups.

pub fn set_view_name(&self, view_name: Option<&str>)

The view name by which to filter the contents.

This should correspond to the property::ShortcutsGroup::view property of some of the ShortcutsGroup objects that are inside this shortcuts window.

Set this to None to show all groups.

pub fn connect_close<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the user uses a keybinding to close the window.

This is a keybinding signal.

The default binding for this signal is the Escape key.

pub fn emit_close(&self)

pub fn connect_search<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the user uses a keybinding to start a search.

This is a keybinding signal.

The default binding for this signal is Control-F.

pub fn emit_search(&self)

pub fn connect_section_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_view_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for ShortcutsWindow

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShortcutsWindow

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

Formats the value using the given formatter.

impl Display for ShortcutsWindow

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

Formats the value using the given formatter.

impl Hash for ShortcutsWindow

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ShortcutsWindow

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for ShortcutsWindow

type Parent = Window

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

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

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

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 ShortcutsWindow

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

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

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

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

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

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

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

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

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 ShortcutsWindow

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShortcutsWindow

impl IsA<Accessible> for ShortcutsWindow

impl IsA<Buildable> for ShortcutsWindow

impl IsA<ConstraintTarget> for ShortcutsWindow

impl IsA<Native> for ShortcutsWindow

impl IsA<Root> for ShortcutsWindow

impl IsA<ShortcutManager> for ShortcutsWindow

impl IsA<Widget> for ShortcutsWindow

impl IsA<Window> for ShortcutsWindow