Struct rat_focus::FocusFlag

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

Holds the flags for the focus. This struct is embedded in the widget state.

This is a wrapper around Rc<some_impl>, so cloning this is cheap and what you want to do if you implement any high-level focus-handling.

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

See HasFocusFlag, on_gained! and on_lost!.

Implementations

impl FocusFlag

pub fn new() -> Self

Create a default flag.

pub fn named(name: &str) -> Self

Create a named flag.

pub fn get(&self) -> bool

Has the focus.

pub fn set(&self, focus: bool)

Set the focus.

pub fn name(&self) -> &str

Get the field-name.

pub fn lost(&self) -> bool

Just lost the focus.

pub fn set_lost(&self, lost: bool)

pub fn gained(&self) -> bool

Just gained the focus.

pub fn set_gained(&self, gained: bool)

pub fn clear(&self)

Reset all flags to false.

Trait Implementations

impl Clone for FocusFlag

fn clone(&self) -> FocusFlag

Returns a copy 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

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

Formats the value using the given formatter.

impl PartialEq for FocusFlag

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

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