Struct FocusTraversalPolicy 

pub struct FocusTraversalPolicy {
    pub strategy: FocusTraversalStrategy,
    pub wrap: bool,
    pub tab_navigation: bool,
}

Policy applied by a focus scope or group when traversal starts inside it.

Use policies to describe how a container handles directional keys and whether Tab navigation should stay inside the container.

Examples

use tessera_ui::{FocusTraversalPolicy, FocusTraversalStrategy};

let policy = FocusTraversalPolicy::vertical()
    .wrap(true)
    .tab_navigation(true);

assert_eq!(policy.strategy, FocusTraversalStrategy::Vertical);
assert!(policy.wrap);
assert!(policy.tab_navigation);

Fields

strategy: FocusTraversalStrategy

Traversal strategy used for arrow-key navigation.

wrap: bool

Whether traversal wraps when it reaches either end of the group.

tab_navigation: bool

Whether Tab and Shift+Tab should be handled by this policy.

Implementations

impl FocusTraversalPolicy

pub const fn new(strategy: FocusTraversalStrategy) -> Self

Creates a new traversal policy for the given strategy.

pub const fn linear() -> Self

Creates a linear traversal policy.

pub const fn horizontal() -> Self

Creates a horizontal traversal policy.

pub const fn vertical() -> Self

Creates a vertical traversal policy.

pub const fn spatial() -> Self

Creates a spatial traversal policy.

pub const fn wrap(self, wrap: bool) -> Self

Sets whether traversal wraps when it reaches either end.

pub const fn tab_navigation(self, tab_navigation: bool) -> Self

Sets whether Tab and Shift+Tab should be handled inside this policy owner.

Trait Implementations

impl Clone for FocusTraversalPolicy

fn clone(&self) -> FocusTraversalPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FocusTraversalPolicy

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

Formats the value using the given formatter.

impl Hash for FocusTraversalPolicy

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 FocusTraversalPolicy

fn eq(&self, other: &FocusTraversalPolicy) -> 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 FocusTraversalPolicy

impl Eq for FocusTraversalPolicy

impl StructuralPartialEq for FocusTraversalPolicy