Struct ParagraphState 

pub struct ParagraphState {
    pub area: Rect,
    pub inner: Rect,
    pub lines: usize,
    pub vscroll: ScrollState,
    pub hscroll: ScrollState,
    pub focus: FocusFlag,
    pub non_exhaustive: NonExhaustive,
}

State & event handling.

Fields

area: Rect

Full area of the widget. readonly. renewed for each render.

inner: Rect

Inner area of the widget. readonly. renewed for each render.

lines: usize

Text lines

vscroll: ScrollState

Vertical scroll. read+write

hscroll: ScrollState

Horizontal scroll. read+write

focus: FocusFlag

Focus. read+write

non_exhaustive: NonExhaustive

Implementations

impl ParagraphState

pub fn new() -> Self

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

pub fn line_offset(&self) -> usize

Current offset.

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

Set limited offset.

pub fn col_offset(&self) -> usize

Current offset.

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

Set limited offset.

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

Scroll left by n.

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

Scroll right by n.

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

Scroll up by n.

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

Scroll down by n.

Trait Implementations

impl Clone for ParagraphState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParagraphState

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

Formats the value using the given formatter.

impl Default for ParagraphState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, Outcome> for ParagraphState

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

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ParagraphState

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

Handle an event.

impl HasFocus for ParagraphState

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.

impl RelocatableState for ParagraphState

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

Relocate the areas in this widgets state.

fn relocate_hidden(&mut self)

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