Struct cursive::CursiveRunnable [−][src]
pub struct CursiveRunnable { /* fields omitted */ }
Expand description
A runnable wrapper around Cursive
, bundling the backend initializer.
This struct embeds both Cursive
and a backend-initializer
(FnMut() -> Result<dyn Backend>
), to provide a simple .run()
method.
This lets you pick the backend when creating the Cursive root, rather than when running it.
It implements DerefMut<Target=Cursive>
, so you can use it just like a
regular Cursive
object.
Implementations
Creates a new Cursive wrapper, using the given backend.
Runs the event loop with the registered backend initializer.
Panics
If the backend initialization fails.
Runs the event loop with the registered backend initializer.
Gets a runner with the registered backend.
Used to manually control the event loop. In most cases, running
run()
will be easier.
The runner will borrow self
; when dropped, it will clear out the
terminal, and the cursive instance will be ready for another run if
needed.
Returns a new runner on the registered backend.
Used to manually control the event loop. In most cases, running
run()
will be easier.
The runner will embed self
; when dropped, it will clear out the
terminal, and the cursive instance will be dropped as well.
Returns a new runner on the registered backend.
Used to manually control the event loop. In most cases, running
run()
will be easier.
The runner will embed self
; when dropped, it will clear out the
terminal, and the cursive instance will be dropped as well.
Panics
If the backend initialization fails.
Creates a new Cursive wrapper using the dummy backend.
Nothing will actually be output when calling .run()
.
This is supported on crate feature ncurses-backend
only.
ncurses-backend
only.Creates a new Cursive wrapper using the ncurses backend.
Requires the ncurses-backend
feature.
This is supported on crate feature pancurses-backend
only.
pancurses-backend
only.Creates a new Cursive wrapper using the panncurses backend.
Requires the panncurses-backend
feature.
This is supported on crate feature termion-backend
only.
termion-backend
only.Creates a new Cursive wrapper using the termion backend.
Requires the termion-backend
feature.
This is supported on crate feature crossterm-backend
only.
crossterm-backend
only.Creates a new Cursive wrapper using the crossterm backend.
Requires the crossterm-backend
feature.
This is supported on crate feature blt-backend
only.
blt-backend
only.Creates a new Cursive wrapper using the bear-lib-terminal backend.
Requires the blt-backend
feature.
Methods from Deref<Target = Cursive>
Returns the screen size given in the last layout phase.
Note: this will return (0, 0)
before the first layout phase.
Sets some data to be stored in Cursive.
It can later on be accessed with Cursive::user_data()
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
.
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::new();
// 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);
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.
Sets the title for the terminal window.
Note that not all backends support this.
Show the debug console.
Currently, this will show logs if logger::init()
was called.
Show the debug console, or hide it if it’s already visible.
Examples
siv.add_global_callback('~', Cursive::toggle_debug_console);
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::new();
// quit() will be called during the next event cycle
siv.cb_sink().send(Box::new(|s| s.quit())).unwrap();
Selects the menubar.
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.
Access the menu tree used by the menubar.
This allows to add menu items to the menubar.
Examples
let mut siv = Cursive::new();
siv.menubar()
.add_subtree(
"File",
menu::Tree::new()
.leaf("New", |s| s.add_layer(Dialog::info("New file!")))
.subtree(
"Recent",
menu::Tree::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",
menu::Tree::new()
.subtree(
"Help",
menu::Tree::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());
Returns the currently used theme.
Updates the current theme.
Loads a theme from the given file.
filename
must point to a valid toml file.
Must have the toml
feature enabled.
Loads a theme from the given string content.
Content must be valid toml.
Must have the toml
feature enabled.
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).
Enables or disables automatic refresh of the screen.
This is a shortcut to call set_fps
with 30
or 0
depending on
autorefresh
.
Returns the current refresh rate, if any.
Returns None
if no auto-refresh is set. Otherwise, returns the rate
in frames per second.
Returns a mutable reference to the currently active screen.
Returns the id of the currently active screen.
Adds a new screen, and returns its ID.
Convenient method to create a new screen, and set it as active.
Sets the active screen. Panics if no such screen exist.
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::new();
siv.add_layer(views::TextView::new("Text #1").with_name("text"));
siv.add_global_callback('p', |s| {
s.call_on(
&view::Selector::Name("text"),
|view: &mut views::TextView| {
view.set_content("Text #2");
},
);
});
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::new();
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");
});
});
Call the given closure on all views with the given name and the correct type.
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::Nameable;
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::Nameable;
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());
Moves the focus to the view identified by name
.
Convenient method to call focus
with a view::Selector::Name
.
Moves the focus to the view identified by sel
.
Adds a global callback.
Will be triggered on the given key press when no view catches it.
Examples
let mut siv = Cursive::new();
siv.add_global_callback('q', |s| s.quit());
pub fn set_on_post_event<F, E>(&mut self, trigger: E, cb: F) where
F: 'static + FnMut(&mut Cursive),
E: Into<EventTrigger>,
pub fn set_on_post_event<F, E>(&mut self, trigger: E, cb: F) where
F: 'static + FnMut(&mut Cursive),
E: Into<EventTrigger>,
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
F: 'static + FnMut(&mut Cursive),
E: Into<EventTrigger>,
pub fn set_on_pre_event<F, E>(&mut self, trigger: E, cb: F) where
F: 'static + FnMut(&mut Cursive),
E: Into<EventTrigger>,
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: 'static + Fn(&Event) -> Option<EventResult>,
pub fn set_on_pre_event_inner<E, F>(&mut self, trigger: E, cb: F) where
E: Into<EventTrigger>,
F: 'static + Fn(&Event) -> Option<EventResult>,
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: 'static + Fn(&Event) -> Option<EventResult>,
pub fn set_on_event_inner<E, F>(&mut self, trigger: E, cb: F) where
E: Into<EventTrigger>,
F: 'static + Fn(&Event) -> Option<EventResult>,
Registers an inner callback.
See OnEventView
for more information.
Sets the only global callback for the given event.
Any other callback for this event will be removed.
See also Cursive::add_global_callback
.
Fetches the type name of a view in the tree.
Removes any callback tied to the given event.
Examples
use cursive_core::Cursive;
let mut siv = Cursive::new();
siv.add_global_callback('q', |s| s.quit());
siv.clear_global_callbacks('q');
This resets the default callbacks.
Currently this mostly includes exiting on Ctrl-C.
Add a layer to the current screen.
Examples
use cursive_core::{views, Cursive};
let mut siv = Cursive::new();
siv.add_layer(views::TextView::new("Hello world!"));
Adds a new full-screen layer to the current screen.
Fullscreen layers have no shadow.
Convenient method to remove a layer from the current screen.
Convenient stub forwarding layer repositioning.
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.
Returns true
until quit(&mut self)
is called.
Runs a dummy event loop.
Initializes a dummy backend for the event loop.
Returns a new runner on the given backend.
Used to manually control the event loop. In most cases, running
Cursive::run_with
will be easier.
The runner will borrow self
; when dropped, it will clear out the
terminal, and the cursive instance will be ready for another run if
needed.
Initialize the backend and runs the event loop.
Used for infallible backend initializers.
Initialize the backend and runs the event loop.
Returns an error if initializing the backend fails.
Dump the current state of the Cursive root.
It will clear out this Cursive
instance and save everything, including:
- The view tree
- Callbacks
- Menubar
- User data
- Callback sink
After calling this, the cursive object will be as if newly created.
Restores the state from a previous dump.
This will discard everything from this Cursive
instance.
In particular:
- All current views will be dropped, replaced by the dump.
- All callbacks will be replaced.
- Menubar will be replaced.
- User Data will be replaced.
- The callback channel will be replaced - any previous call to
cb_sink
on this instance will be disconnected.