Struct ClipperState 

pub struct ClipperState<W = usize>
where
    W: Eq + Clone + Hash,
{
    pub area: Rect,
    pub widget_area: Rect,
    pub layout: Rc<RefCell<GenericLayout<W>>>,
    pub hscroll: ScrollState,
    pub vscroll: ScrollState,
    pub container: FocusFlag,
    pub non_exhaustive: NonExhaustive,
    /* private fields */
}

Widget state.

Fields

area: Rect

read only renewed for each render.

widget_area: Rect

Area inside the border. read only renewed for each render.

layout: Rc<RefCell<GenericLayout<W>>>

Page layout. read only renewed for each render.

hscroll: ScrollState

Horizontal scroll read+write

vscroll: ScrollState

Vertical scroll read+write

container: FocusFlag

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

non_exhaustive: NonExhaustive

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

Implementations

impl<W> ClipperState<W>

where W: Eq + Clone + Hash,

pub fn new() -> Self

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

pub fn clear(&mut self)

Clear the layout data and reset any scroll

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) -> Ref<'_, GenericLayout<W>>

Layout.

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

Scroll to the given widget.

pub fn first(&self) -> Option<W>

Returns the first visible widget. This uses insertion order of the widgets, not any graphical ordering.

impl<W> ClipperState<W>

where W: Eq + Clone + Hash,

pub fn vertical_offset(&self) -> usize

pub fn set_vertical_offset(&mut self, offset: usize) -> bool

pub fn vertical_page_len(&self) -> usize

pub fn horizontal_offset(&self) -> usize

pub fn set_horizontal_offset(&mut self, offset: usize) -> bool

pub fn horizontal_page_len(&self) -> usize

pub fn horizontal_scroll_to(&mut self, pos: usize) -> bool

pub fn vertical_scroll_to(&mut self, pos: usize) -> bool

pub fn scroll_to(&mut self, widget: W) -> bool

Scroll the widget to visible.

pub fn scroll_up(&mut self, delta: usize) -> bool

pub fn scroll_down(&mut self, delta: usize) -> bool

pub fn scroll_left(&mut self, delta: usize) -> bool

pub fn scroll_right(&mut self, delta: usize) -> bool

impl ClipperState<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.

You must use the boolean to trigger a repaint.

impl ClipperState<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 ClipperState<W>

where W: Eq + Hash + Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W> Debug for ClipperState<W>

where W: Eq + Clone + Hash + Debug,

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

Formats the value using the given formatter.

impl<W> Default for ClipperState<W>

where W: Eq + Hash + Clone,

fn default() -> Self

Returns the “default value” for a type.

impl<W> HandleEvent<Event, MouseOnly, Outcome> for ClipperState<W>

where W: Eq + Clone + Hash,

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl<W> HandleEvent<Event, Regular, Outcome> for ClipperState<W>

where W: Eq + Clone + Hash,

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.

impl<W> HasFocus for ClipperState<W>

where W: Eq + Clone + Hash,

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.