Re-enable IME support on Linux by YgorSouza · Pull Request #5198 · emilk/egui

YgorSouza · 2024-09-30T15:34:48Z

Reverts #5188 and adds a different fix to restore IME on Linux without breaking the backspace and arrow keys.

Closes IME input does not working on Linux since v0.29.0 #5544
Closes Re-enable IME support on Linux #5198
I have followed the instructions in the PR template

This reverts commit 15d3d43.

It means different things on X11 and Wayland, and causes us to assume IME is active when it isn't, causing the backspace and arrow keys to be disabled.

github-actions · 2024-09-30T15:38:51Z

Preview available at https://egui-pr-preview.github.io/pr/5198-fix-linux-ime
Note that it might take a couple seconds for the update to show up after the preview_build workflow has completed.

YgorSouza · 2024-09-30T15:45:08Z

@rustbasic @crumblingstatue can you test this?

I've tested with Fedora 40/Gnome 46 with both the regular (Wayland) session and the XOrg session, with the compose key, the Unicode input (Ctrl+Shift+U) and the Chinese (Intelligent Pinyin) input source. Everything seems to work, and the backspace and arrow keys work on both as well.

crumblingstatue · 2024-09-30T16:13:01Z

I can't test IME, because fcitx (& pals) somehow break my X11 setup (don't ask me how), but I can confirm that backspace and arrow keys work.

rustbasic · 2024-09-30T17:29:13Z

Dear emilk & Dear YgorSouza

My opinion is,

Linux: Disable IME to fix backspace/arrow keys #5188
It seems like it's impossible to input languages other than English that require an IME on Linux.
Fix: Selectable whether to key handling in IME #5182
For non-English users using Linux, I think Fix: Selectable whether to key handling in IME #5182 is the right way, because we can control turning it on/off as needed.
If there are any parts we don't like, we can just edit them.
Re-enable IME support on Linux #5198
Re-enable IME support on Linux #5198 It should work fine on Windows, as there are no changes.
I'm not sure if it will work well on some Linux + Chinese.

YgorSouza · 2024-09-30T18:12:41Z

I'm not sure if it will work well on some Linux + Chinese

Is there anyone who can test this? I mean, it seems fine to me, but I'm not Chinese so I don't know.

#5182 looks like it would require a major release? It's adding fields to structs, so I guess that's a breaking change. But if we can get the IME to work correctly on all platforms, maybe it won't be needed? And egui-winit already has an allow_ime field, so we could block IME events at this level, if needed, without involving the TextEdit or any other widgets.

egui/crates/egui-winit/src/lib.rs

Lines 844 to 849 in ce744e6

    
           let allow_ime = ime.is_some(); 
        
           if self.allow_ime != allow_ime { 
        
               self.allow_ime = allow_ime; 
        
               crate::profile_scope!("set_ime_allowed"); 
        
               window.set_ime_allowed(allow_ime); 
        
           }

rustbasic · 2024-10-01T06:41:14Z

allow_ime turns the entire IME function of the OS ON/OFF, so it is not the way we expect.

As you may have noticed,
some Linux and some Chinese input IMEs have a problem with IME::enable that persists from the program startup,
so it is always recognized as IME input state.
It seems necessary to directly control ON/OFF.

YgorSouza · 2024-10-01T07:17:19Z

