Window
The window module provides comprehensive functions for managing application windows, including opening, closing, resizing, and styling windows.
Creating Windows
pub fn open(settings: Settings) -> (Id, Task<Id>)
Id on completion.
pub fn close<T>(id: Id) -> Task<T>
Id.
Window Queries
Getting Window IDs
pub fn oldest() -> Task<Option<Id>>
Id of the oldest window.
pub fn latest() -> Task<Option<Id>>
Id of the most recently created window.
pub fn raw_id(id: Id) -> Task<u64>
Size and Position
pub fn size(id: Id) -> Task<Size>
pub fn position(id: Id) -> Task<Option<Point>>
pub fn scale_factor(id: Id) -> Task<f32>
pub fn monitor_size(id: Id) -> Task<Option<Size>>
Window State
pub fn is_maximized(id: Id) -> Task<bool>
pub fn is_minimized(id: Id) -> Task<Option<bool>>
None on Wayland.
pub fn mode(id: Id) -> Task<Mode>
Mode of the window (windowed, fullscreen, etc.).
Window Manipulation
Positioning
pub fn move_to<T>(id: Id, position: Point) -> Task<T>
pub fn drag<T>(id: Id) -> Task<T>
There’s no guarantee this will work unless the left mouse button was pressed immediately before calling this function.
pub fn drag_resize<T>(id: Id, direction: Direction) -> Task<T>
Sizing
pub fn resize<T>(id: Id, new_size: Size) -> Task<T>
pub fn set_min_size<T>(id: Id, size: Option<Size>) -> Task<T>
pub fn set_max_size<T>(id: Id, size: Option<Size>) -> Task<T>
pub fn set_resizable<T>(id: Id, resizable: bool) -> Task<T>
pub fn set_resize_increments<T>(id: Id, increments: Option<Size>) -> Task<T>
Window State Control
pub fn maximize<T>(id: Id, maximized: bool) -> Task<T>
pub fn minimize<T>(id: Id, minimized: bool) -> Task<T>
pub fn toggle_maximize<T>(id: Id) -> Task<T>
pub fn set_mode<T>(id: Id, mode: Mode) -> Task<T>
Appearance
pub fn toggle_decorations<T>(id: Id) -> Task<T>
pub fn set_icon<T>(id: Id, icon: Icon) -> Task<T>
pub fn set_level<T>(id: Id, level: Level) -> Task<T>
Focus and Attention
pub fn gain_focus<T>(id: Id) -> Task<T>
This steals input focus from other applications. Only use when certain that’s what the user wants, as focus stealing causes an extremely disruptive user experience.
pub fn request_user_attention<T>(
id: Id,
user_attention: Option<UserAttention>,
) -> Task<T>
None has no effect. On X11 and Wayland, requests must be manually cleared.
Advanced
pub fn show_system_menu<T>(id: Id) -> Task<T>
pub fn screenshot(id: Id) -> Task<Screenshot>
pub fn enable_mouse_passthrough<T>(id: Id) -> Task<T>
pub fn disable_mouse_passthrough<T>(id: Id) -> Task<T>
pub fn run<T>(id: Id, f: impl FnOnce(&dyn Window) -> T + Send + 'static) -> Task<T>
where
T: Send + 'static,
If the window closes before this call is processed, the callback will not be run.
pub fn allow_automatic_tabbing<T>(enabled: bool) -> Task<T>
Subscriptions
Frame Updates
pub fn frames() -> Subscription<Instant>
Window Events
pub fn events() -> Subscription<(Id, Event)>
pub fn open_events() -> Subscription<Id>
Event::Opened occurrences.
pub fn close_events() -> Subscription<Id>
Event::Closed occurrences.
pub fn resize_events() -> Subscription<(Id, Size)>
Event::Resized occurrences.
pub fn close_requests() -> Subscription<Id>
Event::CloseRequested occurrences (when user clicks the close button).
Examples
Opening a new window
use iced::window::{self, Settings};
enum Message {
OpenWindow,
WindowOpened(window::Id),
}
fn update(state: &mut State, message: Message) -> Task<Message> {
match message {
Message::OpenWindow => {
let (id, task) = window::open(Settings {
size: Size::new(800.0, 600.0),
position: Position::Centered,
..Default::default()
});
state.new_window_id = id;
task.map(Message::WindowOpened)
}
Message::WindowOpened(id) => {
println!("Window opened: {:?}", id);
Task::none()
}
}
}
Resizing a window
use iced::window;
fn update(state: &mut State, message: Message) -> Task<Message> {
match message {
Message::ResizeWindow => {
window::resize(state.window_id, Size::new(1024.0, 768.0))
}
_ => Task::none(),
}
}
Subscribing to window resize events
use iced::{Subscription, window};
enum Message {
WindowResized { id: window::Id, size: Size },
}
fn subscription(state: &State) -> Subscription<Message> {
window::resize_events()
.map(|(id, size)| Message::WindowResized { id, size })
}
Taking a screenshot
use iced::window;
enum Message {
TakeScreenshot,
ScreenshotTaken(window::Screenshot),
}
fn update(state: &mut State, message: Message) -> Task<Message> {
match message {
Message::TakeScreenshot => {
window::screenshot(state.window_id)
.map(Message::ScreenshotTaken)
}
Message::ScreenshotTaken(screenshot) => {
// Save screenshot
Task::none()
}
}
}
See Also
