Struct KeyWidgetDeclarer 

pub struct KeyWidgetDeclarer<V: 'static> { /* private fields */ }

Implementations

impl<V: 'static> KeyWidgetDeclarer<V>

pub fn key<_M, _V>(self, v: _V) -> Self

where DeclareInit<Key>: DeclareFrom<_V, _M>,

pub fn value(self, v: V) -> Self

impl<V: 'static> KeyWidgetDeclarer<V>

pub fn tab_index<_M, _V>(self, v: _V) -> Self

where DeclareInit<i16>: DeclareFrom<_V, _M>,

Initializes the widget with a tab index. The tab index is used to allow or prevent widgets from being sequentially focusable(usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation

pub fn auto_focus<_M, _V>(self, v: _V) -> Self

where DeclareInit<bool>: DeclareFrom<_V, _M>,

Initializes whether the widget should automatically get focus when the window loads.

pub fn on_event(self, f: impl FnMut(&mut Event) + 'static) -> Self

Attaches an event handler to the widget. It’s triggered when any event or lifecycle change happens.

pub fn on_mounted(self, f: impl FnOnce(&mut LifecycleEvent) + 'static) -> Self

Attaches an event handler that runs when the widget is first mounted to the tree

pub fn on_performed_layout( self, f: impl FnMut(&mut LifecycleEvent) + 'static, ) -> Self

Attaches an event handler that runs after the widget is performed layout.

pub fn on_disposed(self, f: impl FnOnce(&mut LifecycleEvent) + 'static) -> Self

Attaches an event handler that runs when the widget is disposed.

pub fn on_pointer_down(self, f: impl FnMut(&mut PointerEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when a pointer down occurs.

pub fn on_pointer_down_capture( self, f: impl FnMut(&mut PointerEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a pointer down event. This is similar to on_pointer_down, but it’s triggered earlier in the event flow.

pub fn on_pointer_up(self, f: impl FnMut(&mut PointerEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when a pointer up occurs.

pub fn on_pointer_up_capture( self, f: impl FnMut(&mut PointerEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a pointer up event. This is similar to on_pointer_up, but it’s triggered earlier in the event flow.

pub fn on_pointer_move(self, f: impl FnMut(&mut PointerEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when a pointer move occurs.

pub fn on_pointer_move_capture( self, f: impl FnMut(&mut PointerEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a pointer move event. This is similar to on_pointer_move, but it’s triggered earlier in the event flow.

pub fn on_pointer_cancel( self, f: impl FnMut(&mut PointerEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered when a pointer event cancels.

pub fn on_pointer_enter( self, f: impl FnMut(&mut PointerEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered when a pointer device is moved into the hit test boundaries of an widget or one of its descendants

pub fn on_pointer_leave( self, f: impl FnMut(&mut PointerEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered when a pointer device is moved out of the hit test boundaries of an widget or one of its descendants.

pub fn on_tap(self, f: impl FnMut(&mut PointerEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when a tap(click) occurs.

pub fn on_tap_capture(self, f: impl FnMut(&mut PointerEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a tap event. This is similar to on_tap, but it’s triggered earlier in the event flow.

pub fn on_double_tap(self, f: impl FnMut(&mut PointerEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when a double tap occurs.

pub fn on_double_tap_capture( self, f: impl FnMut(&mut PointerEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a double tap event. This is similar to on_double_tap, but it’s triggered earlier in the event flow.

pub fn on_triple_tap(self, f: impl FnMut(&mut PointerEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when a triple tap occurs.

pub fn on_triple_tap_capture( self, f: impl FnMut(&mut PointerEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a triple tap event. This is similar to on_triple_tap, but it’s triggered earlier in the event flow.

pub fn on_x_times_tap( self, f: (usize, impl FnMut(&mut PointerEvent) + 'static), ) -> Self

Attaches a handler to the widget that is triggered when a x-times tap occurs.

pub fn on_x_times_tap_capture( self, f: (usize, impl FnMut(&mut PointerEvent) + 'static), ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a x-times tap event. This is similar to on_x_times_tap, but it’s triggered earlier in the event flow.

pub fn on_wheel(self, f: impl FnMut(&mut WheelEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when the user rotates a wheel button on a pointing device (typically a mouse).

pub fn on_wheel_capture(self, f: impl FnMut(&mut WheelEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a wheel event. This is similar to on_wheel, but it’s triggered earlier in the event flow.

pub fn on_ime_pre_edit( self, f: impl FnMut(&mut ImePreEditEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered when the input method pre-edit area is changed.

pub fn on_ime_pre_edit_capture( self, f: impl FnMut(&mut ImePreEditEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a input method pre-edit event. This is similar to on_ime_pre_edit, but it’s triggered earlier in the event flow.

pub fn on_chars(self, f: impl FnMut(&mut CharsEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when the input method commits text or keyboard pressed the text key

pub fn on_chars_capture(self, f: impl FnMut(&mut CharsEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a input method commit event. This is similar to on_chars, but it’s triggered earlier in the event flow.

pub fn on_key_down(self, f: impl FnMut(&mut KeyboardEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when the keyboard key is pressed.

pub fn on_key_down_capture( self, f: impl FnMut(&mut KeyboardEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a key down event. This is similar to on_key_down, but it’s triggered earlier in the event flow.

pub fn on_key_up(self, f: impl FnMut(&mut KeyboardEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when the keyboard key is released.

pub fn on_key_up_capture( self, f: impl FnMut(&mut KeyboardEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a key up event. This is similar to on_key_up, but it’s triggered earlier in the event flow.

pub fn on_focus(self, f: impl FnMut(&mut FocusEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when the widget is focused.

pub fn on_blur(self, f: impl FnMut(&mut FocusEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when the widget is lost focus.

pub fn on_focus_in(self, f: impl FnMut(&mut FocusEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when the widget or its descendants are focused. The main difference between this event and focus is that focusin bubbles while focus does not.

pub fn on_focus_in_capture( self, f: impl FnMut(&mut FocusEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a focus in event. This is similar to on_focus_in, but it’s triggered earlier in the event flow.

pub fn on_focus_out(self, f: impl FnMut(&mut FocusEvent) + 'static) -> Self

Attaches a handler to the widget that is triggered when the widgetor its descendants are lost focus. The main difference between this event and focusout is that focusout bubbles while blur does not

pub fn on_focus_out_capture( self, f: impl FnMut(&mut FocusEvent) + 'static, ) -> Self

Attaches a handler to the widget that is triggered during the capture phase of a focus out event. This is similar to on_focus_out, but it’s triggered earlier in the event flow.

pub fn box_fit<_M, _V>(self, v: _V) -> Self

where DeclareInit<BoxFit>: DeclareFrom<_V, _M>,

Initializes how its child should be scale to fit its box.

pub fn background<_M, _V>(self, v: _V) -> Self

where DeclareInit<Option<Brush>>: DeclareFrom<_V, _M>,

Initializes the background of the widget.

pub fn border<_M, _V>(self, v: _V) -> Self

where DeclareInit<Option<Border>>: DeclareFrom<_V, _M>,

Initializes the border of the widget.

pub fn border_radius<_M, _V>(self, v: _V) -> Self

where DeclareInit<Option<Radius>>: DeclareFrom<_V, _M>,

Initializes the border radius of the widget.

pub fn padding<_M, _V>(self, v: _V) -> Self

where DeclareInit<EdgeInsets>: DeclareFrom<_V, _M>,

Initializes the extra space within the widget.

pub fn cursor<_M, _V>(self, v: _V) -> Self

where DeclareInit<CursorIcon>: DeclareFrom<_V, _M>,

Initializes the cursor of the widget.

pub fn margin<_M, _V>(self, v: _V) -> Self

where DeclareInit<EdgeInsets>: DeclareFrom<_V, _M>,

Initializes the space around the widget.

pub fn scrollable<_M, _V>(self, v: _V) -> Self

where DeclareInit<Scrollable>: DeclareFrom<_V, _M>,

Initializes how user can scroll the widget.

pub fn scroll_pos<_M, _V>(self, v: _V) -> Self

where DeclareInit<Point>: DeclareFrom<_V, _M>,

Initializes the scroll position of the widget.

pub fn transform<_M, _V>(self, v: _V) -> Self

where DeclareInit<Transform>: DeclareFrom<_V, _M>,

Initializes the transformation of the widget.

pub fn h_align<_M, _V>(self, v: _V) -> Self

where DeclareInit<HAlign>: DeclareFrom<_V, _M>,

Initializes how the widget should be aligned horizontally.

pub fn v_align<_M, _V>(self, v: _V) -> Self

where DeclareInit<VAlign>: DeclareFrom<_V, _M>,

Initializes how the widget should be aligned vertically.

pub fn anchor<_M, _V>(self, v: _V) -> Self

where DeclareInit<Anchor>: DeclareFrom<_V, _M>,

Initializes the relative anchor to the parent of the widget

pub fn global_anchor<_M, _V>(self, v: _V) -> Self

where DeclareInit<Anchor>: DeclareFrom<_V, _M>,

Initializes the global anchor of the widget.

pub fn visible<_M, _V>(self, v: _V) -> Self

where DeclareInit<bool>: DeclareFrom<_V, _M>,

Initializes the visibility of the widget.

pub fn opacity<_M, _V>(self, v: _V) -> Self

where DeclareInit<f32>: DeclareFrom<_V, _M>,

Initializes the opacity of the widget.

pub fn keep_alive<_M, _V>(self, v: _V) -> Self

where DeclareInit<bool>: DeclareFrom<_V, _M>,

Initializes the keep_alive value of the KeepAlive widget.

Trait Implementations

impl<V: 'static> ObjDeclarer for KeyWidgetDeclarer<V>

type Target = FatObj<State<KeyWidget<V>>>

fn finish(self, _ctx_ಠ_ಠ: &BuildCtx<'_>) -> Self::Target

Finish the object creation with the given context.