Struct VirtualKeyboard

pub struct VirtualKeyboard { /* private fields */ }

A Keyboard, that can be drawn in egui.

By default holds mobile version of QWERTY, Numeric & Symbols layouts.

Needs to hook into raw input with bump_events.

Example use:

use egui_virtual_keyboard::VirtualKeyboard;

pub struct ExampleApp {
    label: String,
    keyboard: VirtualKeyboard,
}

impl Default for ExampleApp {
    fn default() -> Self {
        Self {
            label: "Hello World!".to_owned(),
            keyboard: Default::default(),
        }
    }
}

impl eframe::App for ExampleApp {
    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
        egui::CentralPanel::default().show(ctx, |ui| {
            ui.horizontal(|ui| {
                ui.label("Write something: ");
                ui.text_edit_singleline(&mut self.label);
            });
        });

        let scr_size = ctx.screen_rect().size();
        egui::Window::new("KBD").show(ctx, |ui| {
                self.keyboard.show(ui);
            });
    }

    fn raw_input_hook(&mut self, ctx: &egui::Context, raw_input: &mut egui::RawInput) {
        self.keyboard.bump_events(ctx, raw_input);
    }
}


fn main() -> eframe::Result {
    let native_options = eframe::NativeOptions::default();
     
    eframe::run_native(
        "eframe template",
        native_options,
        Box::new(|_cc| Ok(Box::new(ExampleApp::default()))),
    )
}

Implementations

impl VirtualKeyboard

pub fn empty() -> Self

Creates empty VirtualKeyboard

pub fn with_id(self, id: Id) -> Self

Use provided Id instead of default “VirtualKeyboard”

pub fn extend(self, layout: Layout) -> Self

Add Layout to keyboard

pub fn clear_layouts(&mut self)

pub fn switch_layout(&mut self, name: &str)

Switches to Layout with provided name (if exists)

pub fn with_butyon_spacing(self, spacing: Vec2) -> Self

Use provided button height instead of default interact_size.x * 0.9

pub fn with_button_height(self, height: f32) -> Self

Use provided button height instead of default interact_size.x * 0.9

pub fn with_button_width(self, width: impl Into<RangeInclusive<f32>>) -> Self

Use provided button width range instead of icon_width..=interact_size.x

pub fn bump_events(&mut self, _ctx: &Context, raw_input: &mut RawInput)

Adds keyboard events to raw input

pub fn show(&mut self, ui: &mut Ui)

Add Keyboard to ui. Recommended to use in separate window or panel.

pub fn layout_name(&self) -> String

Trait Implementations

impl Clone for VirtualKeyboard

fn clone(&self) -> VirtualKeyboard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualKeyboard

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

Formats the value using the given formatter.

impl Default for VirtualKeyboard

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VirtualKeyboard

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VirtualKeyboard

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.