Struct cursive::Cursive

pub struct Cursive { /* fields omitted */ }

Central part of the cursive library.

It initializes ncurses on creation and cleans up on drop. To use it, you should populate it with views, layouts, and callbacks, then start the event loop with run().

It uses a list of screen, with one screen active at a time.

Implementations

impl Cursive

pub fn new<F>(backend_init: F) -> Cursive where
    F: FnOnce() -> Box<dyn Backend + 'static>, 

Shortcut for Cursive::try_new with non-failible init function.

You probably don't want to use this function directly, unless you're using a non-standard backend. Built-in backends have dedicated functions.

Examples

let siv = Cursive::new(backend::Dummy::init);

pub fn try_new<F, E>(backend_init: F) -> Result<Cursive, E> where
    F: FnOnce() -> Result<Box<dyn Backend + 'static>, E>, 

Creates a new Cursive root, and initialize the back-end.

You probably don't want to use this function directly, unless you're using a non-standard backend. Built-in backends have dedicated functions in the CursiveExt trait.

pub fn dummy() -> Cursive

Creates a new Cursive root using a dummy backend.

Nothing will be output. This is mostly here for tests.

pub fn set_user_data<T>(&mut self, user_data: T) where
    T: Any, 

Sets some data to be stored in Cursive.

It can later on be accessed with Cursive::user_data()

pub fn user_data<T>(&mut self) -> Option<&mut T> where
    T: Any, 

Attempts to access the user-provided data.

If some data was set previously with the same type, returns a reference to it.

If nothing was set or if the type is different, returns None.

pub fn take_user_data<T>(&mut self) -> Option<T> where
    T: Any, 

Attemps to take by value the current user-data.

If successful, this will replace the current user-data with the unit type ().

If the current user data is not of the requested type, None will be returned.

Examples

let mut siv = cursive_core::Cursive::dummy();

// Start with a simple `Vec<i32>` as user data.
siv.set_user_data(vec![1i32, 2, 3]);
assert_eq!(siv.user_data::<Vec<i32>>(), Some(&mut vec![1i32, 2, 3]));

// Let's mutate the data a bit.
siv.with_user_data(|numbers: &mut Vec<i32>| numbers.push(4));

// If mutable reference is not enough, we can take the data by value.
let data: Vec<i32> = siv.take_user_data().unwrap();
assert_eq!(data, vec![1i32, 2, 3, 4]);

// At this point the user data was removed and is no longer available.
assert_eq!(siv.user_data::<Vec<i32>>(), None);

pub fn with_user_data<F, T, R>(&mut self, f: F) -> Option<R> where
    F: FnOnce(&mut T) -> R,
    T: Any, 

Runs the given closure on the stored user data, if any.

If no user data was supplied, or if the type is different, nothing will be run.

Otherwise, the result will be returned.

pub fn show_debug_console(&mut self)

Show the debug console.

Currently, this will show logs if logger::init() was called.

pub fn toggle_debug_console(&mut self)

Show the debug console, or hide it if it's already visible.

Examples

siv.add_global_callback('~', Cursive::toggle_debug_console);

pub fn cb_sink(&self) -> &Sender<Box<dyn FnOnce(&mut Cursive) + 'static + Send>>

Returns a sink for asynchronous callbacks.

Returns the sender part of a channel, that allows to send callbacks to self from other threads.

Callbacks will be executed in the order of arrival on the next event cycle.

Notes

Callbacks need to be Send, which can be limiting in some cases.

In some case send_wrapper may help you work around that.

Examples

let mut siv = Cursive::dummy();

// quit() will be called during the next event cycle
siv.cb_sink().send(Box::new(|s| s.quit())).unwrap();

pub fn select_menubar(&mut self)

Selects the menubar.

pub fn set_autohide_menu(&mut self, autohide: bool)

Sets the menubar autohide feature.

• When enabled (default), the menu is only visible when selected.
• When disabled, the menu is always visible and reserves the top row.

pub fn menubar(&mut self) -> &mut Menubar

Access the menu tree used by the menubar.

This allows to add menu items to the menubar.

Examples

let mut siv = Cursive::dummy();

siv.menubar()
   .add_subtree("File",
        MenuTree::new()
            .leaf("New", |s| s.add_layer(Dialog::info("New file!")))
            .subtree("Recent", MenuTree::new().with(|tree| {
                for i in 1..100 {
                    tree.add_leaf(format!("Item {}", i), |_| ())
                }
            }))
            .delimiter()
            .with(|tree| {
                for i in 1..10 {
                    tree.add_leaf(format!("Option {}", i), |_| ());
                }
            })
            .delimiter()
            .leaf("Quit", |s| s.quit()))
   .add_subtree("Help",
        MenuTree::new()
            .subtree("Help",
                     MenuTree::new()
                         .leaf("General", |s| {
                             s.add_layer(Dialog::info("Help message!"))
                         })
                         .leaf("Online", |s| {
                             s.add_layer(Dialog::info("Online help?"))
                         }))
            .leaf("About",
                  |s| s.add_layer(Dialog::info("Cursive v0.0.0"))));

