Struct ViewState 

pub struct ViewState {
    pub area: Rect,
    pub widget_area: Rect,
    pub layout: Rect,
    pub hscroll: ScrollState,
    pub vscroll: ScrollState,
    pub focus: FocusFlag,
    /* private fields */
}

View state.

Fields

area: Rect

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

widget_area: Rect

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

layout: Rect

The layout of the temp buffer uses. read only renewed for each render.

hscroll: ScrollState

Horizontal scroll read+write

vscroll: ScrollState

Vertical scroll read+write

focus: FocusFlag

Current focus state. read+write

Implementations

impl ViewState

pub fn new() -> Self

pub fn show_area(&mut self, area: Rect)

Show this rect.

impl ViewState

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_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

Trait Implementations

impl Clone for ViewState

fn clone(&self) -> ViewState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewState

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

Formats the value using the given formatter.

impl Default for ViewState

fn default() -> ViewState

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, Outcome> for ViewState

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

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ViewState

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

Handle an event.

impl HasFocus for ViewState

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

Build the focus-structure for the container/widget.

fn focus(&self) -> FocusFlag

Access to the focus flag.

fn area(&self) -> Rect

Area for mouse focus.

fn build_nav(&self, navigable: Navigation, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget.

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

Does this widget have the focus. Or, if the flag is used for a container, does any of widget inside the container have the focus.

fn lost_focus(&self) -> bool

This widget just lost the focus. This flag is set by [Focus::handle] if there is a focus transfer, and will be reset by the next call to [Focus::handle].

fn gained_focus(&self) -> bool

This widget just gained the focus. This flag is set by [Focus::handle] if there is a focus transfer, and will be reset by the next call to [Focus::handle].

fn has_mouse_focus(&self) -> bool

This flag is set by [Focus::handle], if a mouse-event matches one of the areas associated with a widget.

impl RelocatableState for ViewState

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.

fn relocate_popup(&mut self, shift: (i16, i16), clip: Rect)

Relocate only popup areas. As rendering the popups is a separate render, this has to be separate too.

fn relocate_popup_hidden(&mut self)

Relocate all popup areas to a clip-rect (0,0+0x0).

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).