Struct FocusFlag 

pub struct FocusFlag(/* private fields */);

Holds the flags for the focus.

Add this to the widget state and implement HasFocus to manage your widgets focus state.

Note

This struct is intended to be cloned and uses a Rc internally to share the state.

Note

Equality and Hash and the id() function use the memory address of the FocusFlag behind the internal Rc<>.

See HasFocus, on_gained! and on_lost!.

Implementations

impl FocusFlag

pub fn new() -> FocusFlag

Create a default flag.

pub fn new_instance(&self) -> FocusFlag

Create a deep copy of the FocusFlag.

Caution

It will lose the on_gained() and on_lost() callbacks. Those can not be replicated/cloned as they will most probably hold some Rc’s to somewhere.

You will need to set them anew.

pub fn widget_id(&self) -> usize

Return an identity value.

This uses the memory address of the backing Rc so it will be unique during the runtime but will be different for each run.

pub fn named(name: impl AsRef<str>) -> FocusFlag

👎Deprecated since 1.4.0: to dangerous, use FocusFlag::new().with_name(..) or FocusFlag::fake_clone(..) for a clone.

Create a named flag.

The name is only used for debugging.

pub fn with_name(self, name: &str) -> FocusFlag

Set a name for a FocusFlag.

pub fn get(&self) -> bool

Has the focus.

pub fn set(&self, focus: bool)

Set the focus.

pub fn name(&self) -> Box<str>

Get the field-name.

pub fn set_name(&self, name: &str)

Set the field-name.

pub fn lost(&self) -> bool

Just lost the focus.

pub fn set_lost(&self, lost: bool)

Set the lost-flag.

This doesn’t call the on_lost callback.

pub fn on_lost(&self, on_lost: impl Fn() + 'static)

Set an on_lost callback. The intention is that widget-creators can use this to get guaranteed notifications on focus-changes.

This is not an api for widget *users.

pub fn call_on_lost(&self)

Notify an on_lost() tragedy.

pub fn gained(&self) -> bool

Just gained the focus.

pub fn set_gained(&self, gained: bool)

Set the gained-flag.

This doesn’t call the on_gained callback.

pub fn on_gained(&self, on_gained: impl Fn() + 'static)

Set an on_gained callback. The intention is that widget-creators can use this to get guaranteed notifications on focus-changes.

This is not an api for widget *users.

pub fn call_on_gained(&self)

Notify an on_gained() comedy.

pub fn clear(&self)

Reset all flags to false.

Trait Implementations

impl Clone for FocusFlag

fn clone(&self) -> FocusFlag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FocusFlag

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

Formats the value using the given formatter.

impl Default for FocusFlag

fn default() -> FocusFlag

Returns the “default value” for a type.

impl Display for FocusFlag

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

Formats the value using the given formatter.

impl HasFocus for FocusFlag

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container.

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

fn area_z(&self) -> u16

Z value for the area.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn id(&self) -> usize

Provide a unique id for the widget.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl Hash for FocusFlag

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

where H: Hasher,

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 FocusFlag

Equality for FocusFlag means pointer equality of the underlying Rc using Rc::ptr_eq.

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