Struct cursive::views::Canvas

pub struct Canvas<T> { /* fields omitted */ }

A blank view that forwards calls to closures.

You can use this view to easily draw your own interface.

Examples

use cursive_core::event::{Event, EventResult, Key};
use cursive_core::views::{Canvas, Dialog};
use unicode_width::UnicodeWidthStr; // To get the width of some text.

// Build a canvas around a string.
let state = String::new();
let canvas = Canvas::new(state)
    .with_draw(|text: &String, printer| {
        // Simply print our string
        printer.print((0, 0), text);
    })
    .with_on_event(|text: &mut String, event| match event {
        Event::Char(c) => {
            text.push(c);
            EventResult::Consumed(None)
        }
        Event::Key(Key::Enter) => {
            let text = text.clone();
            EventResult::with_cb(move |s| {
                s.add_layer(Dialog::info(&text));
            })
        }
        _ => EventResult::Ignored,
    })
    .with_required_size(|text, _constraints| (text.width(), 1).into());

Implementations

impl<T> Canvas<T> where
    T: 'static + View, 

pub fn wrap(view: T) -> Canvas<T>

Creates a new Canvas around the given view.

By default, forwards all calls to the inner view.

impl<T> Canvas<T>

pub fn new(state: T) -> Canvas<T>

Creates a new, empty Canvas.

pub fn state_mut(&mut self) -> &mut T

Gets a mutable reference to the inner state.

pub fn set_draw<F>(&mut self, f: F) where
    F: 'static + Fn(&T, &Printer<'_, '_>), 

Sets the closure for draw(&Printer).

pub fn with_draw<F>(self, f: F) -> Canvas<T> where
    F: 'static + Fn(&T, &Printer<'_, '_>), 

Sets the closure for draw(&Printer).

Chainable variant.

pub fn set_on_event<F>(&mut self, f: F) where
    F: 'static + FnMut(&mut T, Event) -> EventResult, 

Sets the closure for on_event(Event).

pub fn with_on_event<F>(self, f: F) -> Canvas<T> where
    F: 'static + FnMut(&mut T, Event) -> EventResult, 

Sets the closure for on_event(Event).

Chainable variant.

pub fn set_required_size<F>(&mut self, f: F) where
    F: 'static + FnMut(&mut T, XY<usize>) -> XY<usize>, 

Sets the closure for required_size(Vec2).

pub fn with_required_size<F>(self, f: F) -> Canvas<T> where
    F: 'static + FnMut(&mut T, XY<usize>) -> XY<usize>, 

Sets the closure for required_size(Vec2).

Chainable variant.

pub fn set_layout<F>(&mut self, f: F) where
    F: 'static + FnMut(&mut T, XY<usize>), 

Sets the closure for layout(Vec2).

pub fn with_layout<F>(self, f: F) -> Canvas<T> where
    F: 'static + FnMut(&mut T, XY<usize>), 

Sets the closure for layout(Vec2).

Chainable variant.

pub fn set_take_focus<F>(&mut self, f: F) where
    F: 'static + FnMut(&mut T, Direction) -> bool, 

Sets the closure for take_focus(Direction).

pub fn with_take_focus<F>(self, f: F) -> Canvas<T> where
    F: 'static + FnMut(&mut T, Direction) -> bool, 

Sets the closure for take_focus(Direction).

Chainable variant.

pub fn set_needs_relayout<F>(&mut self, f: F) where
    F: 'static + Fn(&T) -> bool, 

Sets the closure for needs_relayout().

pub fn with_needs_relayout<F>(self, f: F) -> Canvas<T> where
    F: 'static + Fn(&T) -> bool, 

Sets the closure for needs_relayout().

Chainable variant.

pub fn set_call_on_any<F>(&mut self, f: F) where
    F: 'static + for<'a> FnMut(&mut T, &Selector<'_>, &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)), 

Sets the closure for call_on_any().

pub fn with_call_on_any<F>(self, f: F) -> Canvas<T> where
    F: 'static + for<'a> FnMut(&mut T, &Selector<'_>, &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)), 

Sets the closure for call_on_any().

Chainable variant.

pub fn set_important_area<F>(&mut self, f: F) where
    F: 'static + Fn(&T, XY<usize>) -> Rect, 

Sets the closure for important_area().

pub fn with_important_area<F>(self, f: F) -> Canvas<T> where
    F: 'static + Fn(&T, XY<usize>) -> Rect, 

Sets the closure for important_area().

Chainable variant.

pub fn set_focus_view<F>(&mut self, f: F) where
    F: 'static + FnMut(&mut T, &Selector<'_>) -> Result<(), ViewNotFound>, 

Sets the closure for focus_view().

pub fn with_focus_view<F>(self, f: F) -> Canvas<T> where
    F: 'static + FnMut(&mut T, &Selector<'_>) -> Result<(), ViewNotFound>, 

Sets the closure for focus_view().

Chainable variant.

Trait Implementations

impl<T> View for Canvas<T> where
    T: 'static, 

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

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

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

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

pub fn required_size(&mut self, constraint: XY<usize>) -> XY<usize>

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

pub fn layout(&mut self, size: XY<usize>)

Called once the size for this view has been decided.

pub fn take_focus(&mut self, source: Direction) -> bool

This view is offered focus. Will it take it?

pub fn needs_relayout(&self) -> bool

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

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

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

pub fn important_area(&self, view_size: XY<usize>) -> Rect

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

pub fn call_on_any(
    &mut self,
    selector: &Selector<'_>,
    cb: &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

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

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

Returns the type of this view.