Struct SystemKeyboard 

pub struct SystemKeyboard { /* private fields */ }

The system keyboard as the screens see it: whether there is one, the ask waiting for the platform and the answer waiting for the screen. Absent until the platform says otherwise.

Implementations

impl SystemKeyboard

pub fn is_present(&self) -> bool

Whether the platform has a system keyboard.

pub fn ask(&mut self, ask: TextAsk) -> bool

Asks for the keyboard with ask. Without one nothing is asked and this is false: the screen takes typed keys instead. Asking again before the platform opened it replaces the ask; asking while it is open does nothing, and is false.

pub fn is_waiting(&self) -> bool

Whether an ask waits for the player: asked for and not yet answered.

pub fn take_answer(&mut self) -> Option<TextAnswer>

The player’s answer, once: None until they close the keyboard.

pub fn set_present(&mut self, present: bool)

The platform says whether it has a keyboard, before each frame. One that goes away takes an ask with it: the screen hears TextAnswer::Cancelled.

pub fn take_ask(&mut self) -> Option<TextAsk>

The ask to open, once, for the platform: from then on the keyboard is open until answer.

pub fn answer(&mut self, answer: TextAnswer)

The platform hands back what the player did, which closes the keyboard.

Trait Implementations

impl Clone for SystemKeyboard

fn clone(&self) -> SystemKeyboard

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SystemKeyboard

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SystemKeyboard

fn default() -> SystemKeyboard

Returns the “default value” for a type.

impl Eq for SystemKeyboard

impl PartialEq for SystemKeyboard

fn eq(&self, other: &SystemKeyboard) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SystemKeyboard