fix(windows): splash screen is unresponsive #15269

rc-swag · 2025-12-03T01:46:26Z

Fixes: #14261
Fixes: #14664
Build-bot: skip release:windows
Changes

Added a return value using TModalResult to the "Keyman Configuration" form. When "Install Now" is selected as Keyman Configuration exists, the splash screen will also close. This address the issue of the splash screen covering the "restart now" Window displayed by Windows installer.
Also changed the event HandleInstallNow in the UpdateAvailable state to callStartDownloadProcess instead of changing state to Downloading we need it to be new process, which is what StartDownloadProcess takes care off.

keymanapp-test-bot · 2025-12-03T01:46:31Z

User Test Results

Test specification and instructions

✅ TEST_KEYMAN_UPDATE_NOW_HAS_RUN (PASSED) (notes)
✅ TEST_KEYMAN_UPDATE_NOW_HAS_NOT_RUN (PASSED) (notes)
✅ TEST_KEYMAN_UPDATE_NOW_KBD_KEYMAN_HAS_RUN (PASSED) (notes)

Test Artifacts

Windows

…creen-unresponsive

rc-swag · 2025-12-23T11:48:55Z

Notes:

If Install Now is true and the shell execute is successful Close or set ModalResult
Need to handle the splash screen so get a handle to the splash screen and close it also.
Maybe on another PR but add an eventhandler to give a status on the Configurtion to show downloading when downloading is required.

The Configuration window will return a mrAbort result when we want the Splash screen to close. This is in the case the Installation now has been selected.

rc-swag · 2026-01-08T06:09:48Z

This is a series of screenshots before and after the change. For this scenario Keyman has run in the current Windows session.
This screen is the same before as after, the check for updates button is pressed an update is found
then the Install Now button is presed.

Before:
Since Keyman has run in the current Windows session a message pops up warning the user a restart will be required. If windows has not run this pop-up will not appear.

Update Now is selected. Keyman starts to install then the Windows installer has "Restart now" form but its hidden by the splash screen In the screen shot you can see the icon for it on the start bar.

Selecting the Icon will bring it infront of the start bar.

After:
Pressing the Install now will kick-off the install but it will also close the configuration and the splash screen.

rc-swag · 2026-01-09T06:00:35Z

User Testing

For these tests the PR build needs to beto be older than the lastest Alpha build.

TEST_KEYMAN_UPDATE_NOW_HAS_RUN

Install version of Keyman with this PR
Launch Keyman but at the splash screen choose start
Close Keyman
Launch Keyman but at the splash screen choose configuration
Go to the Update tab and press check for updates
There should be a keyman 19.0.186 or higher
Press install now
The a pop-up warning that this will require a system reastart will display. Select "update now"
Expected Result: The configuration and the splash screen will close.
A pop-up asking for elevated permission will display.
If you go through these steps quickly the download of the Keyman update may not have finished so it will appear nothing is happening. Showing the download dialog will be addressed in another PR.

TEST_KEYMAN_UPDATE_NOW_HAS_NOT_RUN
After uninstalling other versions of Keyman restart the test machine

Install version of Keyman with this PR
Launch Keyman but at the splash screen choose configuration
Go to the Update tab and press check for updates
There should be a keyman 19.0.186 or higher
Press install now
Expected Result: The configuration and the splash screen will close.
A pop-up asking for elevated permission will display.
If you go through these steps quickly the download of the Keyman update may not have finished so it will appear nothing is happening. Showing the download dialog will be addressed in another PR.

TEST_KEYMAN_UPDATE_NOW_KBD_KEYMAN_HAS_RUN
After uninstalling other versions of Keyman restart the test machine

Install version of Keyman with this PR
Launch Keyman but at the splash screen choose configuration
Install an older version of a keyboard from disk
Go to the Update tab and press check for updates
There should be a keyman 19.0.186 or higher
There should also be an update for the Keyboard
Press install now
Expected Result: The configuration and the splash screen will close.
A pop-up asking for elevated permission will display.
If you go through these steps quickly the download of the Keyman update may not have finished so it will appear nothing is happening. Showing the download dialog will be addressed in another PR.

Meng-Heng · 2026-01-17T05:45:17Z

Test Specs

Windows 10 Bootcamp in macOS Sequoia

The results are as followed:

Prerequisites for every tests

Uninstall active Keyman
Restart

Test Results

TEST_KEYMAN_UPDATE_NOW_HAS_RUN (PASSED):

Install keyman-19.0.190-alpha-test-15269
Launch Keyman -> Click Start -> Exit Keyman
Launch Keyman -> Click Configuration -> Go to "Update" -> Click" Check for new updates"
Keyman 19.0.192 shows up -> Click "Install updates now"
Verified: a pop-up warning “require a system restart"
Click “Update now”
Verified: Startup and configuration windows close, and a pop-up asking for elevated permission
Verified: After some time, a pop-up warning “require a system restart"
Click “Yes” > Machine restart
Verified: After a restart, a pop-up asking for elevated permission > installation process complete
Keyman 19.0.192-alpha is active.

TEST_KEYMAN_UPDATE_NOW_HAS_NOT_RUN (PASSED):

Install keyman-19.0.190-alpha-test-15269
Launch Keyman -> Click Configuration -> Go to "Update" -> Click" Check for new updates"
Keyman 19.0.192 shows up -> Click "Install updates now"
Verified: Startup and configuration windows close
Verified: After some time, a pop-up asking for elevated permission
Keyman 19.0.192-alpha is active.

