Struct TabIndex

pub struct TabIndex(pub u32);

Widget tab navigation position within a focus scope.

The index is zero based, zero first.

Tuple Fields

0: u32

Implementations

impl TabIndex

pub const SKIP: TabIndex = _

Widget is skipped during tab navigation.

The integer value is u32::MAX.

pub const AUTO: TabIndex = _

Default focusable widget index.

Tab navigation uses the widget position in the widget tree when multiple widgets have the same index so if no widget index is explicitly set they get auto-sorted by their position.

The integer value is u32::MAX / 2.

pub const LAST: TabIndex = _

Last possible widget index.

pub fn is_skip(self) -> bool

If is SKIP.

pub fn is_auto(self) -> bool

If is AUTO.

pub fn is_before_auto(self) -> bool

If is a custom index placed before auto.

pub fn is_after_auto(self) -> bool

If is a custom index placed after auto.

pub fn not_skip(index: u32) -> Self

Create a new tab index that is guaranteed to not be SKIP.

Returns SKIP - 1 if index is SKIP.

pub fn before_auto(index: u32) -> Self

Create a new tab index that is guaranteed to be before AUTO.

Returns AUTO - 1 if index is equal to or greater then AUTO.

pub fn after_auto(index: u32) -> Self

Create a new tab index that is guaranteed to be after AUTO and not SKIP.

The index argument is zero based here.

Returns not_skip(AUTO + 1 + index).

Trait Implementations

impl Clone for TabIndex

fn clone(&self) -> TabIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TabIndex

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

Formats the value using the given formatter.

impl Default for TabIndex

fn default() -> Self

AUTO

impl<'de> Deserialize<'de> for TabIndex

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<u32> for TabIndex

fn from(index: u32) -> Self

Calls TabIndex::not_skip.

impl Hash for TabIndex

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 IntoVar<TabIndex> for u32

fn into_var(self) -> Self::Var

Calls TabIndex::not_skip.

type Var = LocalVar<TabIndex>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl Ord for TabIndex

fn cmp(&self, other: &TabIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TabIndex

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

fn partial_cmp(&self, other: &TabIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TabIndex

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TabIndex

impl Eq for TabIndex

impl IntoValue<TabIndex> for u32

impl StructuralPartialEq for TabIndex