siv.add_global_callback(event::Key::Esc, |s| s.select_menubar());

pub fn current_theme(&self) -> &Theme

Returns the currently used theme.

pub fn set_theme(&mut self, theme: Theme)

Sets the current theme.

pub fn update_theme(&mut self, f: impl FnOnce(&mut Theme))

Updates the current theme.

pub fn clear(&mut self)

Clears the screen.

Users rarely have to call this directly.

pub fn set_fps(&mut self, fps: u32)

Sets the refresh rate, in frames per second.

Note that the actual frequency is not guaranteed.

Between 0 and 30. Call with fps = 0 to disable (default value).

pub fn set_autorefresh(&mut self, autorefresh: bool)

Enables or disables automatic refresh of the screen.

This is a shortcut to call set_fps with 30 or 0 depending on autorefresh.

pub fn screen(&self) -> &StackView

Returns a reference to the currently active screen.

pub fn screen_mut(&mut self) -> &mut StackView

Returns a mutable reference to the currently active screen.

pub fn active_screen(&self) -> usize

Returns the id of the currently active screen.

pub fn add_screen(&mut self) -> usize

Adds a new screen, and returns its ID.

pub fn add_active_screen(&mut self) -> usize

Convenient method to create a new screen, and set it as active.

pub fn set_screen(&mut self, screen_id: usize)

Sets the active screen. Panics if no such screen exist.

pub fn call_on<V, F, R>(&mut self, sel: &Selector, callback: F) -> Option<R> where
    F: FnOnce(&mut V) -> R,
    V: View, 

Tries to find the view pointed to by the given selector.

Runs a closure on the view once it's found, and return the result.

If the view is not found, or if it is not of the asked type, returns None.

Examples

let mut siv = Cursive::dummy();

siv.add_layer(views::TextView::new("Text #1").with_name("text"));

siv.add_global_callback('p', |s| {
    s.call_on(
        &view::Selector::Id("text"),
        |view: &mut views::TextView| {
            view.set_content("Text #2");
        },
    );
});

pub fn call_on_name<V, F, R>(&mut self, name: &str, callback: F) -> Option<R> where
    F: FnOnce(&mut V) -> R,
    V: View, 

Tries to find the view identified by the given id.

Convenient method to use call_on with a view::Selector::Id.

Examples

let mut siv = Cursive::dummy();

siv.add_layer(views::TextView::new("Text #1")
                              .with_name("text"));

siv.add_global_callback('p', |s| {
    s.call_on_name("text", |view: &mut views::TextView| {
        view.set_content("Text #2");
    });
});

pub fn call_on_id<V, F, R>(&mut self, id: &str, callback: F) -> Option<R> where
    F: FnOnce(&mut V) -> R,
    V: View, 

👎 Deprecated:

call_on_id is being renamed to call_on_name

Same as call_on_name.

pub fn find_name<V>(
    &mut self,
    id: &str
) -> Option<OwningHandle<OwningRef<Rc<RefCell<V>>, RefCell<V>>, RefMut<'static, V>>> where
    V: View, 

Convenient method to find a view wrapped in NamedView.

This looks for a NamedView<V> with the given name, and return a ViewRef to the wrapped view. The ViewRef implements DerefMut<Target=T>, so you can treat it just like a &mut T.

Examples

use cursive_core::traits::Identifiable;

siv.add_layer(TextView::new("foo").with_name("id"));

// Could be called in a callback
let mut view: ViewRef<TextView> = siv.find_name("id").unwrap();
view.set_content("bar");

Note that you must specify the exact type for the view you're after; for example, using the wrong item type in a SelectView will not find anything:

use cursive_core::traits::Identifiable;

let select = SelectView::new().item("zero", 0u32).item("one", 1u32);
siv.add_layer(select.with_name("select"));

// Specifying a wrong type will not return anything.
assert!(siv.find_name::<SelectView<String>>("select").is_none());

// Omitting the type will use the default type, in this case `String`.
assert!(siv.find_name::<SelectView>("select").is_none());

// But with the correct type, it works fine.
assert!(siv.find_name::<SelectView<u32>>("select").is_some());

pub fn find_id<V>(
    &mut self,
    id: &str
) -> Option<OwningHandle<OwningRef<Rc<RefCell<V>>, RefCell<V>>, RefMut<'static, V>>> where
    V: View, 

👎 Deprecated:

find_id is being renamed to find_name

Same as find_name.

pub fn focus_name(&mut self, name: &str) -> Result<(), ()>

Moves the focus to the view identified by name.

Convenient method to call focus with a view::Selector::Name.

pub fn focus_id(&mut self, id: &str) -> Result<(), ()>

👎 Deprecated:

focus_id is being renamed to focus_name

Same as focus_name.

pub fn focus(&mut self, sel: &Selector) -> Result<(), ()>

Moves the focus to the view identified by sel.

