Skip to main content

FocusIndicator

Struct FocusIndicator 

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

Configuration for how focused widgets render their focus cue.

Combines a FocusIndicatorKind (what to draw) with a Style (how to draw it). Widgets call style to get the overlay style and kind to decide the rendering strategy.

Implementations§

Source§

impl FocusIndicator

Source

pub fn style_overlay(style: Style) -> Self

Create a focus indicator with a custom style overlay.

Source

pub fn underline() -> Self

Create a focus indicator that underlines focused content.

Source

pub fn border() -> Self

Create a focus indicator that highlights the widget border.

Source

pub fn none() -> Self

Create a focus indicator with no visual cue.

Source

pub fn with_style(self, style: Style) -> Self

Set the style for this indicator.

Source

pub fn with_kind(self, kind: FocusIndicatorKind) -> Self

Set the kind of indicator.

Source

pub fn kind(&self) -> FocusIndicatorKind

Get the indicator kind.

Source

pub fn style(&self) -> Style

Get the focus style to apply.

Source

pub fn is_visible(&self) -> bool

Check if this indicator has a visible focus cue.

Source

pub fn apply_to(&self, base: Style) -> Style

Apply the focus style as an overlay on the given base style.

The focus style’s set properties override the base; unset properties fall through from the base.

Trait Implementations§

Source§

impl Clone for FocusIndicator

Source§

fn clone(&self) -> FocusIndicator

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FocusIndicator

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FocusIndicator

Source§

fn default() -> Self

Default focus indicator: reverse video overlay.

Source§

impl Hash for FocusIndicator

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FocusIndicator

Source§

fn eq(&self, other: &FocusIndicator) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for FocusIndicator

Source§

impl Eq for FocusIndicator

Source§

impl StructuralPartialEq for FocusIndicator

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more