Skip to content
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.

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

Add support for multi-window popups on Windows #56092

Closed
wants to merge 6 commits into from

Conversation

hbatagelo
Copy link
Contributor

@hbatagelo hbatagelo commented Oct 24, 2024

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

This PR is a part of a group of PRs. Going from first to last, these must be merged in the following order:

See also the corresponding framework PRs for multi-win support, starting from: flutter/flutter#157515

What's New

This pull request adds support for multi-window popups in the Windows embedder and introduces logic for positioning child windows relative to a parent view or parent window.

A new method is available in the flutter/windowing channel:

  • createPopup(Map)
    Map must contain the following key-value pairs:

    Key (String) Value
    "parent" The ID of the parent view (int)
    "size" The width and height of the popup, in logical coordinates (List<int>)
    "anchorRect" An anchor rectangle for positioning the child window (the popup) relative to the parent view. The rectangle values (left, top, width, height) are in logical coordinates, relative to the parent view (i.e., relative to the client rectangle of the parent window). If null, the child window will be positioned relative to the window frame of the parent (List<int>)
    "positionerParentAnchor" The anchor point in the anchor rectangle (WindowPositionerAnchor)
    "positionerChildAnchor" The anchor point in the window frame of the child window (WindowPositionerAnchor)
    "positionerOffset" The positioning offset as x and y displacements from the parent anchor to the child anchor (List<int>)
    "positionerConstraintAdjustment" A bitwise combination of WindowPositioner::ConstraintAdjustment, defining the adjustments to apply if the child window doesn't fit in the available space. The order of precedence is: 1) Flip, 2) Slide, 3) Resize (int)

    On success, a Map is returned with the following key-value pairs:

    Key (String) Value
    "viewId" The view ID of the window (int)
    "archetype" WindowArchetype::popup
    "size" The current size of the window (width, height), in logical coordinates (List<int>)
    "parentViewId" The view ID of the parent window (int)

    If the method fails, a PlatformException is thrown.

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 and the C++, Objective-C, Java style guides.
  • I listed at least one issue that this PR fixes in the description above.
  • I added new tests to check the change I am making or feature I am adding, or the PR is test-exempt. See testing the engine for instructions on writing and running engine tests.
  • I updated/added relevant documentation (doc comments with ///).
  • I signed the CLA.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@flutter-dashboard
Copy link

This pull request executed golden file tests, but it has not been updated in a while (20+ days). Test results from Gold expire after as many days, so this pull request will need to be updated with a fresh commit in order to get results from Gold.

@jtmcdole
Copy link
Contributor

Monorepo Migration Completed

TL;DR: Please migrate your PR to flutter/flutter

The flutter/engine repository has been migrated to the flutter/flutter repository. This PR will no longer be landed here and must be migrated. To migrate your PR to the flutter repository, please follow these steps:

  1. Create a patch for this PR:

    • Generate a patch set that represents the changes in this PR. The exact method will vary depending on your PR's history. If your PR includes merges, it is highly recommended that you rebase it onto main first.
    git format-patch $START_COMMIT..$END_COMMIT --stdout > combined_patch.patch
  2. Update the patch for the new engine location:

    • The engine source code now resides in the engine/ subdirectory within the flutter/flutter repository. You'll need to update the file paths in your patch accordingly.
    # Insert the `engine/` prefix to all paths. Note that this usage works on macOS and
    # linux versions of sed.
    sed -i.bak \
    -e 's|^\(diff --git a/\)\(.*\) b/\(.*\)|\1engine/\2 b/engine/src/flutter/\3|' \
    -e 's|^\(--- a/\)\(.*\)|\1engine/src/flutter/\2|' \
    -e 's|^\(\+\+\+ b/\)\(.*\)|\1engine/src/flutter/\2|' \
    combined_patch.patch
  3. Checkout and set up your Flutter development environment:

  4. Set up the engine development environment within the monorepo:

  5. Apply the patch to a new branch:

    • Create a new branch in your flutter/flutter repository.
    • Apply the updated patch to this branch:
    git apply combined_patch.patch
  6. Open a new PR:

    • Open a new PR in the flutter/flutter repository with your changes.
    • Reference this original PR in the new PR's description using flutter/engine#<PR_NUMBER>.

This is a canned message

@jtmcdole jtmcdole closed this Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants