Struct rat_widget::splitter::SplitState

pub struct SplitState {

    pub area: Rect,
    pub inner: Rect,
    pub widget_areas: Vec<Rect>,
    pub focus: FocusFlag,
    pub focus_marker: Option<usize>,
    pub splitline_areas: Vec<Rect>,
    pub splitline_blind_areas: Vec<Rect>,
    pub splitline_mark_areas: Vec<Position>,
    pub direction: Direction,
    pub split_type: SplitType,
    pub mark_offset: u16,
    pub mouse: MouseFlagsN,
    pub non_exhaustive: NonExhaustive,
}

State & event handling.

Fields

area: Rect

Total area.

inner: Rect

Area inside the border.

widget_areas: Vec<Rect>

The widget areas.

Use this after calling layout() to render your widgets.

If the widget is resized, widget_areas and splitline_areas are used to build the constraints for the new layout.

focus: FocusFlag

Focus

focus_marker: Option<usize>

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

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.

splitline_blind_areas: Vec<Rect>

If there is a mark_offset, that leaves a blind spot above. This is noticeable, when the split_type is Scroll.

splitline_mark_areas: Vec<Position>

Start position for drawing the mark.

direction: Direction

Direction of the split.

split_type: SplitType

Split type.

mark_offset: u16

Offset of the mark from top/left.

mouse: MouseFlagsN

Mouseflags.

non_exhaustive: NonExhaustive

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 direction is not matching.

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

Move the nth split position. Does nothing if the direction is not matching.

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

Move the nth split position. Does nothing if the direction is not matching.

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

Move the nth split position. Does nothing if the direction is not matching.

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.

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.