Struct cursive_core::views::EditView
source · pub struct EditView { /* private fields */ }
Expand description
Input box where the user can enter and edit text.
Examples
From the edit example.
let mut siv = Cursive::new();
// Create a dialog with an edit text and a button.
// The user can either hit the <Ok> button,
// or press Enter on the edit text.
siv.add_layer(
Dialog::new()
.title("Enter your name")
.padding_lrtb(1, 1, 1, 0)
.content(
EditView::new()
.on_submit(show_popup)
.with_name("name")
.fixed_width(20),
)
.button("Ok", |s| {
let name = s
.call_on_name("name", |view: &mut EditView| {
view.get_content()
})
.unwrap();
show_popup(s, &name);
}),
);
fn show_popup(s: &mut Cursive, name: &str) {
if name.is_empty() {
s.add_layer(Dialog::info("Please enter a name!"));
} else {
let content = format!("Hello {}!", name);
s.pop_layer();
s.add_layer(
Dialog::around(TextView::new(content))
.button("Quit", |s| s.quit()),
);
}
}
Implementations§
source§impl EditView
impl EditView
sourcepub fn set_enabled(&mut self, enabled: bool)
pub fn set_enabled(&mut self, enabled: bool)
Enable or disable this view.
sourcepub fn with_enabled(self, is_enabled: bool) -> Self
pub fn with_enabled(self, is_enabled: bool) -> Self
Enable or disable this view.
Chainable variant.
sourcepub fn is_enabled(&self) -> bool
pub fn is_enabled(&self) -> bool
Returns true
if this view is enabled.
sourcepub fn set_max_content_width(&mut self, width: Option<usize>)
pub fn set_max_content_width(&mut self, width: Option<usize>)
Sets a maximum width for the content.
Input will be rejected if it would make the content exceed this width.
Giving None
means no maximum width is applied.
sourcepub fn max_content_width(self, width: usize) -> Self
pub fn max_content_width(self, width: usize) -> Self
Sets a maximum width for the content.
Input will be rejected if it would make the content exceed this width.
Chainable variant.
sourcepub fn set_secret(&mut self, secret: bool)
pub fn set_secret(&mut self, secret: bool)
If secret
is true
, the content won’t be displayed in clear.
Only *
will be shown.
sourcepub fn set_filler<S: Into<String>>(&mut self, filler: S)
pub fn set_filler<S: Into<String>>(&mut self, filler: S)
Sets the character to fill in blank space.
Defaults to “_”.
sourcepub fn filler<S: Into<String>>(self, filler: S) -> Self
pub fn filler<S: Into<String>>(self, filler: S) -> Self
Sets the character to fill in blank space.
Chainable variant.
Examples
let edit = EditView::new().filler(" ");
sourcepub fn set_style(&mut self, style: ColorStyle)
pub fn set_style(&mut self, style: ColorStyle)
Sets the style used for this view.
When the view is enabled, the style will be reversed.
Defaults to ColorStyle::Secondary
.
sourcepub fn style(self, style: ColorStyle) -> Self
pub fn style(self, style: ColorStyle) -> Self
Sets the style used for this view.
When the view is enabled, the style will be reversed.
Chainable variant.
sourcepub fn set_on_edit_mut<F>(&mut self, callback: F)where
F: FnMut(&mut Cursive, &str, usize) + 'static,
pub fn set_on_edit_mut<F>(&mut self, callback: F)where
F: FnMut(&mut Cursive, &str, usize) + 'static,
Sets a mutable callback to be called whenever the content is modified.
callback
will be called with the view
content and the current cursor position.
Warning: this callback cannot be called recursively. If you somehow trigger this callback again in the given closure, it will be ignored.
If you don’t need a mutable closure but want the possibility of
recursive calls, see set_on_edit
.
sourcepub fn set_on_edit<F>(&mut self, callback: F)where
F: Fn(&mut Cursive, &str, usize) + 'static,
pub fn set_on_edit<F>(&mut self, callback: F)where
F: Fn(&mut Cursive, &str, usize) + 'static,
Sets a callback to be called whenever the content is modified.
callback
will be called with the view
content and the current cursor position.
This callback can safely trigger itself recursively if needed
(for instance if you call on_event
on this view from the callback).
If you need a mutable closure and don’t care about the recursive
aspect, see set_on_edit_mut
.
sourcepub fn on_edit_mut<F>(self, callback: F) -> Selfwhere
F: FnMut(&mut Cursive, &str, usize) + 'static,
pub fn on_edit_mut<F>(self, callback: F) -> Selfwhere
F: FnMut(&mut Cursive, &str, usize) + 'static,
Sets a mutable callback to be called whenever the content is modified.
Chainable variant. See set_on_edit_mut
.
sourcepub fn on_edit<F>(self, callback: F) -> Selfwhere
F: Fn(&mut Cursive, &str, usize) + 'static,
pub fn on_edit<F>(self, callback: F) -> Selfwhere
F: Fn(&mut Cursive, &str, usize) + 'static,
Sets a callback to be called whenever the content is modified.
Chainable variant. See set_on_edit
.
Examples
use cursive_core::views::{EditView, TextContent, TextView};
// Keep the length of the text in a separate view.
let mut content = TextContent::new("0");
let text_view = TextView::new_with_content(content.clone());
let on_edit = EditView::new().on_edit(move |_s, text, _cursor| {
content.set_content(format!("{}", text.len()));
});
sourcepub fn set_on_submit_mut<F>(&mut self, callback: F)where
F: FnMut(&mut Cursive, &str) + 'static,
pub fn set_on_submit_mut<F>(&mut self, callback: F)where
F: FnMut(&mut Cursive, &str) + 'static,
Sets a mutable callback to be called when <Enter>
is pressed.
callback
will be given the content of the view.
Warning: this callback cannot be called recursively. If you somehow trigger this callback again in the given closure, it will be ignored.
If you don’t need a mutable closure but want the possibility of
recursive calls, see set_on_submit
.
sourcepub fn set_on_submit<F>(&mut self, callback: F)where
F: Fn(&mut Cursive, &str) + 'static,
pub fn set_on_submit<F>(&mut self, callback: F)where
F: Fn(&mut Cursive, &str) + 'static,
Sets a callback to be called when <Enter>
is pressed.
callback
will be given the content of the view.
This callback can safely trigger itself recursively if needed
(for instance if you call on_event
on this view from the callback).
If you need a mutable closure and don’t care about the recursive
aspect, see set_on_submit_mut
.
sourcepub fn on_submit_mut<F>(self, callback: F) -> Selfwhere
F: FnMut(&mut Cursive, &str) + 'static,
pub fn on_submit_mut<F>(self, callback: F) -> Selfwhere
F: FnMut(&mut Cursive, &str) + 'static,
Sets a mutable callback to be called when <Enter>
is pressed.
Chainable variant.
sourcepub fn on_submit<F>(self, callback: F) -> Selfwhere
F: Fn(&mut Cursive, &str) + 'static,
pub fn on_submit<F>(self, callback: F) -> Selfwhere
F: Fn(&mut Cursive, &str) + 'static,
Sets a callback to be called when <Enter>
is pressed.
Chainable variant.
Examples
use cursive_core::views::{Dialog, EditView};
let edit_view = EditView::new().on_submit(|s, text| {
s.add_layer(Dialog::info(text));
});
sourcepub fn set_content<S: Into<String>>(&mut self, content: S) -> Callback
pub fn set_content<S: Into<String>>(&mut self, content: S) -> Callback
Replace the entire content of the view with the given one.
Returns a callback in response to content change.
You should run this callback with a &mut Cursive
.
sourcepub fn get_content(&self) -> Rc<String>
pub fn get_content(&self) -> Rc<String>
Get the current text.
sourcepub fn content<S: Into<String>>(self, content: S) -> Self
pub fn content<S: Into<String>>(self, content: S) -> Self
Sets the current content to the given value.
Convenient chainable method.
Does not run the on_edit
callback.
sourcepub fn set_cursor(&mut self, cursor: usize)
pub fn set_cursor(&mut self, cursor: usize)
Sets the cursor position.