Struct cursive::views::Dialog

pub struct Dialog { /* fields omitted */ }

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());

Methods

impl Dialog

pub fn new() -> Self

Creates a new Dialog with empty content.

You should probably call content() next.

pub fn around<V: View + 'static>(view: V) -> Self

Creates a new Dialog with the given content.

pub fn content<V: View + 'static>(self, view: V) -> Self

Sets the content for this dialog.

Chainable variant.

pub fn get_content(&self) -> &AnyView

Gets the content of this dialog.

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

pub fn get_content_mut(&mut self) -> &mut AnyView

Gets mutable access to the content.

pub fn set_content<V: View + 'static>(&mut self, view: V)

Sets the content for this dialog.

Previous content will be dropped.

pub fn text<S: Into<String>>(text: S) -> Self

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

pub fn info<S: Into<String>>(text: S) -> Self

Convenient method to create an infobox.

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

pub fn button<F, R, S: Into<String>>(self, label: S, cb: F) -> Self where
    F: 'static + Fn(&mut Cursive) -> R, 

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

Consumes and returns self for easy chaining.

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

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 dismiss_button<S: Into<String>>(self, label: S) -> Self

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

pub fn title<S: Into<String>>(self, label: S) -> Self

Sets the title of the dialog.

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

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

Sets the title of the dialog.

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

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 padding<T: Into<Vec4>>(self, padding: T) -> Self

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

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

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

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

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

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

Sets the left padding in the dialog.

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

Sets the right padding in the dialog.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn buttons_mut<'a>(
    &'a mut self
) -> Box<Iterator<Item = &'a mut Button> + 'a>

Returns an iterator on this buttons for this dialog.

pub fn focus(&self) -> DialogFocus

Returns currently focused element

Trait Implementations

impl Default for Dialog

fn default() -> Self

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: Vec2) -> Vec2

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

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided,

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

Called when a key was pressed.

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

This view is offered focus. Will it take it?

fn call_on_any<'a>(
    &mut self,
    selector: &Selector,
    callback: Box<FnMut(&mut Any) + 'a>
)

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

fn focus_view(&mut self, selector: &Selector) -> Result<(), ()>

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

fn needs_relayout(&self) -> bool

Returns true if the view content changed since last layout phase.