// Copyright 2019-2023 Tauri Programme within The Commons Conservancy // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT //! The Tauri window types and functions. pub(crate) mod plugin; use http::HeaderMap; pub use tauri_runtime::window::PageLoadEvent; pub use tauri_utils::{config::Color, WindowEffect as Effect, WindowEffectState as EffectState}; use url::Url; #[cfg(target_os = "macos")] use crate::TitleBarStyle; use crate::{ app::{AppHandle, UriSchemeResponder}, command::{CommandArg, CommandItem}, event::{EmitArgs, Event, EventId}, ipc::{ CallbackFn, Invoke, InvokeBody, InvokeError, InvokeMessage, InvokeResolver, OwnedInvokeResponder, }, manager::AppManager, runtime::{ monitor::Monitor as RuntimeMonitor, webview::{WebviewAttributes, WindowBuilder as _}, window::{ dpi::{PhysicalPosition, PhysicalSize}, DetachedWindow, PendingWindow, }, Dispatch, RuntimeHandle, }, sealed::ManagerBase, sealed::RuntimeOrDispatch, utils::config::{WindowConfig, WindowEffectsConfig, WindowUrl}, EventLoopMessage, Manager, Runtime, Theme, WindowEvent, }; #[cfg(desktop)] use crate::{ menu::{ContextMenu, Menu, MenuId}, runtime::{ window::dpi::{Position, Size}, UserAttentionType, }, CursorIcon, Icon, }; use serde::Serialize; #[cfg(windows)] use windows::Win32::Foundation::HWND; use tauri_macros::default_runtime; use std::{ borrow::Cow, collections::{HashMap, HashSet}, fmt, hash::{Hash, Hasher}, path::PathBuf, sync::{Arc, Mutex}, }; pub(crate) type WebResourceRequestHandler = dyn Fn(http::Request>, &mut http::Response>) + Send + Sync; pub(crate) type NavigationHandler = dyn Fn(&Url) -> bool + Send; pub(crate) type UriSchemeProtocolHandler = Box>, UriSchemeResponder) + Send + Sync>; pub(crate) type OnPageLoad = dyn Fn(Window, PageLoadPayload<'_>) + Send + Sync + 'static; #[derive(Clone, Serialize)] struct WindowCreatedEvent { label: String, } /// The payload for the [`WindowBuilder::on_page_load`] hook. #[derive(Debug, Clone)] pub struct PageLoadPayload<'a> { pub(crate) url: &'a Url, pub(crate) event: PageLoadEvent, } impl<'a> PageLoadPayload<'a> { /// The page URL. pub fn url(&self) -> &'a Url { self.url } /// The page load event. pub fn event(&self) -> PageLoadEvent { self.event } } /// Monitor descriptor. #[derive(Debug, Clone, Serialize)] #[serde(rename_all = "camelCase")] pub struct Monitor { pub(crate) name: Option, pub(crate) size: PhysicalSize, pub(crate) position: PhysicalPosition, pub(crate) scale_factor: f64, } impl From for Monitor { fn from(monitor: RuntimeMonitor) -> Self { Self { name: monitor.name, size: monitor.size, position: monitor.position, scale_factor: monitor.scale_factor, } } } impl Monitor { /// Returns a human-readable name of the monitor. /// Returns None if the monitor doesn't exist anymore. pub fn name(&self) -> Option<&String> { self.name.as_ref() } /// Returns the monitor's resolution. pub fn size(&self) -> &PhysicalSize { &self.size } /// Returns the top-left corner position of the monitor relative to the larger full screen area. pub fn position(&self) -> &PhysicalPosition { &self.position } /// Returns the scale factor that can be used to map logical pixels to physical pixels, and vice versa. pub fn scale_factor(&self) -> f64 { self.scale_factor } } /// A builder for a webview window managed by Tauri. #[default_runtime(crate::Wry, wry)] pub struct WindowBuilder<'a, R: Runtime> { manager: Arc>, runtime: RuntimeOrDispatch<'a, R>, app_handle: AppHandle, label: String, pub(crate) window_builder: >::WindowBuilder, #[cfg(desktop)] pub(crate) menu: Option>, pub(crate) webview_attributes: WebviewAttributes, web_resource_request_handler: Option>, navigation_handler: Option>, on_page_load_handler: Option>>, #[cfg(desktop)] on_menu_event: Option>>, } impl<'a, R: Runtime> fmt::Debug for WindowBuilder<'a, R> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("WindowBuilder") .field("manager", &self.manager) .field("app_handle", &self.app_handle) .field("label", &self.label) .field("window_builder", &self.window_builder) .field("webview_attributes", &self.webview_attributes) .finish() } } impl<'a, R: Runtime> WindowBuilder<'a, R> { /// Initializes a webview window builder with the given window label and URL to load on the webview. /// /// # Known issues /// /// On Windows, this function deadlocks when used in a synchronous command, see [the Webview2 issue]. /// You should use `async` commands when creating windows. /// /// # Examples /// /// - Create a window in the setup hook: /// /// ``` /// tauri::Builder::default() /// .setup(|app| { /// let window = tauri::WindowBuilder::new(app, "label", tauri::WindowUrl::App("index.html".into())) /// .build()?; /// Ok(()) /// }); /// ``` /// /// - Create a window in a separate thread: /// /// ``` /// tauri::Builder::default() /// .setup(|app| { /// let handle = app.handle().clone(); /// std::thread::spawn(move || { /// let window = tauri::WindowBuilder::new(&handle, "label", tauri::WindowUrl::App("index.html".into())) /// .build() /// .unwrap(); /// }); /// Ok(()) /// }); /// ``` /// /// - Create a window in a command: /// /// ``` /// #[tauri::command] /// async fn create_window(app: tauri::AppHandle) { /// let window = tauri::WindowBuilder::new(&app, "label", tauri::WindowUrl::External("https://tauri.app/".parse().unwrap())) /// .build() /// .unwrap(); /// } /// ``` /// /// [the Webview2 issue]: https://github.com/tauri-apps/wry/issues/583 pub fn new, L: Into>(manager: &'a M, label: L, url: WindowUrl) -> Self { let runtime = manager.runtime(); let app_handle = manager.app_handle().clone(); Self { manager: manager.manager_owned(), runtime, app_handle, label: label.into(), window_builder: >::WindowBuilder::new(), #[cfg(desktop)] menu: None, webview_attributes: WebviewAttributes::new(url), web_resource_request_handler: None, navigation_handler: None, on_page_load_handler: None, #[cfg(desktop)] on_menu_event: None, } } /// Initializes a webview window builder from a window config from tauri.conf.json. /// Keep in mind that you can't create 2 windows with the same `label` so make sure /// that the initial window was closed or change the label of the new `WindowBuilder`. /// /// # Known issues /// /// On Windows, this function deadlocks when used in a synchronous command, see [the Webview2 issue]. /// You should use `async` commands when creating windows. /// /// # Examples /// /// - Create a window in a command: /// /// ``` /// #[tauri::command] /// async fn reopen_window(app: tauri::AppHandle) { /// let window = tauri::WindowBuilder::from_config(&app, app.config().tauri.windows.get(0).unwrap().clone()) /// .build() /// .unwrap(); /// } /// ``` /// /// [the Webview2 issue]: https://github.com/tauri-apps/wry/issues/583 pub fn from_config>(manager: &'a M, config: WindowConfig) -> Self { let builder = Self { manager: manager.manager_owned(), runtime: manager.runtime(), app_handle: manager.app_handle().clone(), label: config.label.clone(), webview_attributes: WebviewAttributes::from(&config), window_builder: >::WindowBuilder::with_config( config, ), web_resource_request_handler: None, #[cfg(desktop)] menu: None, navigation_handler: None, #[cfg(desktop)] on_menu_event: None, on_page_load_handler: None, }; builder } /// Defines a closure to be executed when the webview makes an HTTP request for a web resource, allowing you to modify the response. /// /// Currently only implemented for the `tauri` URI protocol. /// /// **NOTE:** Currently this is **not** executed when using external URLs such as a development server, /// but it might be implemented in the future. **Always** check the request URL. /// /// # Examples /// /// ```rust,no_run /// use tauri::{ /// utils::config::{Csp, CspDirectiveSources, WindowUrl}, /// window::WindowBuilder, /// }; /// use http::header::HeaderValue; /// use std::collections::HashMap; /// tauri::Builder::default() /// .setup(|app| { /// WindowBuilder::new(app, "core", WindowUrl::App("index.html".into())) /// .on_web_resource_request(|request, response| { /// if request.uri().scheme_str() == Some("tauri") { /// // if we have a CSP header, Tauri is loading an HTML file /// // for this example, let's dynamically change the CSP /// if let Some(csp) = response.headers_mut().get_mut("Content-Security-Policy") { /// // use the tauri helper to parse the CSP policy to a map /// let mut csp_map: HashMap = Csp::Policy(csp.to_str().unwrap().to_string()).into(); /// csp_map.entry("script-src".to_string()).or_insert_with(Default::default).push("'unsafe-inline'"); /// // use the tauri helper to get a CSP string from the map /// let csp_string = Csp::from(csp_map).to_string(); /// *csp = HeaderValue::from_str(&csp_string).unwrap(); /// } /// } /// }) /// .build()?; /// Ok(()) /// }); /// ``` pub fn on_web_resource_request< F: Fn(http::Request>, &mut http::Response>) + Send + Sync + 'static, >( mut self, f: F, ) -> Self { self.web_resource_request_handler.replace(Box::new(f)); self } /// Defines a closure to be executed when the webview navigates to a URL. Returning `false` cancels the navigation. /// /// # Examples /// /// ```rust,no_run /// use tauri::{ /// utils::config::{Csp, CspDirectiveSources, WindowUrl}, /// window::WindowBuilder, /// }; /// use http::header::HeaderValue; /// use std::collections::HashMap; /// tauri::Builder::default() /// .setup(|app| { /// WindowBuilder::new(app, "core", WindowUrl::App("index.html".into())) /// .on_navigation(|url| { /// // allow the production URL or localhost on dev /// url.scheme() == "tauri" || (cfg!(dev) && url.host_str() == Some("localhost")) /// }) /// .build()?; /// Ok(()) /// }); /// ``` pub fn on_navigation bool + Send + 'static>(mut self, f: F) -> Self { self.navigation_handler.replace(Box::new(f)); self } /// Defines a closure to be executed when a page load event is triggered. /// The event can be either [`PageLoadEvent::Started`] if the page has started loading /// or [`PageLoadEvent::Finished`] when the page finishes loading. /// /// # Examples /// /// ```rust,no_run /// use tauri::{ /// utils::config::{Csp, CspDirectiveSources, WindowUrl}, /// window::{PageLoadEvent, WindowBuilder}, /// }; /// use http::header::HeaderValue; /// use std::collections::HashMap; /// tauri::Builder::default() /// .setup(|app| { /// WindowBuilder::new(app, "core", WindowUrl::App("index.html".into())) /// .on_page_load(|window, payload| { /// match payload.event() { /// PageLoadEvent::Started => { /// println!("{} finished loading", payload.url()); /// } /// PageLoadEvent::Finished => { /// println!("{} finished loading", payload.url()); /// } /// } /// }) /// .build()?; /// Ok(()) /// }); /// ``` pub fn on_page_load, PageLoadPayload<'_>) + Send + Sync + 'static>( mut self, f: F, ) -> Self { self.on_page_load_handler.replace(Box::new(f)); self } /// Registers a global menu event listener. /// /// Note that this handler is called for any menu event, /// whether it is coming from this window, another window or from the tray icon menu. /// /// Also note that this handler will not be called if /// the window used to register it was closed. /// /// # Examples /// ``` /// use tauri::menu::{Menu, Submenu, MenuItem}; /// tauri::Builder::default() /// .setup(|app| { /// let handle = app.handle(); /// let save_menu_item = MenuItem::new(handle, "Save", true, None); /// let menu = Menu::with_items(handle, &[ /// &Submenu::with_items(handle, "File", true, &[ /// &save_menu_item, /// ])?, /// ])?; /// let window = tauri::WindowBuilder::new(app, "editor", tauri::WindowUrl::default()) /// .menu(menu) /// .on_menu_event(move |window, event| { /// if event.id == save_menu_item.id() { /// // save menu item /// } /// }) /// .build() /// .unwrap(); /// /// Ok(()) /// }); /// ``` #[cfg(desktop)] pub fn on_menu_event, crate::menu::MenuEvent) + Send + Sync + 'static>( mut self, f: F, ) -> Self { self.on_menu_event.replace(Box::new(f)); self } /// Creates a new webview window. pub fn build(mut self) -> crate::Result> { let mut pending = PendingWindow::new( self.window_builder.clone(), self.webview_attributes.clone(), self.label.clone(), )?; pending.navigation_handler = self.navigation_handler.take(); pending.web_resource_request_handler = self.web_resource_request_handler.take(); if let Some(on_page_load_handler) = self.on_page_load_handler.take() { let label = pending.label.clone(); let manager = self.app_handle.manager.clone(); pending .on_page_load_handler .replace(Box::new(move |url, event| { if let Some(w) = manager.get_window(&label) { on_page_load_handler(w, PageLoadPayload { url: &url, event }); } })); } let labels = self.manager.window.labels().into_iter().collect::>(); let pending = self .manager .window .prepare_window(self.app_handle.clone(), pending, &labels)?; #[cfg(desktop)] let window_menu = { let is_app_wide = self.menu.is_none(); self .menu .or_else(|| self.app_handle.menu()) .map(|menu| WindowMenu { is_app_wide, menu }) }; #[cfg(desktop)] let handler = self .manager .menu .prepare_window_menu_creation_handler(window_menu.as_ref()); #[cfg(not(desktop))] #[allow(clippy::type_complexity)] let handler: Option) + Send>> = None; let window_effects = pending.webview_attributes.window_effects.clone(); let window = match &mut self.runtime { RuntimeOrDispatch::Runtime(runtime) => runtime.create_window(pending, handler), RuntimeOrDispatch::RuntimeHandle(handle) => handle.create_window(pending, handler), RuntimeOrDispatch::Dispatch(dispatcher) => dispatcher.create_window(pending, handler), } .map(|window| { self.manager.window.attach_window( self.app_handle.clone(), window, #[cfg(desktop)] window_menu, ) })?; #[cfg(desktop)] if let Some(handler) = self.on_menu_event { window.on_menu_event(handler); } if let Some(effects) = window_effects { crate::vibrancy::set_window_effects(&window, Some(effects))?; } self.manager.window.eval_script_all(format!( "window.__TAURI_INTERNALS__.metadata.windows = {window_labels_array}.map(function (label) {{ return {{ label: label }} }})", window_labels_array = serde_json::to_string(&self.manager.window.labels())?, ))?; self.manager.emit_filter( "tauri://window-created", None, Some(WindowCreatedEvent { label: window.label().into(), }), |w| w != &window, )?; Ok(window) } } /// Desktop APIs. #[cfg(desktop)] impl<'a, R: Runtime> WindowBuilder<'a, R> { /// Sets the menu for the window. #[must_use] pub fn menu(mut self, menu: Menu) -> Self { self.menu.replace(menu); self } /// Show window in the center of the screen. #[must_use] pub fn center(mut self) -> Self { self.window_builder = self.window_builder.center(); self } /// The initial position of the window's. #[must_use] pub fn position(mut self, x: f64, y: f64) -> Self { self.window_builder = self.window_builder.position(x, y); self } /// Window size. #[must_use] pub fn inner_size(mut self, width: f64, height: f64) -> Self { self.window_builder = self.window_builder.inner_size(width, height); self } /// Window min inner size. #[must_use] pub fn min_inner_size(mut self, min_width: f64, min_height: f64) -> Self { self.window_builder = self.window_builder.min_inner_size(min_width, min_height); self } /// Window max inner size. #[must_use] pub fn max_inner_size(mut self, max_width: f64, max_height: f64) -> Self { self.window_builder = self.window_builder.max_inner_size(max_width, max_height); self } /// Whether the window is resizable or not. /// When resizable is set to false, native window's maximize button is automatically disabled. #[must_use] pub fn resizable(mut self, resizable: bool) -> Self { self.window_builder = self.window_builder.resizable(resizable); self } /// Whether the window's native maximize button is enabled or not. /// If resizable is set to false, this setting is ignored. /// /// ## Platform-specific /// /// - **macOS:** Disables the "zoom" button in the window titlebar, which is also used to enter fullscreen mode. /// - **Linux / iOS / Android:** Unsupported. #[must_use] pub fn maximizable(mut self, maximizable: bool) -> Self { self.window_builder = self.window_builder.maximizable(maximizable); self } /// Whether the window's native minimize button is enabled or not. /// /// ## Platform-specific /// /// - **Linux / iOS / Android:** Unsupported. #[must_use] pub fn minimizable(mut self, minimizable: bool) -> Self { self.window_builder = self.window_builder.minimizable(minimizable); self } /// Whether the window's native close button is enabled or not. /// /// ## Platform-specific /// /// - **Linux:** "GTK+ will do its best to convince the window manager not to show a close button. /// Depending on the system, this function may not have any effect when called on a window that is already visible" /// - **iOS / Android:** Unsupported. #[must_use] pub fn closable(mut self, closable: bool) -> Self { self.window_builder = self.window_builder.closable(closable); self } /// The title of the window in the title bar. #[must_use] pub fn title>(mut self, title: S) -> Self { self.window_builder = self.window_builder.title(title); self } /// Whether to start the window in fullscreen or not. #[must_use] pub fn fullscreen(mut self, fullscreen: bool) -> Self { self.window_builder = self.window_builder.fullscreen(fullscreen); self } /// Sets the window to be initially focused. #[must_use] #[deprecated( since = "1.2.0", note = "The window is automatically focused by default. This function Will be removed in 2.0.0. Use `focused` instead." )] pub fn focus(mut self) -> Self { self.window_builder = self.window_builder.focused(true); self } /// Whether the window will be initially focused or not. #[must_use] pub fn focused(mut self, focused: bool) -> Self { self.window_builder = self.window_builder.focused(focused); self } /// Whether the window should be maximized upon creation. #[must_use] pub fn maximized(mut self, maximized: bool) -> Self { self.window_builder = self.window_builder.maximized(maximized); self } /// Whether the window should be immediately visible upon creation. #[must_use] pub fn visible(mut self, visible: bool) -> Self { self.window_builder = self.window_builder.visible(visible); self } /// Forces a theme or uses the system settings if None was provided. /// /// ## Platform-specific /// /// - **macOS**: Only supported on macOS 10.14+. #[must_use] pub fn theme(mut self, theme: Option) -> Self { self.window_builder = self.window_builder.theme(theme); self } /// Whether the window should be transparent. If this is true, writing colors /// with alpha values different than `1.0` will produce a transparent window. #[cfg(any(not(target_os = "macos"), feature = "macos-private-api"))] #[cfg_attr( docsrs, doc(cfg(any(not(target_os = "macos"), feature = "macos-private-api"))) )] #[must_use] pub fn transparent(mut self, transparent: bool) -> Self { self.window_builder = self.window_builder.transparent(transparent); self } /// Whether the window should have borders and bars. #[must_use] pub fn decorations(mut self, decorations: bool) -> Self { self.window_builder = self.window_builder.decorations(decorations); self } /// Whether the window should always be below other windows. #[must_use] pub fn always_on_bottom(mut self, always_on_bottom: bool) -> Self { self.window_builder = self.window_builder.always_on_bottom(always_on_bottom); self } /// Whether the window should always be on top of other windows. #[must_use] pub fn always_on_top(mut self, always_on_top: bool) -> Self { self.window_builder = self.window_builder.always_on_top(always_on_top); self } /// Whether the window will be visible on all workspaces or virtual desktops. #[must_use] pub fn visible_on_all_workspaces(mut self, visible_on_all_workspaces: bool) -> Self { self.window_builder = self .window_builder .visible_on_all_workspaces(visible_on_all_workspaces); self } /// Prevents the window contents from being captured by other apps. #[must_use] pub fn content_protected(mut self, protected: bool) -> Self { self.window_builder = self.window_builder.content_protected(protected); self } /// Sets the window icon. pub fn icon(mut self, icon: Icon) -> crate::Result { self.window_builder = self.window_builder.icon(icon.try_into()?)?; Ok(self) } /// Sets whether or not the window icon should be hidden from the taskbar. /// /// ## Platform-specific /// /// - **macOS**: Unsupported. #[must_use] pub fn skip_taskbar(mut self, skip: bool) -> Self { self.window_builder = self.window_builder.skip_taskbar(skip); self } /// Sets whether or not the window has shadow. /// /// ## Platform-specific /// /// - **Windows:** /// - `false` has no effect on decorated window, shadows are always ON. /// - `true` will make ndecorated window have a 1px white border, /// and on Windows 11, it will have a rounded corners. /// - **Linux:** Unsupported. #[must_use] pub fn shadow(mut self, enable: bool) -> Self { self.window_builder = self.window_builder.shadow(enable); self } /// Sets a parent to the window to be created. /// /// A child window has the WS_CHILD style and is confined to the client area of its parent window. /// /// For more information, see #[cfg(windows)] #[must_use] pub fn parent_window(mut self, parent: HWND) -> Self { self.window_builder = self.window_builder.parent_window(parent); self } /// Sets a parent to the window to be created. #[cfg(target_os = "macos")] #[must_use] pub fn parent_window(mut self, parent: *mut std::ffi::c_void) -> Self { self.window_builder = self.window_builder.parent_window(parent); self } /// Set an owner to the window to be created. /// /// From MSDN: /// - An owned window is always above its owner in the z-order. /// - The system automatically destroys an owned window when its owner is destroyed. /// - An owned window is hidden when its owner is minimized. /// /// For more information, see #[cfg(windows)] #[must_use] pub fn owner_window(mut self, owner: HWND) -> Self { self.window_builder = self.window_builder.owner_window(owner); self } /// Sets the [`TitleBarStyle`]. #[cfg(target_os = "macos")] #[must_use] pub fn title_bar_style(mut self, style: TitleBarStyle) -> Self { self.window_builder = self.window_builder.title_bar_style(style); self } /// Hide the window title. #[cfg(target_os = "macos")] #[must_use] pub fn hidden_title(mut self, hidden: bool) -> Self { self.window_builder = self.window_builder.hidden_title(hidden); self } /// Defines the window [tabbing identifier] for macOS. /// /// Windows with matching tabbing identifiers will be grouped together. /// If the tabbing identifier is not set, automatic tabbing will be disabled. /// /// [tabbing identifier]: #[cfg(target_os = "macos")] #[must_use] pub fn tabbing_identifier(mut self, identifier: &str) -> Self { self.window_builder = self.window_builder.tabbing_identifier(identifier); self } /// Sets whether clicking an inactive window also clicks through to the webview. #[must_use] pub fn accept_first_mouse(mut self, accept: bool) -> Self { self.webview_attributes.accept_first_mouse = accept; self } /// Sets window effects. /// /// Requires the window to be transparent. /// /// ## Platform-specific: /// /// - **Windows**: If using decorations or shadows, you may want to try this workaround /// - **Linux**: Unsupported pub fn effects(mut self, effects: WindowEffectsConfig) -> Self { self.webview_attributes = self.webview_attributes.window_effects(effects); self } } /// Webview attributes. impl<'a, R: Runtime> WindowBuilder<'a, R> { /// Adds the provided JavaScript to a list of scripts that should be run after the global object has been created, /// but before the HTML document has been parsed and before any other script included by the HTML document is run. /// /// Since it runs on all top-level document and child frame page navigations, /// it's recommended to check the `window.location` to guard your script from running on unexpected origins. /// /// # Examples /// /// ```rust /// use tauri::{WindowBuilder, Runtime}; /// /// const INIT_SCRIPT: &str = r#" /// if (window.location.origin === 'https://tauri.app') { /// console.log("hello world from js init script"); /// /// window.__MY_CUSTOM_PROPERTY__ = { foo: 'bar' }; /// } /// "#; /// /// fn main() { /// tauri::Builder::default() /// .setup(|app| { /// let window = tauri::WindowBuilder::new(app, "label", tauri::WindowUrl::App("index.html".into())) /// .initialization_script(INIT_SCRIPT) /// .build()?; /// Ok(()) /// }); /// } /// ``` #[must_use] pub fn initialization_script(mut self, script: &str) -> Self { self .webview_attributes .initialization_scripts .push(script.to_string()); self } /// Set the user agent for the webview #[must_use] pub fn user_agent(mut self, user_agent: &str) -> Self { self.webview_attributes.user_agent = Some(user_agent.to_string()); self } /// Set additional arguments for the webview. /// /// ## Platform-specific /// /// - **macOS / Linux / Android / iOS**: Unsupported. /// /// ## Warning /// /// By default wry passes `--disable-features=msWebOOUI,msPdfOOUI,msSmartScreenProtection` /// so if you use this method, you also need to disable these components by yourself if you want. #[must_use] pub fn additional_browser_args(mut self, additional_args: &str) -> Self { self.webview_attributes.additional_browser_args = Some(additional_args.to_string()); self } /// Data directory for the webview. #[must_use] pub fn data_directory(mut self, data_directory: PathBuf) -> Self { self .webview_attributes .data_directory .replace(data_directory); self } /// Disables the file drop handler. This is required to use drag and drop APIs on the front end on Windows. #[must_use] pub fn disable_file_drop_handler(mut self) -> Self { self.webview_attributes.file_drop_handler_enabled = false; self } /// Enables clipboard access for the page rendered on **Linux** and **Windows**. /// /// **macOS** doesn't provide such method and is always enabled by default, /// but you still need to add menu item accelerators to use shortcuts. #[must_use] pub fn enable_clipboard_access(mut self) -> Self { self.webview_attributes.clipboard = true; self } /// Enable or disable incognito mode for the WebView.. /// /// ## Platform-specific: /// /// **Android**: Unsupported. #[must_use] pub fn incognito(mut self, incognito: bool) -> Self { self.webview_attributes.incognito = incognito; self } } /// Key for a JS event listener. #[derive(Debug, Clone, PartialEq, Eq, Hash)] struct JsEventListenerKey { /// The associated window label. pub window_label: Option, /// The event name. pub event: String, } /// The IPC invoke request. #[derive(Debug)] pub struct InvokeRequest { /// The invoke command. pub cmd: String, /// The success callback. pub callback: CallbackFn, /// The error callback. pub error: CallbackFn, /// The body of the request. pub body: InvokeBody, /// The request headers. pub headers: HeaderMap, } /// A wrapper struct to hold the window menu state /// and whether it is global per-app or specific to this window. #[cfg(desktop)] pub(crate) struct WindowMenu { pub(crate) is_app_wide: bool, pub(crate) menu: Menu, } // TODO: expand these docs since this is a pretty important type /// A webview window managed by Tauri. /// /// This type also implements [`Manager`] which allows you to manage other windows attached to /// the same application. #[default_runtime(crate::Wry, wry)] pub struct Window { /// The webview window created by the runtime. pub(crate) window: DetachedWindow, /// The manager to associate this webview window with. pub(crate) manager: Arc>, pub(crate) app_handle: AppHandle, js_event_listeners: Arc>>>, // The menu set for this window #[cfg(desktop)] pub(crate) menu: Arc>>>, } impl std::fmt::Debug for Window { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("Window") .field("window", &self.window) .field("manager", &self.manager) .field("app_handle", &self.app_handle) .field("js_event_listeners", &self.js_event_listeners) .finish() } } unsafe impl raw_window_handle::HasRawWindowHandle for Window { fn raw_window_handle(&self) -> raw_window_handle::RawWindowHandle { self.window.dispatcher.raw_window_handle().unwrap() } } impl Clone for Window { fn clone(&self) -> Self { Self { window: self.window.clone(), manager: self.manager.clone(), app_handle: self.app_handle.clone(), js_event_listeners: self.js_event_listeners.clone(), #[cfg(desktop)] menu: self.menu.clone(), } } } impl Hash for Window { /// Only use the [`Window`]'s label to represent its hash. fn hash(&self, state: &mut H) { self.window.label.hash(state) } } impl Eq for Window {} impl PartialEq for Window { /// Only use the [`Window`]'s label to compare equality. fn eq(&self, other: &Self) -> bool { self.window.label.eq(&other.window.label) } } impl Manager for Window { fn emit(&self, event: &str, payload: S) -> crate::Result<()> { self.manager().emit(event, Some(self.label()), payload)?; Ok(()) } fn emit_to( &self, label: &str, event: &str, payload: S, ) -> crate::Result<()> { self .manager() .emit_filter(event, Some(self.label()), payload, |w| label == w.label()) } fn emit_filter(&self, event: &str, payload: S, filter: F) -> crate::Result<()> where S: Serialize + Clone, F: Fn(&Window) -> bool, { self .manager() .emit_filter(event, Some(self.label()), payload, filter) } } impl ManagerBase for Window { fn manager(&self) -> &AppManager { &self.manager } fn manager_owned(&self) -> Arc> { self.manager.clone() } fn runtime(&self) -> RuntimeOrDispatch<'_, R> { RuntimeOrDispatch::Dispatch(self.dispatcher()) } fn managed_app_handle(&self) -> &AppHandle { &self.app_handle } } impl<'de, R: Runtime> CommandArg<'de, R> for Window { /// Grabs the [`Window`] from the [`CommandItem`]. This will never fail. fn from_command(command: CommandItem<'de, R>) -> Result { Ok(command.message.window()) } } /// The platform webview handle. Accessed with [`Window#method.with_webview`]; #[cfg(feature = "wry")] #[cfg_attr(docsrs, doc(cfg(feature = "wry")))] pub struct PlatformWebview(tauri_runtime_wry::Webview); #[cfg(feature = "wry")] impl PlatformWebview { /// Returns [`webkit2gtk::WebView`] handle. #[cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] #[cfg_attr( docsrs, doc(cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))) )] pub fn inner(&self) -> std::rc::Rc { self.0.clone() } /// Returns the WebView2 controller. #[cfg(windows)] #[cfg_attr(docsrs, doc(cfg(windows)))] pub fn controller( &self, ) -> webview2_com::Microsoft::Web::WebView2::Win32::ICoreWebView2Controller { self.0.controller.clone() } /// Returns the [WKWebView] handle. /// /// [WKWebView]: https://developer.apple.com/documentation/webkit/wkwebview #[cfg(any(target_os = "macos", target_os = "ios"))] #[cfg_attr(docsrs, doc(cfg(any(target_os = "macos", target_os = "ios"))))] pub fn inner(&self) -> cocoa::base::id { self.0.webview } /// Returns WKWebView [controller] handle. /// /// [controller]: https://developer.apple.com/documentation/webkit/wkusercontentcontroller #[cfg(any(target_os = "macos", target_os = "ios"))] #[cfg_attr(docsrs, doc(cfg(any(target_os = "macos", target_os = "ios"))))] pub fn controller(&self) -> cocoa::base::id { self.0.manager } /// Returns [NSWindow] associated with the WKWebView webview. /// /// [NSWindow]: https://developer.apple.com/documentation/appkit/nswindow #[cfg(target_os = "macos")] #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))] pub fn ns_window(&self) -> cocoa::base::id { self.0.ns_window } /// Returns [UIViewController] used by the WKWebView webview NSWindow. /// /// [UIViewController]: https://developer.apple.com/documentation/uikit/uiviewcontroller #[cfg(target_os = "ios")] #[cfg_attr(docsrs, doc(cfg(target_os = "ios")))] pub fn view_controller(&self) -> cocoa::base::id { self.0.view_controller } /// Returns handle for JNI execution. #[cfg(target_os = "android")] pub fn jni_handle(&self) -> tauri_runtime_wry::wry::webview::JniHandle { self.0 } } /// Base window functions. impl Window { /// Create a new window that is attached to the manager. pub(crate) fn new( manager: Arc>, window: DetachedWindow, app_handle: AppHandle, #[cfg(desktop)] menu: Option>, ) -> Self { Self { window, manager, app_handle, js_event_listeners: Default::default(), #[cfg(desktop)] menu: Arc::new(Mutex::new(menu)), } } /// Initializes a webview window builder with the given window label and URL to load on the webview. /// /// Data URLs are only supported with the `window-data-url` feature flag. pub fn builder<'a, M: Manager, L: Into>( manager: &'a M, label: L, url: WindowUrl, ) -> WindowBuilder<'a, R> { WindowBuilder::<'a, R>::new(manager, label.into(), url) } /// The current window's dispatcher. pub(crate) fn dispatcher(&self) -> R::Dispatcher { self.window.dispatcher.clone() } /// Runs the given closure on the main thread. pub fn run_on_main_thread(&self, f: F) -> crate::Result<()> { self .window .dispatcher .run_on_main_thread(f) .map_err(Into::into) } /// The label of this window. pub fn label(&self) -> &str { &self.window.label } /// Registers a window event listener. pub fn on_window_event(&self, f: F) { self .window .dispatcher .on_window_event(move |event| f(&event.clone().into())); } /// Executes a closure, providing it with the webview handle that is specific to the current platform. /// /// The closure is executed on the main thread. /// /// # Examples /// /// ```rust,no_run /// #[cfg(target_os = "macos")] /// #[macro_use] /// extern crate objc; /// use tauri::Manager; /// /// fn main() { /// tauri::Builder::default() /// .setup(|app| { /// let main_window = app.get_window("main").unwrap(); /// main_window.with_webview(|webview| { /// #[cfg(target_os = "linux")] /// { /// // see https://docs.rs/webkit2gtk/2.0.0/webkit2gtk/struct.WebView.html /// // and https://docs.rs/webkit2gtk/2.0.0/webkit2gtk/trait.WebViewExt.html /// use webkit2gtk::WebViewExt; /// webview.inner().set_zoom_level(4.); /// } /// /// #[cfg(windows)] /// unsafe { /// // see https://docs.rs/webview2-com/0.19.1/webview2_com/Microsoft/Web/WebView2/Win32/struct.ICoreWebView2Controller.html /// webview.controller().SetZoomFactor(4.).unwrap(); /// } /// /// #[cfg(target_os = "macos")] /// unsafe { /// let () = msg_send![webview.inner(), setPageZoom: 4.]; /// let () = msg_send![webview.controller(), removeAllUserScripts]; /// let bg_color: cocoa::base::id = msg_send![class!(NSColor), colorWithDeviceRed:0.5 green:0.2 blue:0.4 alpha:1.]; /// let () = msg_send![webview.ns_window(), setBackgroundColor: bg_color]; /// } /// /// #[cfg(target_os = "android")] /// { /// use jni::objects::JValue; /// webview.jni_handle().exec(|env, _, webview| { /// env.call_method(webview, "zoomBy", "(F)V", &[JValue::Float(4.)]).unwrap(); /// }) /// } /// }); /// Ok(()) /// }); /// } /// ``` #[cfg(feature = "wry")] #[cfg_attr(docsrs, doc(feature = "wry"))] pub fn with_webview( &self, f: F, ) -> crate::Result<()> { self .window .dispatcher .with_webview(|w| f(PlatformWebview(*w.downcast().unwrap()))) .map_err(Into::into) } } /// Menu APIs #[cfg(desktop)] impl Window { /// Registers a global menu event listener. /// /// Note that this handler is called for any menu event, /// whether it is coming from this window, another window or from the tray icon menu. /// /// Also note that this handler will not be called if /// the window used to register it was closed. /// /// # Examples /// ``` /// use tauri::menu::{Menu, Submenu, MenuItem}; /// tauri::Builder::default() /// .setup(|app| { /// let handle = app.handle(); /// let save_menu_item = MenuItem::new(handle, "Save", true, None); /// let menu = Menu::with_items(handle, &[ /// &Submenu::with_items(handle, "File", true, &[ /// &save_menu_item, /// ])?, /// ])?; /// let window = tauri::WindowBuilder::new(app, "editor", tauri::WindowUrl::default()) /// .menu(menu) /// .build() /// .unwrap(); /// /// window.on_menu_event(move |window, event| { /// if event.id == save_menu_item.id() { /// // save menu item /// } /// }); /// /// Ok(()) /// }); /// ``` pub fn on_menu_event, crate::menu::MenuEvent) + Send + Sync + 'static>( &self, f: F, ) { self .manager .menu .event_listeners .lock() .unwrap() .insert(self.label().to_string(), Box::new(f)); } pub(crate) fn menu_lock(&self) -> std::sync::MutexGuard<'_, Option>> { self.menu.lock().expect("poisoned window") } #[cfg_attr(target_os = "macos", allow(dead_code))] pub(crate) fn has_app_wide_menu(&self) -> bool { self .menu_lock() .as_ref() .map(|m| m.is_app_wide) .unwrap_or(false) } #[cfg_attr(target_os = "macos", allow(dead_code))] pub(crate) fn is_menu_in_use>(&self, id: &I) -> bool { self .menu_lock() .as_ref() .map(|m| id.eq(m.menu.id())) .unwrap_or(false) } /// Returns this window menu . pub fn menu(&self) -> Option> { self.menu_lock().as_ref().map(|m| m.menu.clone()) } /// Sets the window menu and returns the previous one. /// /// ## Platform-specific: /// /// - **macOS:** Unsupported. The menu on macOS is app-wide and not specific to one /// window, if you need to set it, use [`AppHandle::set_menu`] instead. #[cfg_attr(target_os = "macos", allow(unused_variables))] pub fn set_menu(&self, menu: Menu) -> crate::Result>> { let prev_menu = self.remove_menu()?; self.manager.menu.insert_menu_into_stash(&menu); let window = self.clone(); let menu_ = menu.clone(); self.run_on_main_thread(move || { #[cfg(windows)] if let Ok(hwnd) = window.hwnd() { let _ = menu_.inner().init_for_hwnd(hwnd.0); } #[cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] if let (Ok(gtk_window), Ok(gtk_box)) = (window.gtk_window(), window.default_vbox()) { let _ = menu_ .inner() .init_for_gtk_window(>k_window, Some(>k_box)); } })?; self.menu_lock().replace(WindowMenu { is_app_wide: false, menu, }); Ok(prev_menu) } /// Removes the window menu and returns it. /// /// ## Platform-specific: /// /// - **macOS:** Unsupported. The menu on macOS is app-wide and not specific to one /// window, if you need to remove it, use [`AppHandle::remove_menu`] instead. pub fn remove_menu(&self) -> crate::Result>> { let current_menu = self.menu_lock().as_ref().map(|m| m.menu.clone()); // remove from the window #[cfg_attr(target_os = "macos", allow(unused_variables))] if let Some(menu) = current_menu { let window = self.clone(); self.run_on_main_thread(move || { #[cfg(windows)] if let Ok(hwnd) = window.hwnd() { let _ = menu.inner().remove_for_hwnd(hwnd.0); } #[cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] if let Ok(gtk_window) = window.gtk_window() { let _ = menu.inner().remove_for_gtk_window(>k_window); } })?; } let prev_menu = self.menu_lock().take().map(|m| m.menu); self .manager .remove_menu_from_stash_by_id(prev_menu.as_ref().map(|m| m.id())); Ok(prev_menu) } /// Hides the window menu. pub fn hide_menu(&self) -> crate::Result<()> { // remove from the window #[cfg_attr(target_os = "macos", allow(unused_variables))] if let Some(window_menu) = &*self.menu_lock() { let window = self.clone(); let menu_ = window_menu.menu.clone(); self.run_on_main_thread(move || { #[cfg(windows)] if let Ok(hwnd) = window.hwnd() { let _ = menu_.inner().hide_for_hwnd(hwnd.0); } #[cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] if let Ok(gtk_window) = window.gtk_window() { let _ = menu_.inner().hide_for_gtk_window(>k_window); } })?; } Ok(()) } /// Shows the window menu. pub fn show_menu(&self) -> crate::Result<()> { // remove from the window #[cfg_attr(target_os = "macos", allow(unused_variables))] if let Some(window_menu) = &*self.menu_lock() { let window = self.clone(); let menu_ = window_menu.menu.clone(); self.run_on_main_thread(move || { #[cfg(windows)] if let Ok(hwnd) = window.hwnd() { let _ = menu_.inner().show_for_hwnd(hwnd.0); } #[cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] if let Ok(gtk_window) = window.gtk_window() { let _ = menu_.inner().show_for_gtk_window(>k_window); } })?; } Ok(()) } /// Shows the window menu. pub fn is_menu_visible(&self) -> crate::Result { // remove from the window #[cfg_attr(target_os = "macos", allow(unused_variables))] if let Some(window_menu) = &*self.menu_lock() { let (tx, rx) = std::sync::mpsc::channel(); let window = self.clone(); let menu_ = window_menu.menu.clone(); self.run_on_main_thread(move || { #[cfg(windows)] if let Ok(hwnd) = window.hwnd() { let _ = tx.send(menu_.inner().is_visible_on_hwnd(hwnd.0)); } #[cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] if let Ok(gtk_window) = window.gtk_window() { let _ = tx.send(menu_.inner().is_visible_on_gtk_window(>k_window)); } })?; return Ok(rx.recv().unwrap_or(false)); } Ok(false) } /// Shows the specified menu as a context menu at the cursor position. pub fn popup_menu(&self, menu: &M) -> crate::Result<()> { menu.popup(self.clone()) } /// Shows the specified menu as a context menu at the specified position. /// /// The position is relative to the window's top-left corner. pub fn popup_menu_at>( &self, menu: &M, position: P, ) -> crate::Result<()> { menu.popup_at(self.clone(), position) } } /// Window getters. impl Window { /// Returns the scale factor that can be used to map logical pixels to physical pixels, and vice versa. pub fn scale_factor(&self) -> crate::Result { self.window.dispatcher.scale_factor().map_err(Into::into) } /// Returns the position of the top-left hand corner of the window's client area relative to the top-left hand corner of the desktop. pub fn inner_position(&self) -> crate::Result> { self.window.dispatcher.inner_position().map_err(Into::into) } /// Returns the position of the top-left hand corner of the window relative to the top-left hand corner of the desktop. pub fn outer_position(&self) -> crate::Result> { self.window.dispatcher.outer_position().map_err(Into::into) } /// Returns the physical size of the window's client area. /// /// The client area is the content of the window, excluding the title bar and borders. pub fn inner_size(&self) -> crate::Result> { self.window.dispatcher.inner_size().map_err(Into::into) } /// Returns the physical size of the entire window. /// /// These dimensions include the title bar and borders. If you don't want that (and you usually don't), use inner_size instead. pub fn outer_size(&self) -> crate::Result> { self.window.dispatcher.outer_size().map_err(Into::into) } /// Gets the window's current fullscreen state. pub fn is_fullscreen(&self) -> crate::Result { self.window.dispatcher.is_fullscreen().map_err(Into::into) } /// Gets the window's current minimized state. pub fn is_minimized(&self) -> crate::Result { self.window.dispatcher.is_minimized().map_err(Into::into) } /// Gets the window's current maximized state. pub fn is_maximized(&self) -> crate::Result { self.window.dispatcher.is_maximized().map_err(Into::into) } /// Gets the window's current focus state. pub fn is_focused(&self) -> crate::Result { self.window.dispatcher.is_focused().map_err(Into::into) } /// Gets the window’s current decoration state. pub fn is_decorated(&self) -> crate::Result { self.window.dispatcher.is_decorated().map_err(Into::into) } /// Gets the window’s current resizable state. pub fn is_resizable(&self) -> crate::Result { self.window.dispatcher.is_resizable().map_err(Into::into) } /// Gets the window’s native maximize button state /// /// ## Platform-specific /// /// - **Linux / iOS / Android:** Unsupported. pub fn is_maximizable(&self) -> crate::Result { self.window.dispatcher.is_maximizable().map_err(Into::into) } /// Gets the window’s native minimize button state /// /// ## Platform-specific /// /// - **Linux / iOS / Android:** Unsupported. pub fn is_minimizable(&self) -> crate::Result { self.window.dispatcher.is_minimizable().map_err(Into::into) } /// Gets the window’s native close button state /// /// ## Platform-specific /// /// - **Linux / iOS / Android:** Unsupported. pub fn is_closable(&self) -> crate::Result { self.window.dispatcher.is_closable().map_err(Into::into) } /// Gets the window's current visibility state. pub fn is_visible(&self) -> crate::Result { self.window.dispatcher.is_visible().map_err(Into::into) } /// Gets the window's current title. pub fn title(&self) -> crate::Result { self.window.dispatcher.title().map_err(Into::into) } /// Returns the monitor on which the window currently resides. /// /// Returns None if current monitor can't be detected. pub fn current_monitor(&self) -> crate::Result> { self .window .dispatcher .current_monitor() .map(|m| m.map(Into::into)) .map_err(Into::into) } /// Returns the primary monitor of the system. /// /// Returns None if it can't identify any monitor as a primary one. pub fn primary_monitor(&self) -> crate::Result> { self .window .dispatcher .primary_monitor() .map(|m| m.map(Into::into)) .map_err(Into::into) } /// Returns the list of all the monitors available on the system. pub fn available_monitors(&self) -> crate::Result> { self .window .dispatcher .available_monitors() .map(|m| m.into_iter().map(Into::into).collect()) .map_err(Into::into) } /// Returns the native handle that is used by this window. #[cfg(target_os = "macos")] pub fn ns_window(&self) -> crate::Result<*mut std::ffi::c_void> { self .window .dispatcher .raw_window_handle() .map_err(Into::into) .and_then(|handle| { if let raw_window_handle::RawWindowHandle::AppKit(h) = handle { Ok(h.ns_window) } else { Err(crate::Error::InvalidWindowHandle) } }) } /// Returns the pointer to the content view of this window. #[cfg(target_os = "macos")] pub fn ns_view(&self) -> crate::Result<*mut std::ffi::c_void> { self .window .dispatcher .raw_window_handle() .map_err(Into::into) .and_then(|handle| { if let raw_window_handle::RawWindowHandle::AppKit(h) = handle { Ok(h.ns_view) } else { Err(crate::Error::InvalidWindowHandle) } }) } /// Returns the native handle that is used by this window. #[cfg(windows)] pub fn hwnd(&self) -> crate::Result { self .window .dispatcher .raw_window_handle() .map_err(Into::into) .and_then(|handle| { if let raw_window_handle::RawWindowHandle::Win32(h) = handle { Ok(HWND(h.hwnd as _)) } else { Err(crate::Error::InvalidWindowHandle) } }) } /// Returns the `ApplicationWindow` from gtk crate that is used by this window. /// /// Note that this type can only be used on the main thread. #[cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] pub fn gtk_window(&self) -> crate::Result { self.window.dispatcher.gtk_window().map_err(Into::into) } /// Returns the vertical [`gtk::Box`] that is added by default as the sole child of this window. /// /// Note that this type can only be used on the main thread. #[cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] pub fn default_vbox(&self) -> crate::Result { self.window.dispatcher.default_vbox().map_err(Into::into) } /// Returns the current window theme. /// /// ## Platform-specific /// /// - **macOS**: Only supported on macOS 10.14+. pub fn theme(&self) -> crate::Result { self.window.dispatcher.theme().map_err(Into::into) } } /// Desktop window setters and actions. #[cfg(desktop)] impl Window { /// Centers the window. pub fn center(&self) -> crate::Result<()> { self.window.dispatcher.center().map_err(Into::into) } /// Requests 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. /// /// 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 /// /// - **macOS:** `None` has no effect. /// - **Linux:** Urgency levels have the same effect. pub fn request_user_attention( &self, request_type: Option, ) -> crate::Result<()> { self .window .dispatcher .request_user_attention(request_type) .map_err(Into::into) } /// Opens the dialog to prints the contents of the webview. /// Currently only supported on macOS on `wry`. /// `window.print()` works on all platforms. pub fn print(&self) -> crate::Result<()> { self.window.dispatcher.print().map_err(Into::into) } /// Determines if this window should be resizable. /// When resizable is set to false, native window's maximize button is automatically disabled. pub fn set_resizable(&self, resizable: bool) -> crate::Result<()> { self .window .dispatcher .set_resizable(resizable) .map_err(Into::into) } /// Determines if this window's native maximize button should be enabled. /// If resizable is set to false, this setting is ignored. /// /// ## Platform-specific /// /// - **macOS:** Disables the "zoom" button in the window titlebar, which is also used to enter fullscreen mode. /// - **Linux / iOS / Android:** Unsupported. pub fn set_maximizable(&self, maximizable: bool) -> crate::Result<()> { self .window .dispatcher .set_maximizable(maximizable) .map_err(Into::into) } /// Determines if this window's native minize button should be enabled. /// /// ## Platform-specific /// /// - **Linux / iOS / Android:** Unsupported. pub fn set_minimizable(&self, minimizable: bool) -> crate::Result<()> { self .window .dispatcher .set_minimizable(minimizable) .map_err(Into::into) } /// Determines if this window's native close button should be enabled. /// /// ## Platform-specific /// /// - **Linux:** "GTK+ will do its best to convince the window manager not to show a close button. /// Depending on the system, this function may not have any effect when called on a window that is already visible" /// - **iOS / Android:** Unsupported. pub fn set_closable(&self, closable: bool) -> crate::Result<()> { self .window .dispatcher .set_closable(closable) .map_err(Into::into) } /// Set this window's title. pub fn set_title(&self, title: &str) -> crate::Result<()> { self .window .dispatcher .set_title(title.to_string()) .map_err(Into::into) } /// Maximizes this window. pub fn maximize(&self) -> crate::Result<()> { self.window.dispatcher.maximize().map_err(Into::into) } /// Un-maximizes this window. pub fn unmaximize(&self) -> crate::Result<()> { self.window.dispatcher.unmaximize().map_err(Into::into) } /// Minimizes this window. pub fn minimize(&self) -> crate::Result<()> { self.window.dispatcher.minimize().map_err(Into::into) } /// Un-minimizes this window. pub fn unminimize(&self) -> crate::Result<()> { self.window.dispatcher.unminimize().map_err(Into::into) } /// Show this window. pub fn show(&self) -> crate::Result<()> { self.window.dispatcher.show().map_err(Into::into) } /// Hide this window. pub fn hide(&self) -> crate::Result<()> { self.window.dispatcher.hide().map_err(Into::into) } /// Closes this window. /// # Panics /// /// - Panics if the event loop is not running yet, usually when called on the [`setup`](crate::Builder#method.setup) closure. /// - Panics when called on the main thread, usually on the [`run`](crate::App#method.run) closure. /// /// You can spawn a task to use the API using [`crate::async_runtime::spawn`] or [`std::thread::spawn`] to prevent the panic. pub fn close(&self) -> crate::Result<()> { self.window.dispatcher.close().map_err(Into::into) } /// Determines if this window should be [decorated]. /// /// [decorated]: https://en.wikipedia.org/wiki/Window_(computing)#Window_decoration pub fn set_decorations(&self, decorations: bool) -> crate::Result<()> { self .window .dispatcher .set_decorations(decorations) .map_err(Into::into) } /// Determines if this window should have shadow. /// /// ## Platform-specific /// /// - **Windows:** /// - `false` has no effect on decorated window, shadow are always ON. /// - `true` will make ndecorated window have a 1px white border, /// and on Windows 11, it will have a rounded corners. /// - **Linux:** Unsupported. pub fn set_shadow(&self, enable: bool) -> crate::Result<()> { self .window .dispatcher .set_shadow(enable) .map_err(Into::into) } /// Sets window effects, pass [`None`] to clear any effects applied if possible. /// /// Requires the window to be transparent. /// /// See [`EffectsBuilder`] for a convenient builder for [`WindowEffectsConfig`]. /// /// /// ```rust,no_run /// use tauri::{Manager, window::{Color, Effect, EffectState, EffectsBuilder}}; /// tauri::Builder::default() /// .setup(|app| { /// let window = app.get_window("main").unwrap(); /// window.set_effects( /// EffectsBuilder::new() /// .effect(Effect::Popover) /// .state(EffectState::Active) /// .radius(5.) /// .color(Color(0, 0, 0, 255)) /// .build(), /// )?; /// Ok(()) /// }); /// ``` /// /// ## Platform-specific: /// /// - **Windows**: If using decorations or shadows, you may want to try this workaround /// - **Linux**: Unsupported pub fn set_effects>>(&self, effects: E) -> crate::Result<()> { let effects = effects.into(); let window = self.clone(); self.run_on_main_thread(move || { let _ = crate::vibrancy::set_window_effects(&window, effects); }) } /// Determines if this window should always be below other windows. pub fn set_always_on_bottom(&self, always_on_bottom: bool) -> crate::Result<()> { self .window .dispatcher .set_always_on_bottom(always_on_bottom) .map_err(Into::into) } /// Determines if this window should always be on top of other windows. pub fn set_always_on_top(&self, always_on_top: bool) -> crate::Result<()> { self .window .dispatcher .set_always_on_top(always_on_top) .map_err(Into::into) } /// Sets whether the window should be visible on all workspaces or virtual desktops. pub fn set_visible_on_all_workspaces( &self, visible_on_all_workspaces: bool, ) -> crate::Result<()> { self .window .dispatcher .set_visible_on_all_workspaces(visible_on_all_workspaces) .map_err(Into::into) } /// Prevents the window contents from being captured by other apps. pub fn set_content_protected(&self, protected: bool) -> crate::Result<()> { self .window .dispatcher .set_content_protected(protected) .map_err(Into::into) } /// Resizes this window. pub fn set_size>(&self, size: S) -> crate::Result<()> { self .window .dispatcher .set_size(size.into()) .map_err(Into::into) } /// Sets this window's minimum size. pub fn set_min_size>(&self, size: Option) -> crate::Result<()> { self .window .dispatcher .set_min_size(size.map(|s| s.into())) .map_err(Into::into) } /// Sets this window's maximum size. pub fn set_max_size>(&self, size: Option) -> crate::Result<()> { self .window .dispatcher .set_max_size(size.map(|s| s.into())) .map_err(Into::into) } /// Sets this window's position. pub fn set_position>(&self, position: Pos) -> crate::Result<()> { self .window .dispatcher .set_position(position.into()) .map_err(Into::into) } /// Determines if this window should be fullscreen. pub fn set_fullscreen(&self, fullscreen: bool) -> crate::Result<()> { self .window .dispatcher .set_fullscreen(fullscreen) .map_err(Into::into) } /// Bring the window to front and focus. pub fn set_focus(&self) -> crate::Result<()> { self.window.dispatcher.set_focus().map_err(Into::into) } /// Sets this window' icon. pub fn set_icon(&self, icon: Icon) -> crate::Result<()> { self .window .dispatcher .set_icon(icon.try_into()?) .map_err(Into::into) } /// Whether to hide the window icon from the taskbar or not. /// /// ## Platform-specific /// /// - **macOS:** Unsupported. pub fn set_skip_taskbar(&self, skip: bool) -> crate::Result<()> { self .window .dispatcher .set_skip_taskbar(skip) .map_err(Into::into) } /// Grabs the cursor, preventing it from leaving the window. /// /// There's no guarantee that the cursor will be hidden. You should /// hide it by yourself if you want so. /// /// ## Platform-specific /// /// - **Linux:** Unsupported. /// - **macOS:** This locks the cursor in a fixed location, which looks visually awkward. pub fn set_cursor_grab(&self, grab: bool) -> crate::Result<()> { self .window .dispatcher .set_cursor_grab(grab) .map_err(Into::into) } /// Modifies the cursor's visibility. /// /// If `false`, this will hide the cursor. If `true`, this will show the cursor. /// /// ## Platform-specific /// /// - **Windows:** The cursor is only hidden within the confines of the window. /// - **macOS:** The cursor is hidden as long as the window has input focus, even if the cursor is /// outside of the window. pub fn set_cursor_visible(&self, visible: bool) -> crate::Result<()> { self .window .dispatcher .set_cursor_visible(visible) .map_err(Into::into) } /// Modifies the cursor icon of the window. pub fn set_cursor_icon(&self, icon: CursorIcon) -> crate::Result<()> { self .window .dispatcher .set_cursor_icon(icon) .map_err(Into::into) } /// Changes the position of the cursor in window coordinates. pub fn set_cursor_position>(&self, position: Pos) -> crate::Result<()> { self .window .dispatcher .set_cursor_position(position) .map_err(Into::into) } /// Ignores the window cursor events. pub fn set_ignore_cursor_events(&self, ignore: bool) -> crate::Result<()> { self .window .dispatcher .set_ignore_cursor_events(ignore) .map_err(Into::into) } /// Starts dragging the window. pub fn start_dragging(&self) -> crate::Result<()> { self.window.dispatcher.start_dragging().map_err(Into::into) } /// Sets the taskbar progress state. /// /// ## Platform-specific /// /// - **Linux / macOS**: Progress bar is app-wide and not specific to this window. /// - **Linux**: Only supported desktop environments with `libunity` (e.g. GNOME). /// - **iOS / Android:** Unsupported. pub fn set_progress_bar( &self, progress_state: crate::utils::ProgressBarState, ) -> crate::Result<()> { self .window .dispatcher .set_progress_bar(progress_state) .map_err(Into::into) } } /// Webview APIs. impl Window { /// Returns the current url of the webview. // TODO: in v2, change this type to Result pub fn url(&self) -> Url { self.window.dispatcher.url().unwrap() } /// Navigates the webview to the defined url. pub fn navigate(&mut self, url: Url) { self.window.dispatcher.navigate(url).unwrap(); } fn is_local_url(&self, current_url: &Url) -> bool { self.manager.get_url().make_relative(current_url).is_some() || { let protocol_url = self.manager.protocol_url(); current_url.scheme() == protocol_url.scheme() && current_url.domain() == protocol_url.domain() } || (cfg!(dev) && current_url.domain() == Some("tauri.localhost")) } /// Handles this window receiving an [`InvokeRequest`]. pub fn on_message(self, request: InvokeRequest, responder: Box>) { let manager = self.manager.clone(); let current_url = self.url(); let is_local = self.is_local_url(¤t_url); let mut scope_not_found_error_message = ipc_scope_not_found_error_message(&self.window.label, current_url.as_str()); let scope = if is_local { None } else { match self.ipc_scope().remote_access_for(&self, ¤t_url) { Ok(scope) => Some(scope), Err(e) => { if e.matches_window { scope_not_found_error_message = ipc_scope_domain_error_message(current_url.as_str()); } else if e.matches_domain { scope_not_found_error_message = ipc_scope_window_error_message(&self.window.label); } None } } }; let custom_responder = self.manager.window.invoke_responder.clone(); let resolver = InvokeResolver::new( self.clone(), Arc::new(Mutex::new(Some(Box::new( #[allow(unused_variables)] move |window: Window, cmd, response, callback, error| { if let Some(responder) = &custom_responder { (responder)(&window, &cmd, &response, callback, error); } responder(window, cmd, response, callback, error); }, )))), request.cmd.clone(), request.callback, request.error, ); #[cfg(mobile)] let app_handle = self.app_handle.clone(); let message = InvokeMessage::new( self, manager.state(), request.cmd.to_string(), request.body, request.headers, ); let mut invoke = Invoke { message, resolver: resolver.clone(), }; if !is_local && scope.is_none() { invoke.resolver.reject(scope_not_found_error_message); } else if request.cmd.starts_with("plugin:") { let command = invoke.message.command.replace("plugin:", ""); let mut tokens = command.split('|'); // safe to unwrap: split always has a least one item let plugin = tokens.next().unwrap(); invoke.message.command = tokens .next() .map(|c| c.to_string()) .unwrap_or_else(String::new); if !(is_local || plugin == crate::ipc::channel::CHANNEL_PLUGIN_NAME || scope .map(|s| s.plugins().contains(&plugin.into())) .unwrap_or(true)) { invoke.resolver.reject(IPC_SCOPE_DOES_NOT_ALLOW); return; } let command = invoke.message.command.clone(); #[cfg(mobile)] let message = invoke.message.clone(); #[allow(unused_mut)] let mut handled = manager.extend_api(plugin, invoke); #[cfg(mobile)] { if !handled { handled = true; fn load_channels(payload: &serde_json::Value, window: &Window) { if let serde_json::Value::Object(map) = payload { for v in map.values() { if let serde_json::Value::String(s) = v { if s.starts_with(crate::ipc::channel::IPC_PAYLOAD_PREFIX) { crate::ipc::Channel::load_from_ipc(window.clone(), s); } } } } } let payload = message.payload.into_json(); // initialize channels load_channels(&payload, &message.window); let resolver_ = resolver.clone(); if let Err(e) = crate::plugin::mobile::run_command( plugin, &app_handle, message.command, payload, move |response| match response { Ok(r) => resolver_.resolve(r), Err(e) => resolver_.reject(e), }, ) { resolver.reject(e.to_string()); return; } } } if !handled { resolver.reject(format!("Command {command} not found")); } } else { let command = invoke.message.command.clone(); let handled = manager.run_invoke_handler(invoke); if !handled { resolver.reject(format!("Command {command} not found")); } } } /// Evaluates JavaScript on this window. pub fn eval(&self, js: &str) -> crate::Result<()> { self.window.dispatcher.eval_script(js).map_err(Into::into) } /// Register a JS event listener and return its identifier. pub(crate) fn listen_js( &self, window_label: Option, event: String, handler: CallbackFn, ) -> crate::Result { let event_id = self.manager.listeners().next_event_id(); self.eval(&crate::event::listen_js( self.manager().listeners().listeners_object_name(), &format!("'{}'", event), event_id, window_label.as_deref(), &format!("window['_{}']", handler.0), ))?; self .js_event_listeners .lock() .unwrap() .entry(JsEventListenerKey { window_label, event, }) .or_default() .insert(event_id); Ok(event_id) } /// Unregister a JS event listener. pub(crate) fn unlisten_js(&self, event: &str, id: EventId) -> crate::Result<()> { self.eval(&crate::event::unlisten_js( self.manager().listeners().listeners_object_name(), event, id, ))?; let mut empty = None; let mut js_listeners = self.js_event_listeners.lock().unwrap(); let iter = js_listeners.iter_mut(); for (key, ids) in iter { if ids.contains(&id) { ids.remove(&id); if ids.is_empty() { empty.replace(key.clone()); } break; } } if let Some(key) = empty { js_listeners.remove(&key); } Ok(()) } pub(crate) fn emit_js(&self, emit_args: &EmitArgs) -> crate::Result<()> { self.eval(&crate::event::emit_js( self.manager().listeners().function_name(), emit_args, )?)?; Ok(()) } /// Whether this window registered a listener to an event from the given window and event name. pub(crate) fn has_js_listener(&self, window_label: Option, event: &str) -> bool { let listeners = self.js_event_listeners.lock().unwrap(); if let Some(label) = window_label { let event = event.to_string(); // window-specific event is also triggered on global events, so we check that listeners.contains_key(&JsEventListenerKey { window_label: Some(label), event: event.clone(), }) || listeners.contains_key(&JsEventListenerKey { window_label: None, event, }) } else { // for global events, any listener is triggered listeners.keys().any(|k| k.event == event) } } /// Opens the developer tools window (Web Inspector). /// The devtools is only enabled on debug builds or with the `devtools` feature flag. /// /// ## Platform-specific /// /// - **macOS:** Only supported on macOS 10.15+. /// This is a private API on macOS, so you cannot use this if your application will be published on the App Store. /// /// # Examples /// /// ```rust,no_run /// use tauri::Manager; /// tauri::Builder::default() /// .setup(|app| { /// #[cfg(debug_assertions)] /// app.get_window("main").unwrap().open_devtools(); /// Ok(()) /// }); /// ``` #[cfg(any(debug_assertions, feature = "devtools"))] #[cfg_attr(docsrs, doc(cfg(any(debug_assertions, feature = "devtools"))))] pub fn open_devtools(&self) { self.window.dispatcher.open_devtools(); } /// Closes the developer tools window (Web Inspector). /// The devtools is only enabled on debug builds or with the `devtools` feature flag. /// /// ## Platform-specific /// /// - **macOS:** Only supported on macOS 10.15+. /// This is a private API on macOS, so you cannot use this if your application will be published on the App Store. /// - **Windows:** Unsupported. /// /// # Examples /// /// ```rust,no_run /// use tauri::Manager; /// tauri::Builder::default() /// .setup(|app| { /// #[cfg(debug_assertions)] /// { /// let window = app.get_window("main").unwrap(); /// window.open_devtools(); /// std::thread::spawn(move || { /// std::thread::sleep(std::time::Duration::from_secs(10)); /// window.close_devtools(); /// }); /// } /// Ok(()) /// }); /// ``` #[cfg(any(debug_assertions, feature = "devtools"))] #[cfg_attr(docsrs, doc(cfg(any(debug_assertions, feature = "devtools"))))] pub fn close_devtools(&self) { self.window.dispatcher.close_devtools(); } /// Checks if the developer tools window (Web Inspector) is opened. /// The devtools is only enabled on debug builds or with the `devtools` feature flag. /// /// ## Platform-specific /// /// - **macOS:** Only supported on macOS 10.15+. /// This is a private API on macOS, so you cannot use this if your application will be published on the App Store. /// - **Windows:** Unsupported. /// /// # Examples /// /// ```rust,no_run /// use tauri::Manager; /// tauri::Builder::default() /// .setup(|app| { /// #[cfg(debug_assertions)] /// { /// let window = app.get_window("main").unwrap(); /// if !window.is_devtools_open() { /// window.open_devtools(); /// } /// } /// Ok(()) /// }); /// ``` #[cfg(any(debug_assertions, feature = "devtools"))] #[cfg_attr(docsrs, doc(cfg(any(debug_assertions, feature = "devtools"))))] pub fn is_devtools_open(&self) -> bool { self .window .dispatcher .is_devtools_open() .unwrap_or_default() } } /// Event system APIs. impl Window { /// Listen to an event on this window. /// /// # Examples /// ``` /// use tauri::Manager; /// /// tauri::Builder::default() /// .setup(|app| { /// let window = app.get_window("main").unwrap(); /// window.listen("component-loaded", move |event| { /// println!("window just loaded a component"); /// }); /// /// Ok(()) /// }); /// ``` pub fn listen(&self, event: impl Into, handler: F) -> EventId where F: Fn(Event) + Send + 'static, { self .manager .listen(event.into(), Some(self.clone()), handler) } /// Unlisten to an event on this window. /// /// # Examples /// ``` /// use tauri::Manager; /// /// tauri::Builder::default() /// .setup(|app| { /// let window = app.get_window("main").unwrap(); /// let window_ = window.clone(); /// let handler = window.listen("component-loaded", move |event| { /// println!("window just loaded a component"); /// /// // we no longer need to listen to the event /// // we also could have used `window.once` instead /// window_.unlisten(event.id()); /// }); /// /// // stop listening to the event when you do not need it anymore /// window.unlisten(handler); /// /// /// Ok(()) /// }); /// ``` pub fn unlisten(&self, id: EventId) { self.manager.unlisten(id) } /// Listen to an event on this window only once. /// /// See [`Self::listen`] for more information. pub fn once(&self, event: impl Into, handler: F) where F: FnOnce(Event) + Send + 'static, { let label = self.window.label.clone(); self.manager.once(event.into(), Some(label), handler) } } /// The [`WindowEffectsConfig`] object builder #[derive(Default)] pub struct EffectsBuilder(WindowEffectsConfig); impl EffectsBuilder { /// Create a new [`WindowEffectsConfig`] builder pub fn new() -> Self { Self(WindowEffectsConfig::default()) } /// Adds effect to the [`WindowEffectsConfig`] `effects` field pub fn effect(mut self, effect: Effect) -> Self { self.0.effects.push(effect); self } /// Adds effects to the [`WindowEffectsConfig`] `effects` field pub fn effects>(mut self, effects: I) -> Self { self.0.effects.extend(effects); self } /// Clears the [`WindowEffectsConfig`] `effects` field pub fn clear_effects(mut self) -> Self { self.0.effects.clear(); self } /// Sets `state` field for the [`WindowEffectsConfig`] **macOS Only** pub fn state(mut self, state: EffectState) -> Self { self.0.state = Some(state); self } /// Sets `radius` field fo the [`WindowEffectsConfig`] **macOS Only** pub fn radius(mut self, radius: f64) -> Self { self.0.radius = Some(radius); self } /// Sets `color` field fo the [`WindowEffectsConfig`] **Windows Only** pub fn color(mut self, color: Color) -> Self { self.0.color = Some(color); self } /// Builds a [`WindowEffectsConfig`] pub fn build(self) -> WindowEffectsConfig { self.0 } } impl From for EffectsBuilder { fn from(value: WindowEffectsConfig) -> Self { Self(value) } } pub(crate) const IPC_SCOPE_DOES_NOT_ALLOW: &str = "Not allowed by the scope"; pub(crate) fn ipc_scope_not_found_error_message(label: &str, url: &str) -> String { format!("Scope not defined for window `{label}` and URL `{url}`. See https://tauri.app/v1/api/config/#securityconfig.dangerousremotedomainipcaccess and https://docs.rs/tauri/1/tauri/scope/struct.IpcScope.html#method.configure_remote_access") } pub(crate) fn ipc_scope_window_error_message(label: &str) -> String { format!("Scope not defined for window `{}`. See https://tauri.app/v1/api/config/#securityconfig.dangerousremotedomainipcaccess and https://docs.rs/tauri/1/tauri/scope/struct.IpcScope.html#method.configure_remote_access", label) } pub(crate) fn ipc_scope_domain_error_message(url: &str) -> String { format!("Scope not defined for URL `{url}`. See https://tauri.app/v1/api/config/#securityconfig.dangerousremotedomainipcaccess and https://docs.rs/tauri/1/tauri/scope/struct.IpcScope.html#method.configure_remote_access") } #[cfg(test)] mod tests { #[test] fn window_is_send_sync() { crate::test_utils::assert_send::(); crate::test_utils::assert_sync::(); } }