DialogFrame

Struct DialogFrame 

Source
pub struct DialogFrame<'a> { /* private fields */ }
Expand description

Renders the frame and the Ok/Cancel buttons for a dialog window.

After rendering BaseDialogState::widget_area is available to render any content.

Implementations§

Source§

impl<'a> DialogFrame<'a>

Source

pub fn new() -> Self

Source

pub fn styles(self, styles: DialogFrameStyle) -> Self

Source

pub fn style(self, style: Style) -> Self

Base style for the dialog.

Source

pub fn block(self, block: Block<'a>) -> Self

Block for the dialog.

Source

pub fn border_style(self, style: Style) -> Self

Sets the border-style for the Block, if any.

Source

pub fn title_style(self, style: Style) -> Self

Sets the title-style for the Block, if any.

Source

pub fn button_style(self, style: ButtonStyle) -> Self

Button style.

Source

pub fn ok_text(self, str: &'a str) -> Self

Ok text.

Source

pub fn no_cancel(self) -> Self

No cancel button.

Source

pub fn cancel_text(self, str: &'a str) -> Self

Cancel text.

Source

pub fn left(self, left: Constraint) -> Self

Margin constraint for the left side.

Source

pub fn top(self, top: Constraint) -> Self

Margin constraint for the top side.

Source

pub fn right(self, right: Constraint) -> Self

Margin constraint for the right side.

Source

pub fn bottom(self, bottom: Constraint) -> Self

Margin constraint for the bottom side.

Source

pub fn position(self, pos: Position) -> Self

Put at a fixed position.

Source

pub fn width(self, width: Constraint) -> Self

Constraint for the width.

Source

pub fn height(self, height: Constraint) -> Self

Constraint for the height.

Source

pub fn size(self, size: Size) -> Self

Set at a fixed size.

Source

pub fn layout_size(&self, area: Rect) -> Rect

Calculate the resulting dialog area. Returns the inner area that is available for drawing widgets.

Trait Implementations§

Source§

impl<'a> Clone for DialogFrame<'a>

Source§

fn clone(&self) -> DialogFrame<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for DialogFrame<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for DialogFrame<'a>

Source§

fn default() -> DialogFrame<'a>

Returns the “default value” for a type. Read more
Source§

impl<'a> StatefulWidget for DialogFrame<'a>

Source§

type State = DialogFrameState

State associated with the stateful widget. Read more
Source§

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

Auto Trait Implementations§

§

impl<'a> Freeze for DialogFrame<'a>

§

impl<'a> RefUnwindSafe for DialogFrame<'a>

§

impl<'a> Send for DialogFrame<'a>

§

impl<'a> Sync for DialogFrame<'a>

§

impl<'a> Unpin for DialogFrame<'a>

§

impl<'a> UnwindSafe for DialogFrame<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.