Skip to content

[framework] add window.dart API and supporting examples for regular windows #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
mattkae wants to merge 6 commits into from
Closed

[framework] add window.dart API and supporting examples for regular windows #36

mattkae wants to merge 6 commits into from

Conversation

@mattkae
Copy link

@mattkae mattkae commented Feb 28, 2025 •
edited
Loading

Design doc: https://docs.google.com/document/d/1eQG-IS7r4_S9_h50MY_hSGwUVtgSTRSLzu7MLzPNd2Y/edit?tab=t.0

To test

  1. Build the engine
  2. Then run the multi window reference application: 
    cd examples/multi_window_ref_app/
flutter run --debug --local-engine-src-path <PATH_TO_ENGINE_SRC> --local-engine host_debug_unopt --local-engine-hist host_debug_unopt .\lib\main.dart --enable-multi-window

Don't forget the --enable-multi-window flag or it will not work

What's new?

Framework

  • Created a new library called window.dart

  • Exposed the following symbols in window.dart:

    enum WindowArchetype {...}
enum WindowState {...}
class WindowController {...}
class RegularWindowController extends WindowController {...}
class RegularWindow extends StatefulWidget {...}

  • Added the ability to create regular windows using the RegularWindowController and display them in the widget tree using the RegularWindow

  • Added window_test.dart unit tests for all of the above functionality

  • Added a new example examples/multi_window_ref_app which provides a test application for creating regular windows

Pre-launch Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
  • I signed the [CLA].
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is [test-exempt].
  • I followed the [breaking change policy] and added [Data Driven Fixes] where supported.
  • All existing and new tests are passing.

