summaryrefslogtreecommitdiffstats
path: root/runtime/src/window
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2023-03-05 06:35:20 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2023-03-05 06:35:20 +0100
commit99e0a71504456976ba88040f5d1d3bbc347694ea (patch)
treea228c064fd3847831ff8072aa9375dc59db47f47 /runtime/src/window
parent8af69be47e88896b3c5f70174db609eee0c67971 (diff)
downloadiced-99e0a71504456976ba88040f5d1d3bbc347694ea.tar.gz
iced-99e0a71504456976ba88040f5d1d3bbc347694ea.tar.bz2
iced-99e0a71504456976ba88040f5d1d3bbc347694ea.zip
Rename `iced_native` to `iced_runtime`
Diffstat (limited to 'runtime/src/window')
-rw-r--r--runtime/src/window/action.rs147
1 files changed, 147 insertions, 0 deletions
diff --git a/runtime/src/window/action.rs b/runtime/src/window/action.rs
new file mode 100644
index 00000000..c1dbd84f
--- /dev/null
+++ b/runtime/src/window/action.rs
@@ -0,0 +1,147 @@
+use crate::core::window::{Mode, UserAttention};
+use crate::futures::MaybeSend;
+
+use std::fmt;
+
+/// An operation to be performed on some window.
+pub enum Action<T> {
+ /// Closes the current window and exits the application.
+ Close,
+ /// Moves the window with the left mouse button until the button is
+ /// released.
+ ///
+ /// There’s no guarantee that this will work unless the left mouse
+ /// button was pressed immediately before this function is called.
+ Drag,
+ /// Resize the window.
+ Resize {
+ /// The new logical width of the window
+ width: u32,
+ /// The new logical height of the window
+ height: u32,
+ },
+ /// Sets the window to maximized or back
+ Maximize(bool),
+ /// Set the window to minimized or back
+ Minimize(bool),
+ /// Move the window.
+ ///
+ /// Unsupported on Wayland.
+ Move {
+ /// The new logical x location of the window
+ x: i32,
+ /// The new logical y location of the window
+ y: i32,
+ },
+ /// Change the [`Mode`] of the window.
+ ChangeMode(Mode),
+ /// Fetch the current [`Mode`] of the window.
+ FetchMode(Box<dyn FnOnce(Mode) -> T + 'static>),
+ /// Toggle the window to maximized or back
+ ToggleMaximize,
+ /// Toggle whether window has decorations.
+ ///
+ /// ## Platform-specific
+ /// - **X11:** Not implemented.
+ /// - **Web:** Unsupported.
+ ToggleDecorations,
+ /// 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 [`UserAttention`] for details.
+ ///
+ /// Providing `None` will unset the request for user attention. Unsetting the request for
+ /// user attention might not be done automatically by the WM when the window receives input.
+ ///
+ /// ## Platform-specific
+ ///
+ /// - **iOS / Android / Web:** Unsupported.
+ /// - **macOS:** `None` has no effect.
+ /// - **X11:** Requests for user attention must be manually cleared.
+ /// - **Wayland:** Requires `xdg_activation_v1` protocol, `None` has no effect.
+ RequestUserAttention(Option<UserAttention>),
+ /// 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
+ /// you are certain that's what the user wants. Focus stealing can cause an extremely disruptive
+ /// user experience.
+ ///
+ /// ## Platform-specific
+ ///
+ /// - **Web / Wayland:** Unsupported.
+ GainFocus,
+ /// Change whether or not the window will always be on top of other windows.
+ ///
+ /// ## Platform-specific
+ ///
+ /// - **Web / Wayland:** Unsupported.
+ ChangeAlwaysOnTop(bool),
+ /// Fetch an identifier unique to the window.
+ FetchId(Box<dyn FnOnce(u64) -> T + 'static>),
+}
+
+impl<T> Action<T> {
+ /// Maps the output of a window [`Action`] using the provided closure.
+ pub fn map<A>(
+ self,
+ f: impl Fn(T) -> A + 'static + MaybeSend + Sync,
+ ) -> Action<A>
+ where
+ T: 'static,
+ {
+ match self {
+ Self::Close => Action::Close,
+ Self::Drag => Action::Drag,
+ Self::Resize { width, height } => Action::Resize { width, height },
+ Self::Maximize(maximized) => Action::Maximize(maximized),
+ Self::Minimize(minimized) => Action::Minimize(minimized),
+ Self::Move { x, y } => Action::Move { x, y },
+ 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,
+ Self::RequestUserAttention(attention_type) => {
+ Action::RequestUserAttention(attention_type)
+ }
+ Self::GainFocus => Action::GainFocus,
+ Self::ChangeAlwaysOnTop(on_top) => {
+ Action::ChangeAlwaysOnTop(on_top)
+ }
+ Self::FetchId(o) => Action::FetchId(Box::new(move |s| f(o(s)))),
+ }
+ }
+}
+
+impl<T> fmt::Debug for Action<T> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ Self::Close => write!(f, "Action::Close"),
+ Self::Drag => write!(f, "Action::Drag"),
+ Self::Resize { width, height } => write!(
+ f,
+ "Action::Resize {{ widget: {width}, height: {height} }}"
+ ),
+ Self::Maximize(maximized) => {
+ write!(f, "Action::Maximize({maximized})")
+ }
+ Self::Minimize(minimized) => {
+ write!(f, "Action::Minimize({minimized}")
+ }
+ Self::Move { x, y } => {
+ write!(f, "Action::Move {{ x: {x}, y: {y} }}")
+ }
+ 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"),
+ Self::RequestUserAttention(_) => {
+ write!(f, "Action::RequestUserAttention")
+ }
+ Self::GainFocus => write!(f, "Action::GainFocus"),
+ Self::ChangeAlwaysOnTop(on_top) => {
+ write!(f, "Action::AlwaysOnTop({on_top})")
+ }
+ Self::FetchId(_) => write!(f, "Action::FetchId"),
+ }
+ }
+}