Struct ShortcutsShortcut

Source

pub struct ShortcutsShortcut { /* private fields */ }

Expand description

A ShortcutsShortcut represents a single keyboard shortcut or gesture with a short text.

This widget is only meant to be used with ShortcutsWindow.

§Properties

§`accel-size-group`

The size group for the accelerator portion of this shortcut.

This is used internally by GTK, and must not be modified by applications.

Writeable

§`accelerator`

The accelerator(s) represented by this object.

This property is used if shortcut-type is set to ShortcutType::Accelerator.

The syntax of this property is (an extension of) the syntax understood by accelerator_parse(). Multiple accelerators can be specified by separating them with a space, but keep in mind that the available width is limited.

It is also possible to specify ranges of shortcuts, using ... between the keys. Sequences of keys can be specified using a + or & between the keys.

Examples:

A single shortcut: <ctl><alt>delete
Two alternative shortcuts: <shift>a Home
A range of shortcuts: <alt>1...<alt>9
Several keys pressed together: Control_L&Control_R
A sequence of shortcuts or keys: <ctl>c+<ctl>x

Use “+” instead of “&” when the keys may (or have to be) pressed sequentially (e.g use “t+t” for ‘press the t key twice’).

Note that <, > and & need to be escaped as <, &gt; and &amp; when used in .ui files.

Readable | Writeable

§`action-name`

A detailed action name.

If this is set for a shortcut of type ShortcutType::Accelerator, then GTK will use the accelerators that are associated with the action via GtkApplicationExt::set_accels_for_action(), and setting accelerator is not necessary.

Readable | Writeable

§`direction`

The text direction for which this shortcut is active.

If the shortcut is used regardless of the text direction, set this property to TextDirection::None.

Readable | Writeable

§`icon`

An icon to represent the shortcut or gesture.

This property is used if shortcut-type is set to ShortcutType::Gesture.

For the other predefined gesture types, GTK provides an icon on its own.

Readable | Writeable

§`icon-set`

true if an icon has been set.

Readable | Writeable

§`shortcut-type`

The type of shortcut that is represented.

Readable | Writeable

§`subtitle`

The subtitle for the shortcut or gesture.

This is typically used for gestures and should be a short, one-line text that describes the gesture itself. For the predefined gesture types, GTK provides a subtitle on its own.

Readable | Writeable

§`subtitle-set`

true if a subtitle has been set.

Readable | Writeable

§`title`

The textual description for the shortcut or gesture represented by this object.

This should be a short string that can fit in a single line.

Readable | Writeable

§`title-size-group`

The size group for the textual portion of this shortcut.

This is used internally by GTK, and must not be modified by applications.

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

§Implements

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

GLib type: GObject with reference counted clone semantics.

Struct ShortcutsShortcutCopy item path

§Properties

§accel-size-group

§accelerator

§action-name

§direction

§icon

§icon-set

§shortcut-type

§subtitle

§subtitle-set

§title

§title-size-group

Widget

§can-focus

§can-target

§css-classes

§css-name

§cursor

§focus-on-click

§focusable

§halign

§has-default

§has-focus

§has-tooltip

§height-request

§hexpand

§hexpand-set

§layout-manager

§margin-bottom

§margin-end

§margin-start

§margin-top

§name

§opacity

§overflow

§parent

§receives-default

§root

§scale-factor

§sensitive

§tooltip-markup

§tooltip-text

§valign

§vexpand

§vexpand-set

§visible

§width-request

Accessible

§accessible-role

§Implements

Implementations§

impl ShortcutsShortcut

pub fn builder() -> ShortcutsShortcutBuilder

pub fn set_accel_size_group(&self, accel_size_group: Option<&SizeGroup>)

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

pub fn set_accelerator(&self, accelerator: Option<&str>)

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

pub fn set_action_name(&self, action_name: Option<&str>)

pub fn icon(&self) -> Option<Icon>

pub fn set_icon<P: IsA<Icon>>(&self, icon: Option<&P>)

pub fn is_icon_set(&self) -> bool

pub fn shortcut_type(&self) -> ShortcutType

pub fn set_shortcut_type(&self, shortcut_type: ShortcutType)

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

pub fn set_subtitle(&self, subtitle: Option<&str>)

pub fn is_subtitle_set(&self) -> bool

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

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

pub fn set_title_size_group(&self, title_size_group: Option<&SizeGroup>)

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

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

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

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

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

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

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

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

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

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

Struct ShortcutsShortcut

§`accel-size-group`

§`accelerator`

§`action-name`

§`direction`

§`icon`

§`icon-set`

§`shortcut-type`

§`subtitle`

§`subtitle-set`

§`title`

§`title-size-group`

§`can-focus`

§`can-target`

§`css-classes`

§`css-name`

§`cursor`

§`focus-on-click`

§`focusable`

§`halign`

§`has-default`

§`has-focus`

§`has-tooltip`

§`height-request`

§`hexpand`

§`hexpand-set`

§`layout-manager`

§`margin-bottom`

§`margin-end`

§`margin-start`

§`margin-top`

§`name`

§`opacity`

§`overflow`

§`parent`

§`receives-default`

§`root`

§`scale-factor`

§`sensitive`

§`tooltip-markup`

§`tooltip-text`

§`valign`

§`vexpand`

§`vexpand-set`

§`visible`

§`width-request`

§`accessible-role`

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

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

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

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

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

impl<O> AccessibleExt for O
where O: IsA<Accessible>,