Improve consistency of window::Action

This commit is contained in:
Héctor Ramón Jiménez 2023-01-31 04:04:29 +01:00
parent 8c753192f8
commit ecc5bfaeff
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
3 changed files with 15 additions and 14 deletions

View file

@ -33,18 +33,19 @@ pub enum Action<T> {
/// The new logical y location of the window /// The new logical y location of the window
y: i32, y: i32,
}, },
/// Set the [`Mode`] of the window. /// Change the [`Mode`] of the window.
SetMode(Mode), ChangeMode(Mode),
/// Fetch the current [`Mode`] of the window. /// Fetch the current [`Mode`] of the window.
FetchMode(Box<dyn FnOnce(Mode) -> T + 'static>), FetchMode(Box<dyn FnOnce(Mode) -> T + 'static>),
/// Sets the window to maximized or back /// Toggle the window to maximized or back
ToggleMaximize, ToggleMaximize,
/// Toggles whether window has decorations /// Toggle whether window has decorations.
///
/// ## Platform-specific /// ## Platform-specific
/// - **X11:** Not implemented. /// - **X11:** Not implemented.
/// - **Web:** Unsupported. /// - **Web:** Unsupported.
ToggleDecorations, 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, /// is already focused. How requesting for user attention manifests is platform dependent,
/// see [`UserAttentionType`] for details. /// see [`UserAttentionType`] for details.
/// ///
@ -58,7 +59,7 @@ pub enum Action<T> {
/// - **X11:** Requests for user attention must be manually cleared. /// - **X11:** Requests for user attention must be manually cleared.
/// - **Wayland:** Requires `xdg_activation_v1` protocol, `None` has no effect. /// - **Wayland:** Requires `xdg_activation_v1` protocol, `None` has no effect.
RequestUserAttention(Option<UserAttention>), 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. /// already in focus, minimized, or not visible.
/// ///
/// This method steals input focus from other applications. Do not use this method unless /// 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::Maximize(bool) => Action::Maximize(bool),
Self::Minimize(bool) => Action::Minimize(bool), Self::Minimize(bool) => Action::Minimize(bool),
Self::Move { x, y } => Action::Move { x, y }, 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::FetchMode(o) => Action::FetchMode(Box::new(move |s| f(o(s)))),
Self::ToggleMaximize => Action::ToggleMaximize, Self::ToggleMaximize => Action::ToggleMaximize,
Self::ToggleDecorations => Action::ToggleDecorations, Self::ToggleDecorations => Action::ToggleDecorations,
@ -113,7 +114,7 @@ impl<T> fmt::Debug for Action<T> {
Self::Move { x, y } => { Self::Move { x, y } => {
write!(f, "Action::Move {{ x: {x}, y: {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::FetchMode(_) => write!(f, "Action::FetchMode"),
Self::ToggleMaximize => write!(f, "Action::ToggleMaximize"), Self::ToggleMaximize => write!(f, "Action::ToggleMaximize"),
Self::ToggleDecorations => write!(f, "Action::ToggleDecorations"), Self::ToggleDecorations => write!(f, "Action::ToggleDecorations"),

View file

@ -749,7 +749,7 @@ pub fn run_command<A, E>(
y, y,
}); });
} }
window::Action::SetMode(mode) => { window::Action::ChangeMode(mode) => {
window.set_visible(conversion::visible(mode)); window.set_visible(conversion::visible(mode));
window.set_fullscreen(conversion::fullscreen( window.set_fullscreen(conversion::fullscreen(
window.primary_monitor(), window.primary_monitor(),

View file

@ -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> { pub fn maximize<Message>(value: bool) -> Command<Message> {
Command::single(command::Action::Window(window::Action::Maximize(value))) 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> { pub fn minimize<Message>(value: bool) -> Command<Message> {
Command::single(command::Action::Window(window::Action::Minimize(value))) 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. /// Sets the [`Mode`] of the window.
pub fn set_mode<Message>(mode: Mode) -> Command<Message> { pub fn change_mode<Message>(mode: Mode) -> Command<Message> {
Command::single(command::Action::Window(window::Action::SetMode(mode))) 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> { pub fn toggle_maximize<Message>() -> Command<Message> {
Command::single(command::Action::Window(window::Action::ToggleMaximize)) Command::single(command::Action::Window(window::Action::ToggleMaximize))
} }