Struct FocusProperties 

pub struct FocusProperties {
    pub can_focus: bool,
    pub can_request_focus: bool,
    pub skip_traversal: bool,
    pub next: Option<FocusRequester>,
    pub previous: Option<FocusRequester>,
    pub up: Option<FocusRequester>,
    pub down: Option<FocusRequester>,
    pub left: Option<FocusRequester>,
    pub right: Option<FocusRequester>,
    pub enter: Option<FocusRequester>,
    pub exit: Option<FocusRequester>,
}

Focus properties used when registering a focus node on the current component.

Use properties to enable or disable focus participation and to declare explicit traversal neighbors for complex layouts.

Examples

use tessera_ui::{FocusProperties, FocusRequester};

let next = FocusRequester::new();
let right = FocusRequester::new();
let props = FocusProperties::new()
    .can_focus(true)
    .skip_traversal(false)
    .next(next)
    .right(right);

assert_eq!(props.next, Some(next));
assert_eq!(props.right, Some(right));
assert!(props.can_focus);
assert!(!props.skip_traversal);

Fields

can_focus: bool

Whether this node may receive focus.

can_request_focus: bool

Whether this node may be the target of focus requests.

skip_traversal: bool

Whether traversal should skip this node.

next: Option<FocusRequester>

Explicit target for Next traversal.

previous: Option<FocusRequester>

Explicit target for Previous traversal.

up: Option<FocusRequester>

Explicit target for Up traversal.

down: Option<FocusRequester>

Explicit target for Down traversal.

left: Option<FocusRequester>

Explicit target for Left traversal.

right: Option<FocusRequester>

Explicit target for Right traversal.

enter: Option<FocusRequester>

Explicit target when entering a nested focus region.

exit: Option<FocusRequester>

Explicit target when exiting a focus region.

Implementations

impl FocusProperties

pub fn new() -> Self

Creates the default focus properties for focus targets.

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

Sets whether this node may receive focus.

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

Sets whether this node may be the target of focus requests.

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

Sets whether traversal should skip this node.

pub fn next(self, requester: FocusRequester) -> Self

Sets the explicit requester for Next traversal.

pub fn previous(self, requester: FocusRequester) -> Self

Sets the explicit requester for Previous traversal.

pub fn up(self, requester: FocusRequester) -> Self

Sets the explicit requester for Up traversal.

pub fn down(self, requester: FocusRequester) -> Self

Sets the explicit requester for Down traversal.

pub fn left(self, requester: FocusRequester) -> Self

Sets the explicit requester for Left traversal.

pub fn right(self, requester: FocusRequester) -> Self

Sets the explicit requester for Right traversal.

pub fn enter(self, requester: FocusRequester) -> Self

Sets the explicit requester used when moving focus into a group.

pub fn exit(self, requester: FocusRequester) -> Self

Sets the explicit requester used when moving focus out of a group.

Trait Implementations

impl Clone for FocusProperties

fn clone(&self) -> FocusProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FocusProperties

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

Formats the value using the given formatter.

impl Default for FocusProperties

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FocusProperties

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

impl Eq for FocusProperties

impl StructuralPartialEq for FocusProperties