leyoda/winit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Tidy up "platform-specifc" doc sections (#2356)

Browse source 
* Tidy up "platform-specific" doc sections

* Unrelated grammatical fix

* Subjective improvements
This commit is contained in:
Markus Røyset 2022-07-20 13:45:12 +02:00 • committed by GitHub
parent f09259f6de
commit 5397b53e04
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 34 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/event.rs
View file

@ -277,17 +277,19 @@ pub enum WindowEvent<'a> {
/// The keyboard modifiers have changed.
///
/// Platform-specific behavior:
/// - **Web**: This API is currently unimplemented on the web. This isn't by design - it's an
/// ## Platform-specific
///
/// - **Web:** This API is currently unimplemented on the web. This isn't by design - it's an
/// issue, and it should get fixed - but it's the current state of the API.
ModifiersChanged(ModifiersState),
/// An event from input method.
/// An event from an input method.
///
/// **Note :** You have to explicitly enable this event using [`Window::set_ime_allowed`].
/// **Note:** You have to explicitly enable this event using [`Window::set_ime_allowed`].
///
/// Platform-specific behavior:
/// - **iOS / Android / Web :** Unsupported.
/// ## Platform-specific
///
/// - **iOS / Android / Web:** Unsupported.
Ime(Ime),
/// The cursor has moved on the window.
@ -370,6 +372,8 @@ pub enum WindowEvent<'a> {
/// Applications might wish to react to this to change the theme of the content of the window
/// when the system changes the window theme.
///
/// ## Platform-specific
///
/// At the moment this is only supported on Windows.
ThemeChanged(Theme),
@ -379,7 +383,7 @@ pub enum WindowEvent<'a> {
/// minimised, set invisible, or fully occluded by another window.
///
/// Platform-specific behavior:
/// - **iOS / Android / Web / Wayland / Windows :** Unsupported.
/// - **iOS / Android / Web / Wayland / Windows:** Unsupported.
Occluded(bool),
}