TEST_KEYMAN_UPDATE_NOW_KBD_KEYMAN_HAS_RUN (PASSED):

Install keyman-19.0.190-alpha-test-15269
Launch Keyman -> Click Configuration -> Download Khmer Angkor 2.2 from machine
Go to "Update" -> Click" Check for new updates"
Verified: Keyboard Khmer Angkor 2.4 and Keyman 19.0.192 show up
Click "Install updates now"
Verified: Startup and configuration windows close
Verified: A few seconds later, a pop-up asking for elevated permission
Verified: After some time, a pop-up warning “require a system restart"
Click “Yes” > Machine restart
After a restart > a pop-up asking for elevated permission > installation process complete
Verified: Keyman 19.0.192-alpha and Khmer Angkor 2.4 show up as expected.

darcywong00 · 2026-01-20T02:43:39Z

windows/src/desktop/kmshell/startup/UfrmSplash.pas

+    configFrmResult := Main(Self);
+    if configFrmResult = mrAbort then
+      Command_Exit
+    else
+      Do_Content_Render;


a little WET with ll.157-161 😉

I suppose we can refactor in the future if there's a 3x

darcywong00

lgtm

nit - can you update the PR description to start with "action" word?

mcdurdin · 2026-01-15T23:43:47Z

windows/src/desktop/kmshell/startup/UfrmSplash.pas

+    configFrmResult := Main(Self);
+    if configFrmResult = mrAbort then
+      Command_Exit
+    else
+      Do_Content_Render;


Can we wrap this in a function so we don't repeat the logic below?

rc-swag added 2 commits December 1, 2025 09:47

fix(windows): ensure download is new process

62af1f0

fix(windows): notes and psedo code to be fleshed out

e028b4c

github-project-automation bot added this to Keyman Dec 3, 2025

github-project-automation bot moved this to Todo in Keyman Dec 3, 2025

keymanapp-test-bot bot added the user-test-missing User tests have not yet been defined for the PR label Dec 3, 2025

keymanapp-test-bot bot added this to the A19S17 milestone Dec 3, 2025

rc-swag marked this pull request as draft December 3, 2025 01:46

github-actions bot added windows/ windows/config/ fix labels Dec 3, 2025

keyman-server modified the milestones: A19S17, A19S18 Dec 6, 2025

keyman-server modified the milestones: A19S18, A19S19 Dec 21, 2025

chore(windows): Merge branch 'master' into fix/windows/14261/splash-s…

aa3e656

…creen-unresponsive

keyman-server modified the milestones: A19S19, A19S20 Jan 3, 2026

rc-swag added 2 commits January 6, 2026 10:39

fix(windows): config frm result used to close splash

10f1e24

The Configuration window will return a mrAbort result when we want the Splash screen to close. This is in the case the Installation now has been selected.

fix(windows): fix to use TModalResult instead of integer

0bbda82

rc-swag added 2 commits January 8, 2026 17:19

fix(windows): remove dead code

9c7b1a6

fix(windows): move event handler to diff PR

d394241

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed and removed user-test-missing User tests have not yet been defined for the PR labels Jan 9, 2026

Merge branch 'master' into fix/windows/14261/splash-screen-unresponsive

a3b784e

rc-swag self-assigned this Jan 14, 2026

rc-swag assigned Meng-Heng Jan 14, 2026

rc-swag marked this pull request as ready for review January 14, 2026 03:57

keyman-server modified the milestones: A19S20, A19S21 Jan 16, 2026

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Jan 17, 2026

darcywong00 reviewed Jan 20, 2026

View reviewed changes

darcywong00 approved these changes Jan 20, 2026

View reviewed changes

mcdurdin reviewed Jan 20, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(windows): splash screen is unresponsive #15269

fix(windows): splash screen is unresponsive #15269

rc-swag commented Dec 3, 2025 •

edited by darcywong00

Loading

Uh oh!

keymanapp-test-bot bot commented Dec 3, 2025 •

edited

Loading

Uh oh!

rc-swag commented Dec 23, 2025

Uh oh!

rc-swag commented Jan 8, 2026

Uh oh!

rc-swag commented Jan 9, 2026 •

edited

Loading

Uh oh!

Meng-Heng commented Jan 17, 2026

Uh oh!

darcywong00 Jan 20, 2026

Uh oh!

darcywong00 left a comment

Uh oh!

mcdurdin Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

fix(windows): splash screen is unresponsive #15269

Are you sure you want to change the base?

fix(windows): splash screen is unresponsive #15269

Conversation

rc-swag commented Dec 3, 2025 • edited by darcywong00 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

keymanapp-test-bot bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Test Results

Test Artifacts

Uh oh!

rc-swag commented Dec 23, 2025

Uh oh!

rc-swag commented Jan 8, 2026

Uh oh!

rc-swag commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Testing

Uh oh!

Meng-Heng commented Jan 17, 2026

Test Specs

The results are as followed:

Test Results

Uh oh!

darcywong00 Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

darcywong00 left a comment

Choose a reason for hiding this comment

Uh oh!

mcdurdin Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

rc-swag commented Dec 3, 2025 •

edited by darcywong00

Loading

keymanapp-test-bot bot commented Dec 3, 2025 •

edited

Loading

rc-swag commented Jan 9, 2026 •

edited

Loading