Skip to main content

FocusIndicator

Struct FocusIndicator 

Source
pub struct FocusIndicator { /* private fields */ }
Expand description

Tracks which node currently holds focus and the visual ring spec to use.

Renderers query FocusIndicator::focused_node to know which widget is focused and FocusIndicator::ring to know how to draw its outline.

This is intentionally decoupled from crate::tree::A11yTree’s focus field (which drives the AccessKit TreeUpdate::focus field for screen readers). Both should be kept in sync, but keeping them separate allows the render layer to style the ring independently of the a11y adapter.

Implementations§

Source§

impl FocusIndicator

Source

pub fn new() -> Self

Create a new indicator with no focused node and the default ring spec.

Source

pub fn set_focus(&mut self, id: Option<NodeId>)

Set (or clear) the currently focused node.

Pass None to clear the focus — no ring will be rendered.

Source

pub fn focused_node(&self) -> Option<NodeId>

Return the NodeId of the currently focused node, if any.

Source

pub fn ring(&self) -> &FocusRing

Return a shared reference to the current FocusRing spec.

Source

pub fn with_ring(self, ring: FocusRing) -> Self

Replace the ring spec with a custom one (builder-style).

Trait Implementations§

Source§

impl Default for FocusIndicator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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.

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.