Struct tuikit::widget::Win

pub struct Win<'a, Message = ()> { /* fields omitted */ }

! A Win is like a div in HTML, it has its margin/padding, and border

Implementations

impl<'a, Message> Win<'a, Message>

pub fn new(widget: impl Widget<Message> + 'a) -> Self

pub fn margin_top(self, margin_top: impl Into<Size>) -> Self

pub fn margin_right(self, margin_right: impl Into<Size>) -> Self

pub fn margin_bottom(self, margin_bottom: impl Into<Size>) -> Self

pub fn margin_left(self, margin_left: impl Into<Size>) -> Self

pub fn margin(self, margin: impl Into<Size>) -> Self

pub fn padding_top(self, padding_top: impl Into<Size>) -> Self

pub fn padding_right(self, padding_right: impl Into<Size>) -> Self

pub fn padding_bottom(self, padding_bottom: impl Into<Size>) -> Self

pub fn padding_left(self, padding_left: impl Into<Size>) -> Self

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

pub fn border_top(self, border_top: bool) -> Self

pub fn border_right(self, border_right: bool) -> Self

pub fn border_bottom(self, border_bottom: bool) -> Self

pub fn border_left(self, border_left: bool) -> Self

pub fn border(self, border: bool) -> Self

pub fn border_top_attr(self, border_top_attr: impl Into<Attr>) -> Self

pub fn border_right_attr(self, border_right_attr: impl Into<Attr>) -> Self

pub fn border_bottom_attr(self, border_bottom_attr: impl Into<Attr>) -> Self

pub fn border_left_attr(self, border_left_attr: impl Into<Attr>) -> Self

pub fn border_attr(self, attr: impl Into<Attr>) -> Self

pub fn fn_draw_header(
    self,
    fn_draw_header: Box<dyn Fn(&mut dyn Canvas) -> Result<()>>
) -> Self

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

pub fn title_attr(self, title_attr: impl Into<Attr>) -> Self

pub fn right_prompt(self, right_prompt: impl Into<String>) -> Self

pub fn right_prompt_attr(self, right_prompt_attr: impl Into<Attr>) -> Self

pub fn basis(self, basis: impl Into<Size>) -> Self

pub fn grow(self, grow: usize) -> Self

pub fn shrink(self, shrink: usize) -> Self

Trait Implementations

impl<'a, Message> Draw for Win<'a, Message>

fn draw(&self, canvas: &mut dyn Canvas) -> Result<()>

Reserve margin & padding, draw border.

impl<'a, Message> Split<Message> for Win<'a, Message>

fn get_basis(&self) -> Size

fn get_grow(&self) -> usize

fn get_shrink(&self) -> usize

fn inner_size(&self) -> (Size, Size)

get the default size of inner content, will be used if basis is Default

impl<'a, Message> Widget<Message> for Win<'a, Message>

fn size_hint(&self) -> (Option<usize>, Option<usize>)

the (width, height) of the content it will be the hint for layouts to calculate the final size

fn on_event(&self, event: Event, rect: Rectangle) -> Vec<Message>

given a key event, emit zero or more messages typical usage is the mouse click event where containers would pass the event down to their children.