Struct glerminal::menu_systems::Filter

pub struct Filter { /* fields omitted */ }

Represents a HashMap from VirtualKeyCode to character. Used to filter out which characters get registered by the textinput.

Use Filter::empty_filter() to create a new filter and for example .with_basic_latin_characters to add basic latin characters to the filter.
Use .with_pair or insert to create your own filters.

Methods

impl Filter

pub fn empty_filter() -> Filter

Create an empty filter, where other filters can be added, such as basic_latin_keycode_filter

pub fn with_basic_latin_characters(self) -> Filter

Creates a Filter with basic latin characters

Includes characters a-z and spacebar.

pub fn with_basic_numerals(self) -> Filter

Creates a Filter with basic numerals

Includes numerals from 0-9

pub fn with_basic_special_symbols(self) -> Filter

Creates a Filter with basic special symbols

Includes ', \, :, ., ;, ,, =, -, *, _, /, [, ]

Unfortunately VirtualKeyCode doesn't seem to support other special characters currently.

pub fn with_pair(self, keycode: VirtualKeyCode, character: char) -> Filter

Add a specific VirtualKeyCode: char pair to this filter and return the current filter.

This would mean that when you press the keycode, the character specified will be typed.

pub fn insert(&mut self, keycode: VirtualKeyCode, character: char)

Insert a specific VirtualKeyCode: char pair to this filter.

Works similarly to with_pair

pub fn get(&self, keycode: &VirtualKeyCode) -> Option<&char>

Get the character from the specified VirtualKeyCode, None if it doesn't exist.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.