@mattkae mattkae changed the title Revert "Revert all API changes to the framework" [framework] add window.dart API and support examples for regular windows Feb 28, 2025
@mattkae mattkae changed the title [framework] add window.dart API and support examples for regular windows [framework] add window.dart API and supporting examples for regular windows Feb 28, 2025
@mattkae mattkae mentioned this pull request Feb 28, 2025
Closed
9 tasks
mattkae and others added 4 commits February 28, 2025 19:15
@mattkae
Revert "Revert all API changes to the framework"
5fa2cb1 
This reverts commit 1070b86.
@hbatagelo
Update reference app to ensure root views of regular windows remain i…
c8154c8 
…n the same view collection
@mattkae
Update reference app to ensure root views of regular windows remain i…
4e6b248 
…n the same view collection (#38)

This PR updates the reference app so that the root view of a regular
window stays in the topmost view collection instead of being anchored to
the view of the main window. This ensures that the `FocusTraversalGroup`
of the root view is a child of the root focus scope rather than a nested
scope.

Why does this matter? Because it fixes an issue where focus sometimes
switches back and forth indefinitely between two regular windows.
Specifically, the issue occurs when switching focus from a root view A
to a root view B while B's focus scope is nested in A's focus scope.
When the user activates the top-level window with root view B and the
focus goes to B, A's `View::_scopeFocusChangeListener` detects that the
focused scope does not match the newly focused view (B) and requests a
focus change back to A. However, when A regains focus, B's
`View::_scopeFocusChangeListener` then notices that B is not focused
while its scope node is (since it's inside A's scope) and requests a
focus change to B, restarting the loop.
@mattkae
Merge branch 'foundation' into foundation-plus-framework
42b489a
@mattkae mattkae mentioned this pull request Mar 11, 2025
Merged
9 tasks
github-merge-queue bot pushed a commit to flutter/flutter that referenced this pull request Mar 20, 2025
@mattkae
(#112207) Adding view_id parameter to DispatchSemanticsAction and U…
885bd4a 
…pdateSemantics (#164577)

fixes #112207

## What's new?
- Added a `view_id` on `UpdateSemantics`
- Added a `view_id` on `DispatchSemanticsAction`
- Piped the `view_id` all over creation
- Updated tests for these actions across the different platforms
- Added `FlutterEngineSendSemanticsAction` to the embedder API in order
to not break `FlutterEngineDispatchSemanticsAction`
- Using this view ID properly on the Windows platform (see
`engine/src/flutter/shell/platform/windows/flutter_windows_engine.cc`)

## How to test
1. Checkout
[foundation-plus-framework](canonical#36)
from canonical/flutter
2. Merge this branch into it
3. Enable the "Narrator" screen reader on windows
4. Run the Multi window reference app (see
[PR](canonical#36) for details)
5. Open up another window, and note that the right buttons and things
are being highlighted, as the screenreader would expect 🎉

## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
github-merge-queue bot pushed a commit to flutter/flutter that referenced this pull request Mar 20, 2025
@mattkae
(#112207) Adding view_id parameter to DispatchSemanticsAction and U…
554c814 
…pdateSemantics (#164577)

fixes #112207

## What's new?
- Added a `view_id` on `UpdateSemantics`
- Added a `view_id` on `DispatchSemanticsAction`
- Piped the `view_id` all over creation
- Updated tests for these actions across the different platforms
- Added `FlutterEngineSendSemanticsAction` to the embedder API in order
to not break `FlutterEngineDispatchSemanticsAction`
- Using this view ID properly on the Windows platform (see
`engine/src/flutter/shell/platform/windows/flutter_windows_engine.cc`)

## How to test
1. Checkout
[foundation-plus-framework](canonical#36)
from canonical/flutter
2. Merge this branch into it
3. Enable the "Narrator" screen reader on windows
4. Run the Multi window reference app (see
[PR](canonical#36) for details)
5. Open up another window, and note that the right buttons and things
are being highlighted, as the screenreader would expect 🎉

## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
@mattkae mattkae closed this May 22, 2025
zhangyuang pushed a commit to zhangyuang/flutter-fork that referenced this pull request Jun 9, 2025
@mattkae
(flutter#112207) Adding view_id parameter to DispatchSemanticsActio…
3f355a6 
…n and UpdateSemantics (flutter#164577)

fixes flutter#112207

## What's new?
- Added a `view_id` on `UpdateSemantics`
- Added a `view_id` on `DispatchSemanticsAction`
- Piped the `view_id` all over creation
- Updated tests for these actions across the different platforms
- Added `FlutterEngineSendSemanticsAction` to the embedder API in order
to not break `FlutterEngineDispatchSemanticsAction`
- Using this view ID properly on the Windows platform (see
`engine/src/flutter/shell/platform/windows/flutter_windows_engine.cc`)

## How to test
1. Checkout
[foundation-plus-framework](canonical#36)
from canonical/flutter
2. Merge this branch into it
3. Enable the "Narrator" screen reader on windows
4. Run the Multi window reference app (see
[PR](canonical#36) for details)
5. Open up another window, and note that the right buttons and things
are being highlighted, as the screenreader would expect 🎉

## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
romanejaquez pushed a commit to romanejaquez/flutter that referenced this pull request Aug 14, 2025
@mattkae @romanejaquez
(flutter#112207) Adding view_id parameter to DispatchSemanticsActio…
74d549a 
…n and UpdateSemantics (flutter#164577)

fixes flutter#112207

## What's new?
- Added a `view_id` on `UpdateSemantics`
- Added a `view_id` on `DispatchSemanticsAction`
- Piped the `view_id` all over creation
- Updated tests for these actions across the different platforms
- Added `FlutterEngineSendSemanticsAction` to the embedder API in order
to not break `FlutterEngineDispatchSemanticsAction`
- Using this view ID properly on the Windows platform (see
`engine/src/flutter/shell/platform/windows/flutter_windows_engine.cc`)

## How to test
1. Checkout
[foundation-plus-framework](canonical#36)
from canonical/flutter
2. Merge this branch into it
3. Enable the "Narrator" screen reader on windows
4. Run the Multi window reference app (see
[PR](canonical#36) for details)
5. Open up another window, and note that the right buttons and things
are being highlighted, as the screenreader would expect 🎉

## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mattkae @hbatagelo