Struct termwiz::widgets::Ui

pub struct Ui<'widget> { /* private fields */ }

Manages the widgets on the display

Implementations

impl<'widget> Ui<'widget>

pub fn new() -> Self

pub fn add<W: Widget + 'widget>(
    &mut self,
    parent: Option<WidgetId>,
    w: W
) -> WidgetId

pub fn set_root<W: Widget + 'widget>(&mut self, w: W) -> WidgetId

pub fn add_child<W: Widget + 'widget>(
    &mut self,
    parent: WidgetId,
    w: W
) -> WidgetId

pub fn process_event_queue(&mut self) -> Result<()>

pub fn queue_event(&mut self, event: WidgetEvent)

Queue up an event. Events are processed by the appropriate Widget::update_state method. Events may be re-processed to simplify handling for widgets. eg: a TODO: is to synthesize double and triple click events.

pub fn set_focus(&mut self, id: WidgetId)

Assign keyboard focus to the specified widget.

pub fn render_to_screen(&mut self, screen: &mut Surface) -> Result<bool>

Apply the current state of the widgets to the screen. This has the side effect of clearing out any unconsumed input queue. Returns true if the Ui may need to be updated again; for example, if the most recent update operation changed layout.

pub fn to_screen_coords(
    &self,
    widget: WidgetId,
    coords: &ParentRelativeCoords
) -> ScreenRelativeCoords

Convert coordinates that are relative to widget into coordinates that are relative to the screen origin (top left).

pub fn to_widget_coords(
    &self,
    widget: WidgetId,
    coords: &ScreenRelativeCoords
) -> ParentRelativeCoords

Convert coordinates that are relative to the screen origin (top left) into coordinates that are relative to the widget.

Trait Implementations

impl<'widget> Default for Ui<'widget>

fn default() -> Ui<'widget>

Returns the “default value” for a type.