Struct FocusHandle 

pub struct FocusHandle {
    pub tab_index: isize,
    pub tab_stop: bool,
    /* private fields */
}

A handle that makes an element focusable and tracks whether it has focus.

Create one with App::focus_handle in the view that owns the element, store it in the view, and attach it to the element with InteractiveElement::track_focus. While a clone of the handle is alive, the window keeps the element’s focus id.

Use Window::focus to move focus to a handle and Window::focused to find the handle that has focus. FocusHandle::downgrade returns a WeakFocusHandle, which doesn’t keep the focus id alive.

Examples

let focus_handle = cx.focus_handle();
window.focus(&focus_handle, cx);
Field { focus_handle }
window.update(|field, window, _cx| assert!(field.focus_handle.is_focused(window)));

See the focus guide and input dispatch.

Fields

tab_index: isize

The index of this element in the tab order.

tab_stop: bool

Whether this element can be focused by tab navigation.

Implementations

impl FocusHandle

pub fn tab_index(self, index: isize) -> Self

Sets the index that orders this handle among tab stops.

The index is stored in the window’s focus map, so it applies to every clone of this handle. It affects only the order used by Window::focus_next and Window::focus_prev.

Examples

let handle = cx.focus_handle().tab_index(2).tab_stop(true);
assert_eq!(handle.tab_index, 2);
assert!(handle.tab_stop);

pub fn tab_stop(self, tab_stop: bool) -> Self

Sets whether this handle is a tab stop.

When false, Window::focus_next and Window::focus_prev skip this element. Programmatic focus with Window::focus still works.

pub fn downgrade(&self) -> WeakFocusHandle

Returns a WeakFocusHandle that doesn’t keep the focus id alive.

pub fn focus(&self, window: &mut Window, cx: &mut App)

Moves focus to this handle’s element. Same as Window::focus.

pub fn is_focused(&self, window: &Window) -> bool

Returns whether this handle’s element has focus.

pub fn contains_focused(&self, window: &Window, cx: &App) -> bool

Returns whether the focused element is this element or one of its descendants.

pub fn within_focused(&self, window: &Window, cx: &mut App) -> bool

Returns whether the focused element is this element’s ancestor or the element itself.

pub fn contains(&self, other: &Self, window: &Window) -> bool

Returns whether other is this element or a descendant of it, using the last rendered frame.

pub fn dispatch_action( &self, action: &dyn Action, window: &mut Window, cx: &mut App, )

Dispatches action along the element that rendered this handle.

The action runs through the element’s capture and bubble listeners, the same way a keybinding would dispatch it. Nothing happens if the element isn’t in the last rendered frame.

Trait Implementations

impl Clone for FocusHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FocusHandle

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

Formats the value using the given formatter.

impl Drop for FocusHandle

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for FocusHandle

impl<'a> From<&'a FocusHandle> for ElementId

fn from(handle: &'a FocusHandle) -> Self

Converts to this type from the input type.

impl PartialEq for FocusHandle

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<FocusHandle> for WeakFocusHandle

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<WeakFocusHandle> for FocusHandle

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

Equality operator ==.

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

Inequality operator !=.