pub fn add_global_callback<F, E>(&mut self, event: E, cb: F) where
    E: Into<Event>,
    F: FnMut(&mut Cursive) + 'static, 

Adds a global callback.

Will be triggered on the given key press when no view catches it.

Examples

let mut siv = Cursive::dummy();

siv.add_global_callback('q', |s| s.quit());

pub fn set_on_post_event<F, E>(&mut self, trigger: E, cb: F) where
    E: Into<EventTrigger>,
    F: FnMut(&mut Cursive) + 'static, 

Registers a callback for ignored events.

This is the same as add_global_callback, but can register any EventTrigger.

pub fn set_on_pre_event<F, E>(&mut self, trigger: E, cb: F) where
    E: Into<EventTrigger>,
    F: FnMut(&mut Cursive) + 'static, 

Registers a priotity callback.

If an event matches the given trigger, it will not be sent to the view tree and will go to the given callback instead.

Note that regular "post-event" callbacks will also be skipped for these events.

pub fn set_on_pre_event_inner<E, F>(&mut self, trigger: E, cb: F) where
    E: Into<EventTrigger>,
    F: Fn(&Event) -> Option<EventResult> + 'static, 

Registers an inner priority callback.

See OnEventView for more information.

pub fn set_on_event_inner<E, F>(&mut self, trigger: E, cb: F) where
    E: Into<EventTrigger>,
    F: Fn(&Event) -> Option<EventResult> + 'static, 

Registers an inner callback.

See OnEventView for more information.

pub fn set_global_callback<F, E>(&mut self, event: E, cb: F) where
    E: Into<Event>,
    F: FnMut(&mut Cursive) + 'static, 

Sets the only global callback for the given event.

Any other callback for this event will be removed.

See also Cursive::add_global_callback.

pub fn debug_name(&mut self, name: &str) -> Option<&'static str>

Fetches the type name of a view in the tree.

pub fn clear_global_callbacks<E>(&mut self, event: E) where
    E: Into<Event>, 

Removes any callback tied to the given event.

Examples

use cursive_core::Cursive;
let mut siv = Cursive::dummy();

siv.add_global_callback('q', |s| s.quit());
siv.clear_global_callbacks('q');

pub fn reset_default_callbacks(&mut self)

This resets the default callbacks.

Currently this mostly includes exiting on Ctrl-C.

pub fn add_layer<T>(&mut self, view: T) where
    T: IntoBoxedView, 

Add a layer to the current screen.

Examples

use cursive_core::{Cursive, views};
let mut siv = Cursive::dummy();

siv.add_layer(views::TextView::new("Hello world!"));

pub fn add_fullscreen_layer<T>(&mut self, view: T) where
    T: IntoBoxedView, 

Adds a new full-screen layer to the current screen.

Fullscreen layers have no shadow.

pub fn pop_layer(&mut self) -> Option<Box<dyn View + 'static>>

Convenient method to remove a layer from the current screen.

pub fn reposition_layer(&mut self, layer: LayerPosition, position: XY<Offset>)

Convenient stub forwarding layer repositioning.

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

Processes an event.

• If the menubar is active, it will be handled the event.
• The view tree will be handled the event.
• If ignored, global_callbacks will be checked for this event.

pub fn screen_size(&self) -> XY<usize>

Returns the size of the screen, in characters.

pub fn is_running(&self) -> bool

Returns true until quit(&mut self) is called.

pub fn run(&mut self)

Runs the event loop.

It will wait for user input (key presses) and trigger callbacks accordingly.

Internally, it calls step(&mut self) until quit(&mut self) is called.

After this function returns, you can call it again and it will start a new loop.

pub fn step(&mut self) -> bool

Performs a single step from the event loop.

Useful if you need tighter control on the event loop. Otherwise, run(&mut self) might be more convenient.

Returns true if an input event or callback was received during this step, and false otherwise.

pub fn process_events(&mut self) -> bool

Performs the first half of Self::step().

This is an advanced method for fine-tuned manual stepping; you probably want run or step.

This processes any pending event or callback. After calling this, you will want to call post_events with the result from this function.

Returns true if an event or callback was received, and false otherwise.

pub fn post_events(&mut self, received_something: bool)

Performs the second half of Self::step().

This is an advanced method for fine-tuned manual stepping; you probably want run or step.

You should call this after process_events.

pub fn refresh(&mut self)

Refresh the screen with the current view tree state.

pub fn quit(&mut self)

Stops the event loop.

pub fn noop(&mut self)

Does not do anything.

pub fn backend_name(&self) -> &str

Return the name of the backend used.

Mostly used for debugging.

Trait Implementations

impl CursiveExt for Cursive

type Cursive = Self

Type of the returned cursive root.

fn default() -> Self::Cursive

Tries to use one of the enabled backends.

fn ncurses() -> Result<Self>

Creates a new Cursive root using a ncurses backend.

impl Drop for Cursive

fn drop(&mut self)

Executes the destructor for this type.