Struct FormState 

pub struct FormState<W = usize>
where
    W: Eq + Hash + Clone,
{
    pub layout: Rc<GenericLayout<W>>,
    pub area: Rect,
    pub widget_area: Rect,
    pub prev_area: Rect,
    pub next_area: Rect,
    pub page: usize,
    pub container: FocusFlag,
    pub mouse: MouseFlagsN,
    pub non_exhaustive: NonExhaustive,
}

Widget state.

Fields

layout: Rc<GenericLayout<W>>

Page layout read+write might be overwritten from widget.

area: Rect

Full area for the widget. read only renewed for each render.

widget_area: Rect

Area for the content. read only renewed for each render.

prev_area: Rect

Area for prev-page indicator. read only renewed with each render.

next_area: Rect

Area for next-page indicator. read only renewed with each render.

page: usize

container: FocusFlag

This widget has no focus of its own, but this flag can be used to set a container state.

mouse: MouseFlagsN

Mouse

non_exhaustive: NonExhaustive

Only construct with ..Default::default().

Implementations

impl<W> FormState<W>

where W: Eq + Hash + Clone,

pub fn new() -> Self

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

pub fn clear(&mut self)

Clear the layout data and reset the page/page-count.

pub fn valid_layout(&self, size: Size) -> bool

Layout needs to change?

pub fn set_layout(&mut self, layout: GenericLayout<W>)

Set the layout.

pub fn layout(&self) -> Rc<GenericLayout<W>>

Layout.

pub fn show(&mut self, widget: W)

Show the page for this widget. If there is no widget for the given identifier, this will set the page to 0.

pub fn page_count(&self) -> usize

Number of form pages.

pub fn first(&self, page: usize) -> Option<W>

Returns the first widget for the given page.

pub fn page_of(&self, widget: W) -> Option<usize>

Calculates the page of the widget.

pub fn set_page(&mut self, page: usize) -> bool

Set the visible page.

pub fn page(&self) -> usize

Visible page

pub fn next_page(&mut self) -> bool

Select next page. Keeps the page in bounds.

pub fn prev_page(&mut self) -> bool

Select prev page.

impl FormState<usize>

pub fn focus_first(&self, focus: &Focus) -> bool

Focus the first widget on the active page. This assumes the usize-key is a widget id.

pub fn show_focused(&mut self, focus: &Focus) -> bool

Show the page with the focused widget. This assumes the usize-key is a widget id. Does nothing if none of the widgets has the focus.

impl FormState<FocusFlag>

pub fn focus_first(&self, focus: &Focus) -> bool

Focus the first widget on the active page.

pub fn show_focused(&mut self, focus: &Focus) -> bool

Show the page with the focused widget. Does nothing if none of the widgets has the focus.

Trait Implementations

impl<W> Clone for FormState<W>

where W: Eq + Hash + Clone + Clone,

fn clone(&self) -> FormState<W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W> Debug for FormState<W>

where W: Eq + Hash + Clone + Debug,

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

Formats the value using the given formatter.

impl<W> Default for FormState<W>

where W: Eq + Hash + Clone,

fn default() -> Self

Returns the “default value” for a type.

impl<W> HandleEvent<Event, MouseOnly, FormOutcome> for FormState<W>

where W: Eq + Hash + Clone,

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> FormOutcome

Handle an event.

impl<W> HandleEvent<Event, Regular, FormOutcome> for FormState<W>

where W: Eq + Hash + Clone,

fn handle(&mut self, event: &Event, _qualifier: Regular) -> FormOutcome

Handle an event.

impl<W> HasFocus for FormState<W>

where W: Eq + Hash + Clone,

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 id(&self) -> usize

Provide a unique id for the widget.

fn area_z(&self) -> u16

Z value for the area.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.