pub struct OtpField { /* private fields */ }Expand description
A controlled, unstyled OTP-field descriptor.
The application owns the slot boxes, separators, caret styling, and layout. QuickGUI supplies
stable part identities, the Group role with per-slot position semantics, one-character slots
composed from the existing crate::text_input, automatic advance, Backspace and arrow
behavior, paste distribution, validity, and optional submission of the caller’s nearest form.
The descriptor retains no allocation, task, timer, observer, or idle scheduler source.
Implementations§
Source§impl OtpField
impl OtpField
pub fn new(root_id: impl Into<ElementId>) -> Self
Sourcepub fn auto_submit(self, form: impl Into<ElementId>) -> Self
pub fn auto_submit(self, form: impl Into<ElementId>) -> Self
Submit the named form as soon as the final slot is filled.
QuickGUI routes the request through crate::EventContext::submit_form, so the form is
validated exactly as a Return press or a submit button would validate it. Pass the id of
the nearest mounted crate::form ancestor.
pub const fn root_id(self) -> ElementId
pub const fn submitted_form(self) -> Option<ElementId>
pub fn input_id(self, index: usize) -> ElementId
pub fn separator_id(self, index: usize) -> ElementId
Sourcepub fn root_with(self, state: &OtpFieldState, root: Element) -> Element
pub fn root_with(self, state: &OtpFieldState, root: Element) -> Element
Decorate an application-owned root without adding layout or appearance.
The root is the group that names the whole code and carries its validity, so assistive technology announces one field rather than a row of unrelated one-character inputs.
Sourcepub fn root(self, state: &OtpFieldState) -> Element
pub fn root(self, state: &OtpFieldState) -> Element
Create the unstyled root part. Use Self::root_with to supply an existing element.
Sourcepub fn input_with(
self,
state: &OtpFieldState,
index: usize,
input: Element,
) -> Element
pub fn input_with( self, state: &OtpFieldState, index: usize, input: Element, ) -> Element
Decorate one application-owned slot input without adding appearance.
Pass a crate::text_input built from OtpFieldState::slot_text. QuickGUI adds the
stable identity, the slot’s position in the code, the masked presentation, and the required
and disabled policy. Use Self::slot_with to attach the behavior as well.
Sourcepub fn input(self, state: &OtpFieldState, index: usize) -> Element
pub fn input(self, state: &OtpFieldState, index: usize) -> Element
Create the unstyled input part. Use Self::input_with to supply an existing element.
Sourcepub fn separator_with(self, index: usize, separator: Element) -> Element
pub fn separator_with(self, index: usize, separator: Element) -> Element
Decorate an application-owned separator between two slots.
The separator is decorative: it carries a stable identity and the Separator role, and is hidden from assistive technology so it never interrupts the announced code.
Sourcepub fn separator(self, index: usize) -> Element
pub fn separator(self, index: usize) -> Element
Create the unstyled separator part. Use Self::separator_with to supply an existing element.
Sourcepub fn slot_with<V: 'static, Change, Complete>(
self,
cx: &mut ViewContext<'_, V>,
state: &OtpFieldState,
index: usize,
input: Element,
access: fn(&mut V) -> &mut OtpFieldState,
on_value_change: Change,
on_complete: Complete,
) -> Elementwhere
Change: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Complete: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
pub fn slot_with<V: 'static, Change, Complete>(
self,
cx: &mut ViewContext<'_, V>,
state: &OtpFieldState,
index: usize,
input: Element,
access: fn(&mut V) -> &mut OtpFieldState,
on_value_change: Change,
on_complete: Complete,
) -> Elementwhere
Change: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Complete: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Decorate one slot and attach its complete behavior.
This registers the slot’s input listener and its typed keyboard actions. Install
otp_field_key_bindings once on the application keymap. on_value_change runs for every
change with the whole code; on_complete runs only on the transition into a full code, and
is followed by Self::auto_submit when one is declared.
Sourcepub fn slot<V: 'static, Change, Complete>(
self,
cx: &mut ViewContext<'_, V>,
state: &OtpFieldState,
index: usize,
access: fn(&mut V) -> &mut OtpFieldState,
on_value_change: Change,
on_complete: Complete,
) -> Elementwhere
Change: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Complete: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
pub fn slot<V: 'static, Change, Complete>(
self,
cx: &mut ViewContext<'_, V>,
state: &OtpFieldState,
index: usize,
access: fn(&mut V) -> &mut OtpFieldState,
on_value_change: Change,
on_complete: Complete,
) -> Elementwhere
Change: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Complete: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Create the unstyled slot part. Use Self::slot_with to supply an existing element.
Sourcepub fn slot_with_accessor<V: 'static, Change, Complete>(
self,
cx: &mut ViewContext<'_, V>,
state: &OtpFieldState,
index: usize,
input: Element,
access: StateAccessor<V, OtpFieldState>,
on_value_change: Change,
on_complete: Complete,
) -> Elementwhere
Change: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Complete: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
pub fn slot_with_accessor<V: 'static, Change, Complete>(
self,
cx: &mut ViewContext<'_, V>,
state: &OtpFieldState,
index: usize,
input: Element,
access: StateAccessor<V, OtpFieldState>,
on_value_change: Change,
on_complete: Complete,
) -> Elementwhere
Change: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Complete: Fn(&mut V, &str, &mut EventContext) + Clone + 'static,
Decorate one slot and attach its behavior against a per-instance state accessor.
Trait Implementations§
impl Copy for OtpField
impl StructuralPartialEq for OtpField
Auto Trait Implementations§
impl Forget for OtpField
impl Freeze for OtpField
impl Move for OtpField
impl RefUnwindSafe for OtpField
impl Send for OtpField
impl Sync for OtpField
impl Unpin for OtpField
impl UnsafeUnpin for OtpField
impl UnwindSafe for OtpField
Blanket Implementations§
impl<T> Action for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.