diff options
author | 2023-01-31 04:04:29 +0100 | |
---|---|---|
committer | 2023-01-31 04:53:00 +0100 | |
commit | ecc5bfaeff6503e9e0752035c5e0c94c5a5263a2 (patch) | |
tree | 946936f8311545dd42799f21d652ca01efd3a64c | |
parent | 8c753192f82989fec5b5b506f62a8b17bf41f55a (diff) | |
download | iced-ecc5bfaeff6503e9e0752035c5e0c94c5a5263a2.tar.gz iced-ecc5bfaeff6503e9e0752035c5e0c94c5a5263a2.tar.bz2 iced-ecc5bfaeff6503e9e0752035c5e0c94c5a5263a2.zip |
Improve consistency of `window::Action`
-rw-r--r-- | native/src/window/action.rs | 17 | ||||
-rw-r--r-- | winit/src/application.rs | 2 | ||||
-rw-r--r-- | winit/src/window.rs | 10 |
3 files changed, 15 insertions, 14 deletions
diff --git a/native/src/window/action.rs b/native/src/window/action.rs index 525434e4..d277649b 100644 --- a/native/src/window/action.rs +++ b/native/src/window/action.rs @@ -33,18 +33,19 @@ pub enum Action<T> { /// The new logical y location of the window y: i32, }, - /// Set the [`Mode`] of the window. - SetMode(Mode), + /// Change the [`Mode`] of the window. + ChangeMode(Mode), /// Fetch the current [`Mode`] of the window. FetchMode(Box<dyn FnOnce(Mode) -> T + 'static>), - /// Sets the window to maximized or back + /// Toggle the window to maximized or back ToggleMaximize, - /// Toggles whether window has decorations + /// Toggle whether window has decorations. + /// /// ## Platform-specific /// - **X11:** Not implemented. /// - **Web:** Unsupported. ToggleDecorations, - /// Requests user attention to the window, this has no effect if the application + /// Request user attention to the window, this has no effect if the application /// is already focused. How requesting for user attention manifests is platform dependent, /// see [`UserAttentionType`] for details. /// @@ -58,7 +59,7 @@ pub enum Action<T> { /// - **X11:** Requests for user attention must be manually cleared. /// - **Wayland:** Requires `xdg_activation_v1` protocol, `None` has no effect. RequestUserAttention(Option<UserAttention>), - /// Brings the window to the front and sets input focus. Has no effect if the window is + /// Bring the window to the front and sets input focus. Has no effect if the window is /// already in focus, minimized, or not visible. /// /// This method steals input focus from other applications. Do not use this method unless @@ -87,7 +88,7 @@ impl<T> Action<T> { Self::Maximize(bool) => Action::Maximize(bool), Self::Minimize(bool) => Action::Minimize(bool), Self::Move { x, y } => Action::Move { x, y }, - Self::SetMode(mode) => Action::SetMode(mode), + Self::ChangeMode(mode) => Action::ChangeMode(mode), Self::FetchMode(o) => Action::FetchMode(Box::new(move |s| f(o(s)))), Self::ToggleMaximize => Action::ToggleMaximize, Self::ToggleDecorations => Action::ToggleDecorations, @@ -113,7 +114,7 @@ impl<T> fmt::Debug for Action<T> { Self::Move { x, y } => { write!(f, "Action::Move {{ x: {x}, y: {y} }}") } - Self::SetMode(mode) => write!(f, "Action::SetMode({mode:?})"), + Self::ChangeMode(mode) => write!(f, "Action::SetMode({mode:?})"), Self::FetchMode(_) => write!(f, "Action::FetchMode"), Self::ToggleMaximize => write!(f, "Action::ToggleMaximize"), Self::ToggleDecorations => write!(f, "Action::ToggleDecorations"), diff --git a/winit/src/application.rs b/winit/src/application.rs index 8c841533..c1836ed9 100644 --- a/winit/src/application.rs +++ b/winit/src/application.rs @@ -749,7 +749,7 @@ pub fn run_command<A, E>( y, }); } - window::Action::SetMode(mode) => { + window::Action::ChangeMode(mode) => { window.set_visible(conversion::visible(mode)); window.set_fullscreen(conversion::fullscreen( window.primary_monitor(), diff --git a/winit/src/window.rs b/winit/src/window.rs index 2306bdf1..0685c87c 100644 --- a/winit/src/window.rs +++ b/winit/src/window.rs @@ -22,12 +22,12 @@ pub fn resize<Message>(width: u32, height: u32) -> Command<Message> { })) } -/// Sets the window to maximized or back. +/// Maximizes the window. pub fn maximize<Message>(value: bool) -> Command<Message> { Command::single(command::Action::Window(window::Action::Maximize(value))) } -/// Set the window to minimized or back. +/// Minimes the window. pub fn minimize<Message>(value: bool) -> Command<Message> { Command::single(command::Action::Window(window::Action::Minimize(value))) } @@ -38,11 +38,11 @@ pub fn move_to<Message>(x: i32, y: i32) -> Command<Message> { } /// Sets the [`Mode`] of the window. -pub fn set_mode<Message>(mode: Mode) -> Command<Message> { - Command::single(command::Action::Window(window::Action::SetMode(mode))) +pub fn change_mode<Message>(mode: Mode) -> Command<Message> { + Command::single(command::Action::Window(window::Action::ChangeMode(mode))) } -/// Sets the window to maximized or back. +/// Toggles the window to maximized or back. pub fn toggle_maximize<Message>() -> Command<Message> { Command::single(command::Action::Window(window::Action::ToggleMaximize)) } |