The change in this PR ignores the Enabled event on Linux, where on X11 it seems to just mean that the window supports IME (and sometimes it can't even be turned off). That should hopefully be enough to prevent egui from going into IME mode in applications where IME isn't used at all. It is only enabled in the Preedit event, which contains a string and a cursor range, so we're definitely using IME if we get that event, since winit can't just invent this data out of nowhere.

If this still causes problems, I think we need an issue explaining what those problems are and on which systems they occur, so we can think about a solution that doesn't break anything for anyone else.

emilk

Code LGTM, but we need to test this properly:

X11 without IME
X11 with IME
Wayland without IME
Wayland with IME

iamazy · 2024-12-30T15:40:18Z

Code LGTM, but we need to test this properly:

X11 without IME

X11 with IME

Wayland without IME

Wayland with IME

I tested with X11 without IME and X11 with IME, chinese input works well.

tmvkrpxl0 · 2024-12-30T17:36:36Z

I tried it out on Wayland with fcitx5 running custom_font example. Korean input works well, although I had to add custom font that supports Korean font.

emilk · 2024-12-31T12:36:40Z

Thanks for the help testing!

Reverts emilk#5188 and adds a different fix to restore IME on Linux without breaking the backspace and arrow keys. * Closes emilk#5544 * Closes emilk#5198 * [x] I have followed the instructions in the PR template

Workaround for emilk/egui#5008 — on Linux (X11/XWayland via nix develop), IME activation via set_ime_allowed(true) causes the display server to capture Backspace and arrow key events through XIM, preventing them from reaching egui TextEdit widgets. bevy_egui's process_ime_system calls set_ime_allowed(true) whenever a TextEdit gains focus. egui-winit fixed this in emilk/egui#5188 and emilk/egui#5198, but bevy_egui has its own input pipeline and still triggers the problematic path. Setting enable_ime = false on the EguiContextSettings prevents the call entirely. Co-authored-by: Cursor <cursoragent@cursor.com>

* Fix command palette backspace handling at top level * Disable IME on Linux to fix Backspace/arrow keys in TextEdit Workaround for emilk/egui#5008 — on Linux (X11/XWayland via nix develop), IME activation via set_ime_allowed(true) causes the display server to capture Backspace and arrow key events through XIM, preventing them from reaching egui TextEdit widgets. bevy_egui's process_ime_system calls set_ime_allowed(true) whenever a TextEdit gains focus. egui-winit fixed this in emilk/egui#5188 and emilk/egui#5198, but bevy_egui has its own input pipeline and still triggers the problematic path. Setting enable_ime = false on the EguiContextSettings prevents the call entirely. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>

YgorSouza added 2 commits September 30, 2024 16:20

Revert "Fix backspace/arrow keys in TextEdit on Linux (emilk#5188)"

a72bdd7

This reverts commit 15d3d43.

Ignore Ime::Enabled event on Linux

a293206

It means different things on X11 and Wayland, and causes us to assume IME is active when it isn't, causing the backspace and arrow keys to be disabled.

YgorSouza force-pushed the fix-linux-ime branch from db250de to a293206 Compare September 30, 2024 15:37

YgorSouza marked this pull request as ready for review October 1, 2024 08:47

emilk approved these changes Oct 1, 2024

View reviewed changes

Repository owner deleted a comment from rustbasic Oct 2, 2024

This was referenced Dec 30, 2024

IME input does not working on Linux since v0.29.0 #5544

Closed

How to support IME? Harzu/egui_term#3

Closed

emilk added eframe Relates to epi and eframe egui-winit porblems related to winit native-linux Problem specific to Linux labels Dec 31, 2024

emilk merged commit 3ffe1ed into emilk:master Dec 31, 2024

YgorSouza mentioned this pull request Sep 5, 2025

Incorrect typing behavior with TextEdit singleline and multiline with IbusWayland enabled #7485

Closed

zxq82lm mentioned this pull request Feb 23, 2026

Fix: Backspace behavior in command palette on Linux. elodin-sys/elodin#521

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Re-enable IME support on Linux#5198

Re-enable IME support on Linux#5198
emilk merged 2 commits intoemilk:masterfrom
YgorSouza:fix-linux-ime

YgorSouza commented Sep 30, 2024 •

edited by emilk

Loading

Uh oh!

github-actions bot commented Sep 30, 2024

Uh oh!

YgorSouza commented Sep 30, 2024

Uh oh!

crumblingstatue commented Sep 30, 2024

Uh oh!

rustbasic commented Sep 30, 2024

Uh oh!

YgorSouza commented Sep 30, 2024

Uh oh!

rustbasic commented Oct 1, 2024

Uh oh!

YgorSouza commented Oct 1, 2024

Uh oh!

emilk left a comment •

edited

Loading

Uh oh!

iamazy commented Dec 30, 2024 •

edited

Loading

Uh oh!

tmvkrpxl0 commented Dec 30, 2024

Uh oh!

emilk commented Dec 31, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

YgorSouza commented Sep 30, 2024 • edited by emilk Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 30, 2024

Uh oh!

YgorSouza commented Sep 30, 2024

Uh oh!

crumblingstatue commented Sep 30, 2024

Uh oh!

rustbasic commented Sep 30, 2024

Uh oh!

YgorSouza commented Sep 30, 2024

Uh oh!

rustbasic commented Oct 1, 2024

Uh oh!

YgorSouza commented Oct 1, 2024

Uh oh!

emilk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iamazy commented Dec 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tmvkrpxl0 commented Dec 30, 2024

Uh oh!

emilk commented Dec 31, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

YgorSouza commented Sep 30, 2024 •

edited by emilk

Loading

emilk left a comment •

edited

Loading

iamazy commented Dec 30, 2024 •

edited

Loading