Struct ShortcutText 

pub struct ShortcutText(/* private fields */);

W Display keyboard shortcuts.

Implementations

impl ShortcutText

pub fn widget_new() -> ShortcutText

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl ShortcutText

pub fn font_size(&self, size: impl IntoVar<Length>)

P Font size of the shortcut text.

pub fn font_color(&self, color: impl IntoVar<Rgba>)

P Font color of the shortcut text.

impl ShortcutText

pub fn shortcut(&self, shortcuts: impl IntoVar<Shortcuts>)

B Shortcut(s) that must be displayed

impl ShortcutText

pub fn first_n(&self, n: impl IntoVar<usize>)

P Maximum number of shortcuts to display.

This property sets the FIRST_N_VAR.

impl ShortcutText

pub fn panel_fn(&self, panel_fn: impl IntoVar<WidgetFn<PanelFnArgs>>)

P Widget function that converts PanelFnArgs to a widget.

This property sets the PANEL_FN_VAR.

impl ShortcutText

pub fn none_fn(&self, none_fn: impl IntoVar<WidgetFn<NoneFnArgs>>)

P Widget function that converts NoneFnArgs to a widget.

This property sets the NONE_FN_VAR.

impl ShortcutText

pub fn shortcuts_separator_fn( &self, separator_fn: impl IntoVar<WidgetFn<ShortcutsSeparatorFnArgs>>, )

P Widget function that converts ShortcutsSeparatorFnArgs to a widget.

This is the separators between shortcuts, when first_n is more than one and the shortcut has mode them one shortcut.

Set to nil to not generate a separator.

This property sets the SHORTCUTS_SEPARATOR_FN_VAR.

impl ShortcutText

pub fn shortcut_fn(&self, panel_fn: impl IntoVar<WidgetFn<ShortcutFnArgs>>)

P Widget function that converts ShortcutFnArgs to a widget.

Set to WidgetFn::nil or return the items as a node to pass the items directly to panel_fn.

This property sets the SHORTCUT_FN_VAR.

impl ShortcutText

pub fn chord_separator_fn( &self, separator_fn: impl IntoVar<WidgetFn<ChordSeparatorFnArgs>>, )

P Widget function that converts ChordSeparatorFnArgs to a widget.

This is the separator between the starter and complement in a KeyChord.

This property sets the CHORD_SEPARATOR_FN_VAR.

impl ShortcutText

pub fn key_gesture_fn(&self, panel_fn: impl IntoVar<WidgetFn<KeyGestureFnArgs>>)

P Widget function that converts KeyGestureFnArgs to a widget.

Set to WidgetFn::nil or return the items as a node to pass the items directly to shortcut_fn.

This property sets the KEY_GESTURE_FN_VAR.

impl ShortcutText

pub fn key_gesture_separator_fn( &self, separator_fn: impl IntoVar<WidgetFn<KeyGestureSeparatorFnArgs>>, )

P Widget function that converts KeyGestureSeparatorFnArgs to a widget.

This is the separator between the modifiers and key in a KeyGesture.

This property sets the KEY_GESTURE_SEPARATOR_FN_VAR.

impl ShortcutText

pub fn modifier_fn(&self, modifier_fn: impl IntoVar<WidgetFn<ModifierFnArgs>>)

P Widget function that converts a ModifierFnArgs to a widget.

This is used for both the Shortcut::Modifier standalone and the KeyGesture::modifiers flags.

This property sets the MODIFIER_FN_VAR.

impl ShortcutText

pub fn key_fn(&self, key_fn: impl IntoVar<WidgetFn<KeyFnArgs>>)

P Widget function that converts a KeyFnArgs to a widget.

This property sets the KEY_FN_VAR.

Methods from Deref<Target = WidgetBase>

pub fn widget_builder(&mut self) -> &mut WidgetBuilder

Returns a mutable reference to the widget builder.

pub fn widget_when(&mut self) -> Option<&mut WhenInfo>

Returns a mutable reference to the when block if called inside a when block.

pub fn widget_take(&mut self) -> WidgetBuilder

Takes the widget builder, finishing the widget macro build.

After this call trying to set a property using self will panic, the returned builder can still be manipulated directly.

pub fn widget_build(&mut self) -> UiNode

Build the widget.

After this call trying to set a property will panic.

pub fn widget_importance(&mut self) -> &mut Importance

Returns a mutable reference to the importance of the next property assigns, unsets or when blocks.

Note that during the widget_intrinsic call this is Importance::WIDGET and after it is Importance::INSTANCE.

pub fn start_when_block( &mut self, inputs: Box<[WhenInput]>, state: Var<bool>, expr: &'static str, location: SourceLocation, )

Start building a when block, all properties set after this call are pushed in the when block.

pub fn end_when_block(&mut self)

End the current when block, all properties set after this call are pushed in the widget.

pub fn id(&self, id: impl IntoValue<WidgetId>)

B Unique ID of the widget instance.

Note that the id can convert from a &'static str unique name.

Trait Implementations

impl Deref for ShortcutText

type Target = WidgetBase

The resulting type after dereferencing.

fn deref(&self) -> &<ShortcutText as Deref>::Target

Dereferences the value.

impl DerefMut for ShortcutText

fn deref_mut(&mut self) -> &mut <ShortcutText as Deref>::Target

Mutably dereferences the value.