zng_ext_input::focus

Struct FocusInfoBuilder

source
pub struct FocusInfoBuilder<'a>(/* private fields */);
Expand description

Builder for FocusInfo accessible in a WidgetInfoBuilder.

There are multiple focusable metadata that can be set on a widget. These rules define how the focusable state of a widget is derived from the focusable metadata.

§Rules

The widget is not focusable nor a focus scope if it set focusable to false.

The widget is a focus scope if it set scope to true or if it set tab_nav or directional_nav and did not set scope to false.

The widget is focusable if it set focusable to true or if it set the tab_index.

The widget is a focus scope if it sets nested_window, but the focus will always move inside the nested window.

The widget is not focusable if it did not set any of the members mentioned.

§Tab Index

If the tab_index was not set but the widget is focusable or a focus scope, the TabIndex::AUTO is used for the widget.

§Skip Directional

If the skip_directional was not set but the widget is focusable or a focus scope, it is set to false for the widget.

§Focus Scope

If the widget is a focus scope, it is configured using alt_scope and on_focus. If the widget is not a scope these members are ignored.

§Tab Navigation

If tab_nav is not set but the widget is a focus scope, TabNav::Continue is used.

§Directional Navigation

If directional_nav is not set but the widget is a focus scope, DirectionalNav::Continue is used.

Implementations§

source§

impl<'a> FocusInfoBuilder<'a>

source

pub fn new(builder: &'a mut WidgetInfoBuilder) -> Self

New the builder.

source

pub fn focusable(&mut self, is_focusable: bool) -> &mut Self

If the widget is definitely focusable or not.

source

pub fn focusable_passive(&mut self, is_focusable: bool) -> &mut Self

Sets focusable, only if it was not already set.

source

pub fn scope(&mut self, is_focus_scope: bool) -> &mut Self

If the widget is definitely a focus scope or not.

source

pub fn alt_scope(&mut self, is_alt_focus_scope: bool) -> &mut Self

If the widget is definitely an ALT focus scope or not.

If true this also sets TabIndex::SKIP, skip_directional_nav, TabNav::Cycle and DirectionalNav::Cycle as default.

source

pub fn on_focus( &mut self, as_focus_scope_on_focus: FocusScopeOnFocus, ) -> &mut Self

When the widget is a focus scope, its behavior on receiving direct focus.

source

pub fn tab_index(&mut self, tab_index: TabIndex) -> &mut Self

Widget TAB index.

source

pub fn tab_nav(&mut self, scope_tab_nav: TabNav) -> &mut Self

TAB navigation within this widget, if set turns the widget into a focus scope.

source

pub fn directional_nav( &mut self, scope_directional_nav: DirectionalNav, ) -> &mut Self

Directional navigation within this widget, if set turns the widget into a focus scope.

source

pub fn skip_directional(&mut self, skip: bool) -> &mut Self

If directional navigation skips over this widget.

Auto Trait Implementations§

§

impl<'a> Freeze for FocusInfoBuilder<'a>

§

impl<'a> !RefUnwindSafe for FocusInfoBuilder<'a>

§

impl<'a> Send for FocusInfoBuilder<'a>

§

impl<'a> Sync for FocusInfoBuilder<'a>

§

impl<'a> Unpin for FocusInfoBuilder<'a>

§

impl<'a> !UnwindSafe for FocusInfoBuilder<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> StateValue for T
where T: Any + Send + Sync,