1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
// SPDX-License-Identifier: MPL-2.0
// SPDX-FileCopyrightText: 2026 FernTech
//! Input-method-editor (IME) descriptors attached to widget nodes.
//!
//! A focusable node carries an optional [`ImeContext`]. Its **presence**
//! declares "this node is a text-input surface" — the platform layer enables
//! the OS input method while the node is focused. Its **absence** (the
//! default for every node) means no OS IME: enabling IME changes how text
//! arrives (printable text routes through `Ime::Commit` and `KeyboardInput`
//! is suppressed during preedit), so the safe, common-case default is off.
//!
//! This module is deliberately winit-free — [`ImePurpose`] mirrors winit's
//! enum of the same name so `teksilo-core` stays decoupled from the windowing
//! backend; `teksilo-app` maps between the two at the platform boundary.
/// Hint describing what an IME-enabled field is used for. Lets the platform
/// optimize the input method — e.g. suppress the learning dictionary /
/// candidate history for passwords, or surface terminal-specific keys.
///
/// Mirrors `winit::window::ImePurpose`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum ImePurpose {
/// No special hint (ordinary text entry).
#[default]
Normal,
/// Password entry. The platform is told the purpose, and on Windows and
/// X11 its input method is kept off while such a field has focus (see
/// [`ImeContext::password`]).
Password,
/// Terminal entry (e.g. extra on-screen-keyboard keys on Wayland).
Terminal,
}
/// Per-node IME descriptor. Presence = "this focusable node is a text-input
/// surface" (OS IME enabled while focused); absence (the node default) = no
/// OS IME. Carried on `WidgetNode`, set via `WidgetBuilder::ime_input`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ImeContext {
/// Purpose hint forwarded to the platform IME.
pub purpose: ImePurpose,
}
impl ImeContext {
/// An ordinary text-input surface (`ImePurpose::Normal`).
pub fn text() -> Self {
Self {
purpose: ImePurpose::Normal,
}
}
/// A password surface (`ImePurpose::Password`). On Windows and X11 the
/// application layer keeps the platform's input method off while it has
/// focus, as native password fields do: its text comes from the keys
/// alone. On Wayland and macOS the input method stays allowed (the
/// on-screen keyboard, dead keys) and is told the purpose. The widget
/// masks a composition it receives on screen and hides it from
/// assistive tech.
pub fn password() -> Self {
Self {
purpose: ImePurpose::Password,
}
}
}