Skip to main content

Group

Struct Group 

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

A composite container that renders multiple widgets in order.

Children are rendered in the order they were added. Each child receives the same area, so later children may overwrite earlier ones.

§Example

use ftui_widgets::group::Group;

let group = Group::new()
    .push(background_widget)
    .push(foreground_widget);
group.render(area, &mut frame);

Implementations§

Source§

impl<'a> Group<'a>

Source

pub fn new() -> Self

Create a new empty group.

Source

pub fn push<W: Widget + 'a>(self, widget: W) -> Self

Add a widget to the group.

Source

pub fn push_boxed(self, widget: Box<dyn Widget + 'a>) -> Self

Add a boxed widget to the group.

Source

pub fn len(&self) -> usize

Number of children in the group.

Source

pub fn is_empty(&self) -> bool

Whether the group has no children.

Trait Implementations§

Source§

impl Default for Group<'_>

Source§

fn default() -> Self

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

impl Widget for Group<'_>

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> Freeze for Group<'a>

§

impl<'a> !RefUnwindSafe for Group<'a>

§

impl<'a> !Send for Group<'a>

§

impl<'a> !Sync for Group<'a>

§

impl<'a> Unpin for Group<'a>

§

impl<'a> UnsafeUnpin for Group<'a>

§

impl<'a> !UnwindSafe for Group<'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> 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, 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