Struct FocusHandle 

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

A handle which can be used to track and manipulate the focused element in a window.

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 tab index of the element associated with this handle.

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

Sets whether the element associated with this handle is a tab stop.

When false, the element will not be included in the tab order.

pub fn downgrade(&self) -> WeakFocusHandle

Converts this focus handle into a weak variant, which does not prevent it from being released.

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

Moves the focus to the element associated with this handle.

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

Obtains whether the element associated with this handle is currently focused.

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

Obtains whether the element associated with this handle contains the focused element or is itself focused.

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

Obtains whether the element associated with this handle is contained within the focused element or is itself focused.

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

Obtains whether this handle contains the given handle in the most recently rendered frame.

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

Dispatch an action on the element that rendered this focus handle

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.

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

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

Converts to this type from the input type.

impl PartialEq<FocusHandle> for WeakFocusHandle

fn eq(&self, other: &FocusHandle) -> 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 PartialEq<WeakFocusHandle> for FocusHandle

fn eq(&self, other: &WeakFocusHandle) -> 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 PartialEq for FocusHandle

fn eq(&self, other: &Self) -> 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 Eq for FocusHandle