Struct Panel

pub struct Panel { /* private fields */ }

The keyboard’s state and geometry. Coordinates are those the host passes in, physical pixels in ltk’s runtime.

Implementations

impl Panel

pub fn draw(&mut self, canvas: &mut Canvas)

Paint the panel where Panel::set_rect put it.

impl Panel

pub fn new(layouts: Vec<Layout>, preferred: &str) -> Self

A panel over layouts, starting on the one named preferred when present. No layouts means the built-in one.

pub fn for_language(lang: &str) -> Self

Every installed layout, the one for lang (es, en-GB…) first.

pub fn layout(&self) -> &Layout

pub fn layer(&self) -> &str

pub fn rect(&self) -> Rect

pub fn keys(&self) -> &[KeyRect]

pub fn popup(&self) -> Option<&Popup>

pub fn pressed(&self) -> Option<usize>

The key currently held, if any.

pub fn shift_locked(&self) -> bool

pub fn modifiers(&self) -> Modifiers

pub fn purpose(&self) -> Purpose

pub fn set_purpose(&mut self, purpose: Purpose)

Change what the panel types into; a terminal gets its row of keys above the layout.

pub fn height(&self, width: f32, scale: f32) -> f32

Height the panel needs width pixels wide at scale, for its current layer and purpose.

pub fn height_within(&self, width: f32, scale: f32, screen_height: f32) -> f32

Self::height kept within 40 % of screen_height, so a wide screen gets short keys instead of a keyboard that covers it.

pub fn set_rect(&mut self, rect: Rect, scale: f32)

Place the keys inside rect: the purpose’s rows first, each spanning the width, then the layout’s, which share one key unit and are centred when narrower than the widest.

pub fn press_down(&mut self, pos: Point, now: Instant) -> Option<Event>

A press at pos; None when it is outside the panel and the host should treat it as its own.

pub fn press_move(&mut self, pos: Point) -> bool

The held finger or pointer moved; with the variants open, selects the one under it.

pub fn press_up(&mut self, pos: Point, now: Instant) -> Option<Event>

The press ended: type the key, the chosen variant, or act.

pub fn tick(&mut self, now: Instant) -> Option<Event>

Time passed with a key held: opens its variants, or repeats backspace.

pub fn next_deadline(&self) -> Option<Instant>

When Panel::tick next has something to do.

pub fn cancel_press(&mut self)