Struct SplitPanel 

pub struct SplitPanel { /* private fields */ }

Split panel.

Contains two panes with an optionally movable divider between them and an optional border. (Both features are enabled by default.)

Can be oriented horizontally (the default) or vertically.

When movable_divider is true will support the following events (configurable):

• Shift+Left/Shift+Up: move the divider towards the front
• Shift+Right/Shift+Down: move the divider towards the back
• Mouse dragging of the divider

Implementations

impl SplitPanel

pub fn new(orientation: Orientation) -> Self

Constructor.

pub fn horizontal() -> Self

Constructor.

pub fn vertical() -> Self

Constructor.

pub fn orientation(&self) -> Orientation

Orienation.

pub fn set_orientation(&mut self, orientation: Orientation)

Set orientation.

pub fn with_orientation(self, orientation: Orientation) -> Self

Set orientation.

Chainable.

pub fn border(&self) -> bool

Whether to draw a border.

pub fn set_border(&mut self, border: bool)

Set whether to draw a border.

pub fn with_border(self, border: bool) -> Self

Set whether to draw a border.

Chainable.

pub fn visible_divider(&self) -> bool

Whether the divider is visible.

pub fn set_visible_divider(&mut self, visible_divider: bool)

Set whether the divider is visible.

pub fn with_visible_divider(self, visible_divider: bool) -> Self

Set whether the divider is visible.

Chainable.

pub fn movable_divider(&self) -> bool

Whether to allow the divider to move.

pub fn set_movable_divider(&mut self, movable_divider: bool)

Set whether to allow the divider to move.

pub fn with_movable_divider(self, movable_divider: bool) -> Self

Set whether to allow the divider to move.

Chainable.

pub fn front(&self) -> &dyn View

View for front panel.

pub fn front_mut(&mut self) -> &mut dyn View

View for front panel.

pub fn set_front<ViewT>(&mut self, view: ViewT)

where ViewT: 'static + IntoBoxedView,

Set view for front panel.

pub fn with_front<ViewT>(self, view: ViewT) -> Self

where ViewT: 'static + IntoBoxedView,

Set view for front panel.

Chainable.

Examples found in repository

examples/simple.rs (line 11)

fn main() {
    let mut cursive = default();

    cursive.add_fullscreen_layer(
        SplitPanel::default()
            .with_front(text_view().scrollable().full_screen())
            .with_back(text_view().scrollable().full_screen()),
    );

    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

pub fn back(&self) -> &dyn View

View for back panel.

pub fn back_mut(&mut self) -> &mut dyn View

View for back panel.

pub fn set_back<ViewT>(&mut self, view: ViewT)

where ViewT: 'static + IntoBoxedView,

Set view for back panel.

pub fn with_back<ViewT>(self, view: ViewT) -> Self

where ViewT: 'static + IntoBoxedView,

Set view for back panel.

Chainable.

Examples found in repository

examples/simple.rs (line 12)

fn main() {
    let mut cursive = default();

    cursive.add_fullscreen_layer(
        SplitPanel::default()
            .with_front(text_view().scrollable().full_screen())
            .with_back(text_view().scrollable().full_screen()),
    );

    cursive.add_global_callback('q', |cursive| cursive.quit());

    cursive.run();
}

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

The divider position as the distance from the front border.

Returns None if not yet set.

pub fn set_divider(&mut self, divider: usize)

Set divider position as the distance from the front border.

Note that if it doesn’t fit it will move during layout.

pub fn with_divider(self, divider: usize) -> Self

Set divider position as the distance from the front border.

Note that if it doesn’t fit it will move during layout.

Chainable.

pub fn actions(&self) -> &Actions

Action map.

pub fn actions_mut(&mut self) -> &mut Actions

Action map.

pub fn set_actions(&mut self, actions: Actions)

Set action map.

pub fn with_actions(self, actions: Actions) -> Self

Set action map.

Chainable.

pub fn set_action<EventT>(&mut self, action: Action, event: EventT)

where EventT: Into<Event>,

Set action.

Note that actions can be associated with more than one event.

pub fn with_action<EventT>(self, action: Action, event: EventT) -> Self

where EventT: Into<Event>,

Set action.

Note that actions can be associated with more than one event.

Chainable.

pub fn remove_action(&mut self, action: Action) -> bool

Remove action.

Will remove all associated events.

Return true if removed.

pub fn without_action(self, action: Action) -> Self

Remove action.

Will remove all associated events.

Chainable.

Trait Implementations

impl Default for SplitPanel

fn default() -> Self

Returns the “default value” for a type.

impl View for SplitPanel

fn type_name(&self) -> &'static str

Returns the type of this view.

fn focus_view( &mut self, selector: &Selector<'_>, ) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

fn take_focus(&mut self, source: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided.

fn required_size(&mut self, constraint: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn important_area(&self, size: Vec2) -> Rect

What part of the view is important and should be visible?

fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn call_on_any(&mut self, selector: &Selector<'_>, callback: AnyCb<'_>)

Runs a closure on the view identified by the given selector.

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.