Struct FocusRequester 

pub struct FocusRequester { /* private fields */ }

Imperative handle used to request focus for a registered target.

Requesters are stable handles that can be stored in component state and passed across component boundaries without exposing the underlying focus tree.

Examples

use tessera_ui::FocusRequester;

let first = FocusRequester::new();
let second = FocusRequester::new();
assert_ne!(first, second);

Implementations

impl FocusRequester

pub fn new() -> Self

Creates a new focus requester.

pub fn request_focus(&self)

Requests focus for the bound target.

pub fn clear_focus(&self)

Clears focus from the bound target if it currently holds it.

pub fn unfocus(&self)

Alias for Self::clear_focus.

pub fn capture_focus(&self)

Captures focus on this node, preventing focus from moving elsewhere until released or force-cleared.

pub fn free_focus(&self)

Releases captured focus from this node.

pub fn state(&self) -> FocusState

Returns the current focus state for the bound target.

pub fn has_focus(&self) -> bool

Returns true when this node is in the active focus path.

pub fn is_focused(&self) -> bool

Returns true when this node is the primary focused node.

pub fn is_captured(&self) -> bool

Returns true when this node has captured focus.

Trait Implementations

impl Clone for FocusRequester

fn clone(&self) -> FocusRequester

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FocusRequester

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FocusRequester

fn default() -> Self

Returns the “default value” for a type.

impl Hash for FocusRequester

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FocusRequester

fn eq(&self, other: &FocusRequester) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FocusRequester

impl Eq for FocusRequester

impl StructuralPartialEq for FocusRequester