Struct TestHost 

pub struct TestHost<W: View> { /* private fields */ }

A screen hosted for tests.

Implementations

impl<W: View> TestHost<W>

pub fn new(vm: W::Vm) -> Self

The screen with vm, sized 427 × 240 (a common GUI size) — not opened yet (see Self::open).

pub fn size(&mut self, w: f32, h: f32) -> &mut Self

Changes the GUI size.

pub fn open(&mut self) -> &mut Self

Opens the screen (on_open) and draws a frame.

pub fn close(&mut self) -> &mut Self

Closes the screen (on_close).

pub fn frame(&mut self) -> &mut Self

Draws a frame (queued updates, bindings, layout).

pub fn event(&mut self, raw: &str) -> bool

Sends a raw host event (click:X:Y, key:K:M, …), then a frame; returns whether the screen consumed it.

pub fn click_path(&mut self, path: &[u16]) -> bool

Clicks (and releases) the middle of the widget at content path.

pub fn click_id(&mut self, id: &str) -> bool

Clicks the widget tagged id.

pub fn move_to(&mut self, x: f32, y: f32) -> &mut Self

Moves the cursor.

pub fn drag(&mut self, points: &[(f32, f32)]) -> bool

A mouse drag: the button goes down at the first point, moves through the others and comes up at the last; returns whether the press was consumed.

pub fn scroll(&mut self, dy: f32) -> bool

Mouse wheel (positive = up).

pub fn key(&mut self, key: i32) -> bool

A key press (GLFW code, see yog_api::ui::event::keys).

pub fn key_mods(&mut self, key: i32, mods: i32) -> bool

pub fn type_text(&mut self, text: &str) -> &mut Self

Types text into the focused text box.

pub fn type_into(&mut self, id: &str, text: &str) -> &mut Self

Clicks the text box id and types text at its end.

pub fn vm(&self) -> &W::Vm

pub fn vm_mut(&mut self) -> &mut W::Vm

The view model, for arranging state; the bindings update at the next frame.

pub fn handle(&self) -> ScreenHandle<W::Vm>

A handle like the one register() returns.

pub fn root(&self) -> &Widget

The content tree.

pub fn ui(&self) -> &UiRoot

The whole laid-out screen (content is child 0).

pub fn path(&self, id: &str) -> Vec<u16>

Content path of the widget tagged id; panics when there’s none.

pub fn widget(&self, id: &str) -> Option<&Widget>

pub fn text_at(&self, path: &[u16]) -> Option<String>

The text of a label, button or text box.

pub fn text(&self, id: &str) -> Option<String>

The text of the widget tagged id.

pub fn is_visible(&self, id: &str) -> bool

The widget id is visible (it and every ancestor).

pub fn state(&self, id: &str) -> StateFlags

pub fn node(&self, id: &str) -> Option<&LayoutNode>

pub fn rect(&self, id: &str) -> Option<Rect>

pub fn scroll_offset(&self, i: usize) -> f32

Scroll offset of scroller i.

pub fn requests(&self) -> &[String]

Requests made so far: close, navigate:<id>, back.

pub fn closed(&self) -> bool

The screen asked to close.