Struct gtk4::ShortcutsSection

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

A ShortcutsSection collects all the keyboard shortcuts and gestures for a major application mode.

If your application needs multiple sections, you should give each section a unique property::ShortcutsSection::section-name and a property::ShortcutsSection::title that can be shown in the section selector of the ShortcutsWindow.

The property::ShortcutsSection::max-height property can be used to influence how the groups in the section are distributed over pages and columns.

This widget is only meant to be used with ShortcutsWindow.

Implements

BoxExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, OrientableExt, WidgetExtManual, AccessibleExtManual

Implementations

impl ShortcutsSection

pub fn builder() -> ShortcutsSectionBuilder

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

This method returns an instance of ShortcutsSectionBuilder which can be used to create ShortcutsSection objects.

pub fn max_height(&self) -> u32

The maximum number of lines to allow per column.

This property can be used to influence how the groups in this section are distributed across pages and columns. The default value of 15 should work in most cases.

pub fn set_max_height(&self, max_height: u32)

The maximum number of lines to allow per column.

This property can be used to influence how the groups in this section are distributed across pages and columns. The default value of 15 should work in most cases.

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

A unique name to identify this section among the sections added to the ShortcutsWindow.

Setting the property::ShortcutsWindow::section-name property to this string will make this section shown in the ShortcutsWindow.

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

A unique name to identify this section among the sections added to the ShortcutsWindow.

Setting the property::ShortcutsWindow::section-name property to this string will make this section shown in the ShortcutsWindow.

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

The string to show in the section selector of the ShortcutsWindow for this section.

If there is only one section, you don’t need to set a title, since the section selector will not be shown in this case.

pub fn set_title(&self, title: Option<&str>)

The string to show in the section selector of the ShortcutsWindow for this section.

If there is only one section, you don’t need to set a title, since the section selector will not be shown in this case.

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

A view name to filter the groups in this section by.

See property::ShortcutsGroup::view.

Applications are expected to use the property::ShortcutsWindow::view-name property for this purpose.

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

A view name to filter the groups in this section by.

See property::ShortcutsGroup::view.

Applications are expected to use the property::ShortcutsWindow::view-name property for this purpose.

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

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

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

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

impl ShortcutsSection

pub fn connect_change_current_page<F: Fn(&ShortcutsSection, i32) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

pub fn emit_change_current_page(&self, object: i32) -> bool

Trait Implementations

impl Clone for ShortcutsSection

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 ShortcutsSection

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

Formats the value using the given formatter.

impl Display for ShortcutsSection

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

Formats the value using the given formatter.

impl Hash for ShortcutsSection

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 ShortcutsSection

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 ShortcutsSection

type Parent = Box

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

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 ShortcutsSection

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 ShortcutsSection

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShortcutsSection

impl IsA<Accessible> for ShortcutsSection

impl IsA<Box> for ShortcutsSection

impl IsA<Buildable> for ShortcutsSection

impl IsA<ConstraintTarget> for ShortcutsSection

impl IsA<Orientable> for ShortcutsSection

impl IsA<Widget> for ShortcutsSection