Fix documentation for file drag and drop #5328
Merged
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
|
Preview available at https://egui-pr-preview.github.io/pr/5328-drag-and-drop-docs |
emilk
added
docs and examples
hacknus
pushed a commit
to hacknus/egui
that referenced
this pull request
Oct 30, 2024
<!-- Please read the "Making a PR" section of [`CONTRIBUTING.md`](https://github.com/emilk/egui/blob/master/CONTRIBUTING.md) before opening a Pull Request! * Keep your PR:s small and focused. * The PR title is what ends up in the changelog, so make it descriptive! * If applicable, add a screenshot or gif. * If it is a non-trivial addition, consider adding a demo for it to `egui_demo_lib`, or a new example. * Do NOT open PR:s from your `master` branch, as that makes it hard for maintainers to test and add commits to your PR. * Remember to run `cargo fmt` and `cargo clippy`. * Open the PR as a draft until you have self-reviewed it and run `./scripts/check.sh`. * When you have addressed a PR comment, mark it as resolved. Please be patient! I will review your PR, but my time is limited! --> The `RawInput::dropped_files` documentation referred to `NativeOptions`, but the `drag_and_drop` option was moved to `ViewportBuilder` and is now enabled by default. Note that drag-and-drop is not *explicitly* enabled by default here, but rather is enabled by default in winit. We only override winit's default if the API consumer specifies it. It might be a good idea in general to provide explicit defaults for everything in `ViewportBuilder` so we're not relying on winit's behavior, but that's best left for another PR. * Closes N/A * [x] I have followed the instructions in the PR template
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.
The
RawInput::dropped_filesdocumentation referred toNativeOptions, but thedrag_and_dropoption was moved toViewportBuilderand is now enabled by default.Note that drag-and-drop is not explicitly enabled by default here, but rather is enabled by default in winit. We only override winit's default if the API consumer specifies it. It might be a good idea in general to provide explicit defaults for everything in
ViewportBuilderso we're not relying on winit's behavior, but that's best left for another PR.