Struct rat_widget::splitter::SplitState

#[non_exhaustive]
pub struct SplitState {
    pub area: Rect,
    pub inner: Rect,
    pub widget_areas: Vec<Rect>,
    pub splitline_areas: Vec<Rect>,
    pub splitline_mark_areas: Vec<Position>,
    pub mark_offset: u16,
    pub direction: Direction,
    pub split_type: SplitType,
    pub lengths: Vec<u16>,
    pub focus: FocusFlag,
    pub focus_marker: Option<usize>,
    pub mouse: MouseFlagsN,
    /* private fields */
}

State & event handling.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

area: Rect

Total area. readonly. renewed for each render.

inner: Rect

Area inside the border. readonly. renewed for each render.

widget_areas: Vec<Rect>

The widget areas. Use this after calling layout() to render your widgets. readonly renewed for each render.

splitline_areas: Vec<Rect>

Area used by the splitter. This is area is used for moving the splitter. It might overlap with the widget area. readonly renewed for each render.

splitline_mark_areas: Vec<Position>

Start position for drawing the mark. readonly renewed for each render.

mark_offset: u16

Offset of the mark from top/left. readonly renewed for each render.

direction: Direction

Direction of the split. readonly renewed for each render.

split_type: SplitType

readonly renewed for each render.

lengths: Vec<u16>

Layout-widths for the split-areas.

This information is used after the initial render to lay out the splitter. read+write

focus: FocusFlag

Focus. read+write

focus_marker: Option<usize>

If the splitter has the focus you can navigate between the split-markers. This is the currently active split-marker. read+write

mouse: MouseFlagsN

Mouseflags. read+write

Implementations

impl SplitState

pub fn new() -> Self

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

New state with a focus-name.

pub fn set_screen_split_pos(&mut self, n: usize, pos: (u16, u16)) -> bool

Set the position for the nth splitter.

The position is limited the combined area of the two adjacent areas.

pub fn move_split_left(&mut self, n: usize, delta: u16) -> bool

Move the nth split position. Does nothing if the change is bigger than the length of the split.

pub fn move_split_right(&mut self, n: usize, delta: u16) -> bool

Move the nth split position. Does nothing if the change is bigger than the length of the split.

pub fn move_split_up(&mut self, n: usize, delta: u16) -> bool

Move the nth split position. Does nothing if the change is bigger than the length of the split.

pub fn move_split_down(&mut self, n: usize, delta: u16) -> bool

Move the nth split position. Does nothing if the change is bigger than the length of the split.

pub fn select_next_split(&mut self) -> bool

Select the next splitter for manual adjustment.

pub fn select_prev_split(&mut self) -> bool

Select the previous splitter for manual adjustment.

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

Is the split hidden?

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

Hide the split and adds its area to the following split.

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

Trait Implementations

impl Debug for SplitState

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

Formats the value using the given formatter.

impl Default for SplitState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, Outcome> for SplitState

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

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for SplitState

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

Handle an event.

impl HasFocusFlag for SplitState

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Access the area for mouse focus.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn z_areas(&self) -> &[ZRect]

The widget might have several disjointed areas. This is the case if it is showing a popup, but there might be other causes.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.