Improve updates of Win32 window's WindowStyles #12752

emmauss · 2023-09-01T12:44:17Z

What does the pull request do?

Improves updates of window styles, reducing the number of calls to SetWindowLong needed to apply an update to a window.
This change computes the required window styles from the window properties, ensuring only the styles we requested persists.
To allow user to set custom styles, 2 new apis are provided;
Win32SpecificOptions.SetWindowStylesCallback : called after the window styles are computed.
Win32SpecificOptions.SetWndProcHookCallback: called as part of the window message handling.

What is the current behavior?

Window styles are updated from the current window styles. Then the relevant styles are toggled and window is updated. Since the styles aren't validated with the window properties, and only when the properties change will their styles be toggled, the window styles can have other unexpected styles set by external applications, and window behavior may differ from normal.

What is the updated/expected behavior with this PR?

How was the solution implemented (if it's not obvious)?

Checklist

Added unit tests (if possible)?
Added XML documentation to any related classes?
Consider submitting a PR to https://github.com/AvaloniaUI/Documentation with user documentation

Breaking changes

Obsoletions / Deprecations

Fixed issues

avaloniaui-team · 2023-09-01T13:08:05Z

You can test this PR using the following package version. 11.0.999-cibuild0039094-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

MrJul · 2023-09-01T14:05:49Z

the window styles can have other unexpected styles set by external applications

What about other styles set by the application itself? There are very valid usages of SetWindowLong with GWL_EXSTYLE (WS_EX_TRANSPARENT or WS_EX_NOACTIVATE come to mind), which will be broken by such a change (or even prevent porting existing apps).

I've definitely seen such usages being suggested as workarounds in some Avalonia issues/discussions, which is fine imo, as Avalonia isn't expected to handle every platform-specific property.

emmauss · 2023-09-04T11:33:51Z

the window styles can have other unexpected styles set by external applications

What about other styles set by the application itself? There are very valid usages of SetWindowLong with GWL_EXSTYLE (WS_EX_TRANSPARENT or WS_EX_NOACTIVATE come to mind), which will be broken by such a change (or even prevent porting existing apps).

I've definitely seen such usages being suggested as workarounds in some Avalonia issues/discussions, which is fine imo, as Avalonia isn't expected to handle every platform-specific property.

Thanks for your feedback. Win32SpecificOptions.SetWindowStylesCallback has been added to allow setting custom style and exStyle flags

avaloniaui-team · 2023-09-04T11:56:24Z

You can test this PR using the following package version. 11.0.999-cibuild0039177-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

MrJul · 2023-09-04T12:26:43Z

Thanks for your feedback. Win32SpecificOptions.SetWindowStylesCallback has been added to allow setting custom style and exStyle flags

Thank you!

Any reason why Win32SpecificOptions isn't in Avalonia.Win32? (It's so specific I don't think it belongs in the general platform.)
Moving it to Win32 will also simplify the code by removing the extra interface and directly check for Win32.WindowImpl.

emmauss · 2023-09-04T14:52:13Z

Thanks for your feedback. Win32SpecificOptions.SetWindowStylesCallback has been added to allow setting custom style and exStyle flags

Thank you!

Any reason why Win32SpecificOptions isn't in Avalonia.Win32? (It's so specific I don't think it belongs in the general platform.) Moving it to Win32 will also simplify the code by removing the extra interface and directly check for Win32.WindowImpl.

Having it in controls would allow using the api in the shared ui projects, especially in the multiplatform templates.

avaloniaui-team · 2023-09-04T15:01:26Z

You can test this PR using the following package version. 11.0.999-cibuild0039195-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

Gillibald · 2023-09-04T15:17:53Z

Thanks for your feedback. Win32SpecificOptions.SetWindowStylesCallback has been added to allow setting custom style and exStyle flags

Thank you!
Any reason why Win32SpecificOptions isn't in Avalonia.Win32? (It's so specific I don't think it belongs in the general platform.) Moving it to Win32 will also simplify the code by removing the extra interface and directly check for Win32.WindowImpl.

Having it in controls would allow using the api in the shared ui projects, especially in the multiplatform templates.

This is platform-specific code. So I don't see why we wanted to add that to some x-plat template.

avaloniaui-team · 2023-09-04T16:15:07Z

You can test this PR using the following package version. 11.0.999-cibuild0039205-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

avaloniaui-team · 2023-09-12T16:20:57Z

You can test this PR using the following package version. 11.0.999-cibuild0039400-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

avaloniaui-team · 2023-09-13T13:10:13Z

You can test this PR using the following package version. 11.0.999-cibuild0039454-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

grokys · 2023-09-14T09:06:44Z

This is platform-specific code. So I don't see why we wanted to add that to some x-plat template.

I've not been involved in this feature, so I may be wrong but this is my layman's understanding:

Win32SpecificOptions is defined in Avalonia.Controls to support cross-platform code like this:

if (OperatingSystem.IsWindows())
    Win32SpecificOptions.SetWindowStylesCallback(foo);

When running on non-win32 this code will be stripped, and no reference to Avalonia.Win32 or Avalonia.Desktop is necessary. However if Win32SpecificOptions were defined in Avalonia.Win32 then either:

All platforms would need a reference to Avalonia.Win32/Avalonia.Desktop whether they actually need to or not
You'd need to conditionally compile and conditionally reference Avalonia.Desktop

@kekekeks @emmauss please correct me if I'm wrong.

kekekeks · 2023-09-14T09:12:56Z

Even if it won't be stripped (e. g. you define it from XAML), the code in Win32SpecificOptions is so small it won't really make a difference.
The problem with having it in Avalonia.Win32 is not just trimming, but bringing the entire backend package when targeting mobile/wasm. It has various build problems.

avaloniaui-team · 2023-09-14T09:39:57Z

You can test this PR using the following package version. 11.0.999-cibuild0039523-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

MrJul · 2023-09-14T10:46:38Z

I'd argue that if an user needs such a low level platform specific hook, they're either targeting a single platform, or already have conditional compilation/references in place.

Here, the API is simple: it's only two delegates with primitive arguments only. For the sake of the argument, imagine we need some heavy Win32-specific structs instead: personally, I'd find it really weird to have them in the base platform.

MrJul · 2023-09-14T11:44:32Z

src/Avalonia.Controls/Platform/IWin32OptionsTopLevelImpl.cs

+    [PrivateApi]
+    public interface IWin32OptionsTopLevelImpl : ITopLevelImpl
+    {
+        public delegate (uint style, uint exStyle) CustomWindowStylesCallback(uint style, uint exStyle);


Those delegates are still accessible despite the PrivateApi but I don't know whether it's the expected behavior or not. All PrivateApi members and nested types normally become internal in the ref assemblies, but delegates aren't affected currently. @kekekeks

Callback delegate should be declared in Win32SpecificOptions

MrJul · 2023-09-14T11:47:15Z

src/Avalonia.Controls/Platform/Win32SpecificOptions.cs

+
+namespace Avalonia.Controls.Platform
+{
+    [Unstable]


I'm not sure Unstable is the right attribute here: both SetXxxCallback methods will be marked as obsolete, effectively discouraging or preventing their usage.

Also, the class should probably be made static to prevent inheritance.

Class is now static, and Unstable attribute removed

kekekeks · 2023-09-14T14:23:17Z

they're either targeting a single platform, or already have conditional compilation/references in place.

That's not the case for 3rd-party controls that are providing a custom window class. Since our desktop platforms are built for net6.0 it's not possible to conditionally reference Avalonia.Win32 from a 3rd party nuget package.

avaloniaui-team · 2023-09-19T09:03:28Z

You can test this PR using the following package version. 11.0.999-cibuild0039654-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

avaloniaui-team · 2023-09-20T11:29:28Z

You can test this PR using the following package version. 11.0.999-cibuild0039698-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

avaloniaui-team · 2023-09-26T11:40:55Z

You can test this PR using the following package version. 11.0.999-cibuild0040024-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

avaloniaui-team · 2023-09-26T12:31:53Z

You can test this PR using the following package version. 11.0.999-cibuild0040030-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

…vant styles

avaloniaui-team · 2023-09-26T13:22:04Z

You can test this PR using the following package version. 11.0.999-cibuild0040034-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

billhenn · 2023-12-06T20:35:39Z

Hello, I've noticed that in recent master builds, a no-chrome Window opened in Windows 11 is no longer the size indicated by the Window.Width/Height properties, but it is a decent amount larger. This is for windows with Window.ExtendClientAreaChromeHints set to NoChrome and Window.ExtendClientAreaToDecorationsHint set to true in the window's constructor code-behind.

Previous to this PR, a <Window Width="1024" Height="768"> window with the ExtendClientAreaChromeHints and ExtendClientAreaToDecorationsHint set as above properties would open at 1024x768 size. Now after the PR, it opens at 1040x807 size on my system.

A window with those properties set is only showing a single pixel border all around. My guess is the result SHOULD be that the window opens at 1026x770 (1024x768 plus a pixel on each side) instead of 1040x807 since there is no chrome and Avalonia seems to try and get the window's content to the Window.Width/Height size. The size the no-chrome window now opens at is far too large.

Prior to the PR, the no-chrome window's overall size was the exact Window.Width/Height size, which was close at least to what it should be.

Can this PR be updated to get it working properly for no-chrome windows?

emmauss requested a review from kekekeks September 1, 2023 12:44

emmauss changed the title ~~Inprove updates of Win32 window's WindowStyles~~ Improve updates of Win32 window's WindowStyles Sep 1, 2023

emmauss force-pushed the win32_window_styles_cleanup branch from 9eb971e to 286dc6d Compare September 4, 2023 12:11

emmauss force-pushed the win32_window_styles_cleanup branch 3 times, most recently from a343cdb to 5fc0bc5 Compare September 4, 2023 14:37

emmauss force-pushed the win32_window_styles_cleanup branch from c31f662 to bd95c0e Compare September 4, 2023 15:54

emmauss force-pushed the win32_window_styles_cleanup branch from bd95c0e to 869b5c5 Compare September 12, 2023 15:57

emmauss force-pushed the win32_window_styles_cleanup branch from 869b5c5 to 4a5498e Compare September 13, 2023 12:21

MrJul reviewed Sep 14, 2023

View reviewed changes

emmauss force-pushed the win32_window_styles_cleanup branch from cf636b7 to 787b5ce Compare September 20, 2023 11:04

maxkatz6 approved these changes Sep 25, 2023

View reviewed changes

emmauss force-pushed the win32_window_styles_cleanup branch from 7fd8a09 to 5ead24a Compare September 26, 2023 12:06

emmauss added 15 commits September 26, 2023 12:57

compute win32 window styles from properties, instead of toggling rele…

251726c

…vant styles

save client rect early, before swithing to full screen

42f87b9

add callbacks for window style and wndproc

5eecd53

move new options class to Avalonia.Controls

f0e16c1

use toplevel instance to set the callbacks instead

dbc7680

remove redundant casting

c231615

call wndproc callback before the default handler

977a484

remove unused using

f4c9d66

ensure window state when decorations changed

881f52c

move win32 specific delegates

2d1150a

make Win32SpecificOptions static

500edf5

fix build

dd1db17

replace Set callbacks with Add/Remove callbacks

86d33a3

fix docs

7cfdb00

only recreate styles when the change isn't caused by a fullscreen update

0705446

emmauss force-pushed the win32_window_styles_cleanup branch from 5ead24a to 0705446 Compare September 26, 2023 12:57

maxkatz6 added this pull request to the merge queue Sep 26, 2023

Merged via the queue into master with commit d171353 Sep 26, 2023

maxkatz6 deleted the win32_window_styles_cleanup branch September 26, 2023 19:14

grokys mentioned this pull request Oct 2, 2023

Fixed an issue that windows empty Win32 window would show unnecessarily #13097

Merged

3 tasks

emmauss mentioned this pull request Dec 7, 2023

Win32 - Fix client size update when window is opened with extended client area #13865

Merged

3 tasks

maxkatz6 added the feature label Feb 16, 2024

ltetak mentioned this pull request Mar 1, 2024

CanResize does not work on Windows #14782

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve updates of Win32 window's WindowStyles #12752

Improve updates of Win32 window's WindowStyles #12752

emmauss commented Sep 1, 2023 •

edited

Loading

avaloniaui-team commented Sep 1, 2023

MrJul commented Sep 1, 2023

emmauss commented Sep 4, 2023

avaloniaui-team commented Sep 4, 2023

MrJul commented Sep 4, 2023

emmauss commented Sep 4, 2023

avaloniaui-team commented Sep 4, 2023

Gillibald commented Sep 4, 2023

avaloniaui-team commented Sep 4, 2023

avaloniaui-team commented Sep 12, 2023

avaloniaui-team commented Sep 13, 2023

grokys commented Sep 14, 2023

kekekeks commented Sep 14, 2023 •

edited

Loading

avaloniaui-team commented Sep 14, 2023

MrJul commented Sep 14, 2023

MrJul Sep 14, 2023

kekekeks Sep 14, 2023

emmauss Sep 20, 2023

MrJul Sep 14, 2023

emmauss Sep 20, 2023

kekekeks commented Sep 14, 2023

avaloniaui-team commented Sep 19, 2023

avaloniaui-team commented Sep 20, 2023

avaloniaui-team commented Sep 26, 2023

avaloniaui-team commented Sep 26, 2023

avaloniaui-team commented Sep 26, 2023

billhenn commented Dec 6, 2023

Improve updates of Win32 window's WindowStyles #12752

Improve updates of Win32 window's WindowStyles #12752

Conversation

emmauss commented Sep 1, 2023 • edited Loading

What does the pull request do?

What is the current behavior?

What is the updated/expected behavior with this PR?

How was the solution implemented (if it's not obvious)?

Checklist

Breaking changes

Obsoletions / Deprecations

Fixed issues

avaloniaui-team commented Sep 1, 2023

MrJul commented Sep 1, 2023

emmauss commented Sep 4, 2023

avaloniaui-team commented Sep 4, 2023

MrJul commented Sep 4, 2023

emmauss commented Sep 4, 2023

avaloniaui-team commented Sep 4, 2023

Gillibald commented Sep 4, 2023

avaloniaui-team commented Sep 4, 2023

avaloniaui-team commented Sep 12, 2023

avaloniaui-team commented Sep 13, 2023

grokys commented Sep 14, 2023

kekekeks commented Sep 14, 2023 • edited Loading

avaloniaui-team commented Sep 14, 2023

MrJul commented Sep 14, 2023

MrJul Sep 14, 2023

Choose a reason for hiding this comment

kekekeks Sep 14, 2023

Choose a reason for hiding this comment

emmauss Sep 20, 2023

Choose a reason for hiding this comment

MrJul Sep 14, 2023

Choose a reason for hiding this comment

emmauss Sep 20, 2023

Choose a reason for hiding this comment

kekekeks commented Sep 14, 2023

avaloniaui-team commented Sep 19, 2023

avaloniaui-team commented Sep 20, 2023

avaloniaui-team commented Sep 26, 2023

avaloniaui-team commented Sep 26, 2023

avaloniaui-team commented Sep 26, 2023

billhenn commented Dec 6, 2023

emmauss commented Sep 1, 2023 •

edited

Loading

kekekeks commented Sep 14, 2023 •

edited

Loading