Struct freya_hooks :: UseFocus Copy item path

impl UseFocus

pub fn new_id() -> AccessibilityId

pub fn request_focus(&mut self)

Request to focus accessibility node. This will not immediately update Self::is_focused.

pub fn request_unfocus(&mut self)

Request to unfocus accessibility node. This will not immediately update Self::is_focused.

pub fn focus_id(id: AccessibilityId)

Focus a given [AccessibilityId].

pub fn id(&self) -> AccessibilityId

Get [AccessibilityId] of this accessibility node.

pub fn attribute(&self) -> AttributeValue

Create a freya_elements::elements::rect::a11y_id attribute value for this accessibility node.

pub fn attribute_for_id(id: AccessibilityId) -> AttributeValue

Create a freya_elements::elements::rect::a11y_id attribute value for a given [AccessibilityId].

pub fn is_focused(&self) -> bool

Subscribe to focus changes where this node was involved.

pub fn is_focused_with_keyboard(&self) -> bool

Subscribe to focus changes where this node was involved and the keyboard was used.

pub fn validate_keydown(&self, e: &KeyboardEvent) -> bool

Useful if you want to trigger an action when Enter or Space is pressed and this Node was focused with the keyboard.

pub fn prevent_navigation(&mut self)

Prevent navigating the accessible nodes with the keyboard. You must use this this inside of a onglobalkeydown event handler.

pub fn focused_id(&self) -> ReadOnlySignal<AccessibilityId>

Get a readable of the currently focused Node Id.

pub fn focused_node(&self) -> ReadOnlySignal<AccessibilityNode>

Get a readable of the currently focused Node.

Trait Implementations§

impl Clone for UseFocus

fn clone(&self) -> UseFocus

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Copy for UseFocus

Auto Trait Implementations§

impl !UnwindSafe for UseFocus

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> InitializeFromFunction<T> for T

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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