Skip to main content

Panel

Struct Panel 

Source
pub struct Panel<'a, W> { /* private fields */ }
Expand description

A bordered container that renders a child widget inside an inner padded area.

Implementations§

Source§

impl<'a, W> Panel<'a, W>

Source

pub fn new(child: W) -> Self

Create a new panel wrapping the given child widget.

Source

pub fn borders(self, borders: Borders) -> Self

Set which borders to draw.

Source

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

Set the style applied to the border lines.

Source

pub fn border_type(self, border_type: BorderType) -> Self

Set the border line type (e.g. square, rounded, double).

Source

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

Set the title text displayed on the top border.

Source

pub fn title_alignment(self, alignment: Alignment) -> Self

Set the horizontal alignment of the title.

Source

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

Set the style applied to the title text.

Source

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

Set the subtitle text displayed on the bottom border.

Source

pub fn subtitle_alignment(self, alignment: Alignment) -> Self

Set the horizontal alignment of the subtitle.

Source

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

Set the style applied to the subtitle text.

Source

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

Set the base style for the entire panel area.

Source

pub fn padding(self, padding: impl Into<Sides>) -> Self

Set inner padding between the border and child content.

Source

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

Compute the inner area inside the panel borders.

Trait Implementations§

Source§

impl<'a, W: Clone> Clone for Panel<'a, W>

Source§

fn clone(&self) -> Panel<'a, W>

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, W: Debug> Debug for Panel<'a, W>

Source§

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

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

impl<W: Widget> Widget for Panel<'_, W>

Source§

fn render(&self, area: Rect, frame: &mut Frame<'_>)

Render the widget into the frame at the given area. Read more
Source§

fn is_essential(&self) -> bool

Whether this widget is essential and should always render. Read more

Auto Trait Implementations§

§

impl<'a, W> Freeze for Panel<'a, W>
where W: Freeze,

§

impl<'a, W> RefUnwindSafe for Panel<'a, W>
where W: RefUnwindSafe,

§

impl<'a, W> Send for Panel<'a, W>
where W: Send,

§

impl<'a, W> Sync for Panel<'a, W>
where W: Sync,

§

impl<'a, W> Unpin for Panel<'a, W>
where W: Unpin,

§

impl<'a, W> UnsafeUnpin for Panel<'a, W>
where W: UnsafeUnpin,

§

impl<'a, W> UnwindSafe for Panel<'a, W>
where W: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more