Struct Divider 

pub struct Divider {
    pub min_before: usize,
    pub min_after: usize,
    pub thickness: usize,
    /* private fields */
}

A border between two panes along one axis, where the mouse can grab and drag it and the keyboard can nudge it.

Positions are cells along the axis: the first pane’s size, then thickness cells of border, then the second pane. Both panes keep at least their minimum while the total has room for that.

Fields

min_before: usize

The fewest cells the first pane takes.

min_after: usize

The fewest cells the second pane takes.

thickness: usize

The cells the border takes.

Implementations

impl Divider

pub fn new(thickness: usize) -> Divider

A border thickness cells thick, with no minimum pane size.

pub fn min(self, cells: usize) -> Divider

Both panes at least cells.

pub fn at(self, position: usize) -> Divider

Put the border at position (the first pane’s size), until dragged.

pub fn position(&self) -> Option<usize>

Where the border was put or dragged to, before clamping.

pub fn set_position(&mut self, position: Option<usize>)

pub fn dragging(&self) -> bool

Whether a drag is under way.

pub fn clamp(&self, position: usize, total: usize) -> usize

The first pane’s size for a border at position in total cells: both panes at least their minimum when there is room for that.

pub fn resolve(&self, total: usize, default: usize) -> usize

The first pane’s size in total cells: where the border was put or dragged, clamped, or default when it has not been.

pub fn hit(&self, at: usize, first: usize) -> bool

Whether at (a cell along the axis) is on the border when the first pane is first cells.

pub fn press(&mut self, at: usize, first: usize) -> bool

A press at at: grab the border if it is there. Returns whether it was grabbed.

pub fn drag(&mut self, at: usize, total: usize) -> bool

A drag to at in total cells: move the border there if grabbed. Returns whether it moved.

pub fn release(&mut self)

Let go of the border.

pub fn handle_mouse( &mut self, mouse: &Mouse, at: usize, first: usize, total: usize, ) -> bool

Press, drag and release from one mouse event along the axis, at being the event’s cell along it. Returns whether the divider used the event.

pub fn nudge(&mut self, delta: isize, first: usize, total: usize)

Move the border by delta cells from first, within total.

Trait Implementations

impl Clone for Divider

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Divider

impl Debug for Divider

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

Formats the value using the given formatter.

impl Default for Divider

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Divider

impl PartialEq for Divider

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Divider