New feature: Accept native parent window handle and implement glue code to major platform abstraction frameworks #136
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
btzy
force-pushed
the
nativewindow
branch
21 times, most recently
from
a633967 to
ce8c00d
Compare
btzy
force-pushed
the
nativewindow
branch
5 times, most recently
from
4586369 to
edcfc7c
Compare
btzy
force-pushed
the
nativewindow
branch
10 times, most recently
from
32112a1 to
7c1cf3b
Compare
btzy
force-pushed
the
nativewindow
branch
10 times, most recently
from
a973ad6 to
9ca8a7b
Compare
btzy
force-pushed
the
nativewindow
branch
2 times, most recently
from
35ae5d6 to
401f455
Compare
This is necessary for platforms to present the dialog properly, e.g. ensuring that the dialog never goes behind the parent window.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On at least Windows and Linux (both GTK and Portal), the dialog misbehaves in a noticeable way when the parent window handle is not passed to the underlying platform-specific API. The macOS (Cocoa) backend guesses the parent from the key window (the window receiving keyboard events). The parent window handle, however, is platform-specific (and on Linux, also specific to the windowing system) (e.g.
HWNDon Windows,NSWindow*on macOS,Windowon X11,wl_surface*on Wayland), which means that NFDe necessarily needs to expose an API that is not fully platform-agnostic, if it is to allow users to pass it the parent window handle.This is acceptable if the user is not using any platform abstraction framework (e.g. SDL2 or GLFW), since the user must already be writing platform-specific code.
However, a significant benefit of NFDe is realised when the user also uses a platform abstraction framework, as it allows them to write code in a platform-agnostic manner throughout their codebase. It would be unwieldy if they had to write platform-specific code to glue NFDe to their framework.
Platform abstraction frameworks typically define their own type to represent a window handle (e.g
SDL_Window*on SDL2,GLFWwindow*on GLFW), and it is possible to get the native window handle from it (via platform-specific APIs). By implementing the conversions from the window type as an optional component of NFDe, it frees the user from having to write their own glue code.This PR adds a new argument to all the main APIs (OpenFile, OpenFileMultiple, SaveFile, PickFolder, PickFolderMultiple) to take a native window handle, which can be a Windows, macOS, or X11 handle. Wayland is not yet supported as it looks complicated and documentation is scant, though it will probably be implemented in the future. This PR also implements framework-specific window handle conversion functions in optional separate headers.
Resolves #90.
Resolves #126.