Struct ShortcutsSection

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 section-name and a title that can be shown in the section selector of the ShortcutsWindow.

The 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.

The recommended way to construct a ShortcutsSection is with Builder, by using the <child> tag to populate a ShortcutsSection with one or more ShortcutsGroup instances, which in turn contain one or more ShortcutsShortcut objects.

If you need to add a group programmatically, use add_group().

Shortcuts and Gestures

Pan gestures allow to navigate between sections.

The following signals have default keybindings:

• change-current-page

Properties

max-height

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.

Readable | Writeable

section-name

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

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

Readable | Writeable

title

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.

Readable | Writeable

view-name

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

See view.

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

Readable | Writeable

Box

baseline-child

The child that determines the baseline, in vertical orientation.

Readable | Writeable

baseline-position

The position of the baseline aligned widgets if extra space is available.

Readable | Writeable

homogeneous

Whether the children should all be the same size.

Readable | Writeable

spacing

The amount of space between children.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Signals

change-current-page

Emitted when we change the current page.

The default bindings for this signal are Ctrl+PgUp, PgUp, Ctrl+PgDn, PgDn.

Action

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

BoxExt, WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, OrientableExt, WidgetExtManual, AccessibleExtManual

GLib type: GObject with reference counted clone semantics.

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 add_group(&self, group: &ShortcutsGroup)

Available on crate feature v4_14 only.

Adds a group to the shortcuts section.

This is the programmatic equivalent to using Builder and a <child> tag to add the child.

Adding children with the Box API is not appropriate, as ShortcutsSection manages its children internally.

group

the ShortcutsGroup to add

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 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 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 view.

Applications are expected to use the 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 view.

Applications are expected to use the 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

Emitted when we change the current page.

The default bindings for this signal are Ctrl+PgUp, PgUp, Ctrl+PgDn, PgDn.

offset

the offset

Returns

whether the page was changed

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

Trait Implementations

impl Clone for ShortcutsSection

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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 HasParamSpec for ShortcutsSection

type ParamSpec = ParamSpecObject

type SetValue = ShortcutsSection

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ShortcutsSection>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ShortcutsSection

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

where H: Hasher,

Hashes the memory address of this object.

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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