Struct PasscodeKeyboard 

pub struct PasscodeKeyboard { /* private fields */ }

The keyboard’s state: which layer shows and whether the next letter is a capital. Small and Copy, so a surface can keep it beside its own state.

Implementations

impl PasscodeKeyboard

pub fn for_pin() -> PasscodeKeyboard

The keyboard for a PIN: its digits on a phone’s number pad, four rows of three.

pub fn for_secret(pin: bool) -> PasscodeKeyboard

The keyboard for a secret that is a PIN when pin, a password otherwise.

pub fn is_for_pin(self) -> bool

Whether this keyboard is for a PIN (Self::for_pin).

pub fn character(self, key: PasscodeKey) -> Option<String>

The character a PasscodeKey::Char key types now, shift applied; None for every other key.

pub fn height(self, key_height: f64, gap: f64) -> f64

How tall the keyboard is: four rows for a PIN’s number pad, five for the letters.

pub fn layout( self, rect: Rect, key_height: f64, gap: f64, ) -> Vec<(PasscodeKey, Rect)>

Every key and where it sits inside rect, row by row, left to right. Keys are no wider than a comfortable target and each row is centred; the number pad’s rows share one grid of three columns.

pub fn key_at( self, rect: Rect, key_height: f64, gap: f64, point: Point, ) -> Option<PasscodeKey>

pub fn press(&mut self, key: PasscodeKey) -> Option<PasscodeInput>

Press key: shift and the symbols layer change the keyboard; every other key asks something of the passcode.

pub fn face(self, key: PasscodeKey) -> KeyFace

What key shows on this keyboard: the character it types (shift applied), its layer’s word, or the icon of what it does.

pub fn paint( self, scene: &mut Scene, transform: Affine, text: &mut TextRenderer, theme: &Theme, place: (Rect, f64, f64), enter_enabled: bool, )

Paint the keys at place (the keyboard’s rectangle, key height and gap) as the theme’s controls: a key’s filled face and its label, the active modifiers lit. Enter takes the disabled face while enter_enabled is false, as the action it stands for would.

Trait Implementations

impl Clone for PasscodeKeyboard

fn clone(&self) -> PasscodeKeyboard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PasscodeKeyboard

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

Formats the value using the given formatter.

impl Default for PasscodeKeyboard

fn default() -> PasscodeKeyboard

Returns the “default value” for a type.

impl PartialEq for PasscodeKeyboard

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PasscodeKeyboard

impl Eq for PasscodeKeyboard

impl StructuralPartialEq for PasscodeKeyboard