Struct Dialog

pub struct Dialog { /* private fields */ }

Popup-like view with a main content, and optional buttons under it.

Examples

let dialog = Dialog::around(TextView::new("Hello!")).button("Ok", |s| s.quit());

Implementations

impl Dialog

pub fn new() -> Dialog

Creates a new Dialog with empty content.

You should probably call content() next.

pub fn around<V>(view: V) -> Dialog

where V: IntoBoxedView,

Creates a new Dialog with the given content.

pub fn content<V>(self, view: V) -> Dialog

where V: IntoBoxedView,

Sets the content for this dialog.

Chainable variant.

Examples

use cursive_core::views::{Dialog, TextView};

let dialog = Dialog::new()
    .content(TextView::new("Hello!"))
    .button("Quit", |s| s.quit());

pub fn get_content(&self) -> &(dyn View + 'static)

Gets the content of this dialog.

use cursive_core::views::{Dialog, TextView};
let dialog = Dialog::around(TextView::new("Hello!"));
let text_view: &TextView = dialog.get_content().downcast_ref::<TextView>().unwrap();
assert_eq!(text_view.get_content().source(), "Hello!");

pub fn get_content_mut(&mut self) -> &mut (dyn View + 'static)

Gets mutable access to the content.

pub fn into_content(self) -> Box<dyn View>

Consumes self and returns the boxed content view.

Examples

use cursive_core::view::View;
use cursive_core::views::{Dialog, TextView};

let dialog = Dialog::around(TextView::new("abc"));

let content: Box<dyn View> = dialog.into_content();
assert!(content.is::<TextView>());

let content: Box<TextView> = content.downcast().ok().unwrap();
assert_eq!(content.get_content().source(), "abc");

pub fn set_content<V>(&mut self, view: V) -> Box<dyn View>

where V: IntoBoxedView,

Sets the content for this dialog.

Previous content will be returned.

pub fn text<S>(text: S) -> Dialog

where S: Into<SpannedString<Style>>,

Convenient method to create a dialog with a simple text content.

Examples

use cursive_core::views::Dialog;

let dialog = Dialog::text("Hello!").button("Quit", |s| s.quit());

pub fn info<S>(text: S) -> Dialog

where S: Into<SpannedString<Style>>,

Convenient method to create an infobox.

It will contain the given text and a Ok dismiss button.

Examples

use cursive_core::views::Dialog;

let dialog = Dialog::info("Some very important information!");

pub fn button<F, S>(self, label: S, cb: F) -> Dialog

where S: Into<SpannedString<Style>>, F: 'static + Fn(&mut Cursive) + Send + Sync,

Adds a button to the dialog with the given label and callback.

Consumes and returns self for easy chaining.

pub fn add_button<F, S>(&mut self, label: S, cb: F)

where S: Into<SpannedString<Style>>, F: 'static + Fn(&mut Cursive) + Send + Sync,

Adds a button to the dialog with the given label and callback.

pub fn add_button_cb<F>(cb: F) -> Arc<dyn Fn(&mut Cursive) + Sync + Send>

where F: Fn(&mut Cursive) + 'static + Send + Sync,

Helper method to store a callback of the correct type for Self::add_button.

This is mostly useful when using this view in a template.

pub fn add_button_with_cb<S>( &mut self, label: S, cb: Arc<dyn Fn(&mut Cursive) + Sync + Send>, )

where S: Into<SpannedString<Style>>,

Helper method to call Self::add_button with a variable from a config.

This is mostly useful when writing a cursive blueprint for this view.

pub fn buttons_len(&self) -> usize

Returns the number of buttons on this dialog.

pub fn clear_buttons(&mut self) -> EventResult

Removes any button from self.

pub fn remove_button(&mut self, i: usize) -> EventResult

Removes a button from this dialog.

Panics

Panics if i >= self.buttons_len().

pub fn h_align(self, h: HAlign) -> Dialog

Sets the horizontal alignment for the buttons, if any.

Only works if the buttons are as a row at the bottom of the dialog.

pub fn get_h_align(&self) -> HAlign

Gets the horizontal alignment for the buttons.

pub fn dismiss_button<S>(self, label: S) -> Dialog

where S: Into<SpannedString<Style>>,

Shortcut method to add a button that will dismiss the dialog.

Examples

use cursive_core::views::Dialog;

let dialog = Dialog::text("Hello!").dismiss_button("Close");

pub fn title<S>(self, label: S) -> Dialog

where S: Into<SpannedString<Style>>,

Sets the title of the dialog.

If not empty, it will be visible at the top.

Examples

use cursive_core::views::Dialog;

let dialog = Dialog::info("Some info").title("Read me!");

pub fn set_title<S>(&mut self, label: S)

where S: Into<SpannedString<Style>>,

Sets the title of the dialog.

pub fn get_title(&self) -> &str

Get the title of the dialog.

pub fn title_position(self, align: HAlign) -> Dialog

Sets the horizontal position of the title in the dialog. The default position is HAlign::Center

pub fn set_title_position(&mut self, align: HAlign)

Sets the horizontal position of the title in the dialog. The default position is HAlign::Center

pub fn get_title_position(&self) -> HAlign

Gets the alignment of the title

pub fn padding(self, padding: Margins) -> Dialog

Sets the padding in the dialog (around content and buttons).

Examples

use cursive_core::views::Dialog;
use cursive_core::view::Margins;

let dialog = Dialog::info("Hello!")
        .padding(Margins::lrtb(1, 1, 0, 0)); // (Left, Right, Top, Bottom)

pub fn get_padding(&self) -> Margins

Gets the padding in the dialog (around content and buttons).

pub fn padding_lrtb( self, left: usize, right: usize, top: usize, bottom: usize, ) -> Dialog

Sets the padding in the dialog.

Takes Left, Right, Top, Bottom fields.

pub fn set_padding(&mut self, padding: Margins)

Sets the padding in the dialog (around content and buttons).

Chainable variant.

pub fn padding_top(self, padding: usize) -> Dialog

Sets the top padding in the dialog (under the title).

pub fn set_padding_top(&mut self, padding: usize)

Sets the top padding in the dialog (under the title).

pub fn padding_bottom(self, padding: usize) -> Dialog

Sets the bottom padding in the dialog (under buttons).

pub fn set_padding_bottom(&mut self, padding: usize)

Sets the bottom padding in the dialog (under buttons).

pub fn padding_left(self, padding: usize) -> Dialog

Sets the left padding in the dialog.

pub fn set_padding_left(&mut self, padding: usize)

Sets the left padding in the dialog.

pub fn padding_right(self, padding: usize) -> Dialog

Sets the right padding in the dialog.

pub fn set_padding_right(&mut self, padding: usize)

Sets the right padding in the dialog.

pub fn buttons(&self) -> impl Iterator<Item = &Button>

Iterate the buttons of this dialog.

pub fn buttons_mut(&mut self) -> impl Iterator<Item = &mut Button>

Mutably iterate the buttons of this dialog.

pub fn focus(&self) -> DialogFocus

Returns currently focused element

pub fn set_focus(&mut self, new_focus: DialogFocus) -> EventResult

Change the current focus of the dialog.

Please be considerate of the context from which focus is being stolen when programmatically moving focus. For example, moving focus to a button when a user is typing something into an EditView would cause them to accidentally activate the button.

The given dialog focus will be clamped to a valid range. For example, attempting to focus a button that no longer exists will instead focus one that does (or the content, if no buttons exist).

Trait Implementations

impl Default for Dialog

fn default() -> Dialog

Returns the “default value” for a type.

impl View for Dialog

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

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

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

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

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

Called once the size for this view has been decided.

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

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

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

Attempt to give this view the focus.

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

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

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

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

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

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

fn needs_relayout(&self) -> bool

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

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

Returns the type of this view.