// 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 menu; pub use menu::{MenuEvent, MenuHandle}; use url::Url; #[cfg(target_os = "macos")] use crate::TitleBarStyle; use crate::{ app::AppHandle, command::{CommandArg, CommandItem}, event::{Event, EventHandler}, hooks::{InvokePayload, InvokeResponder}, manager::WindowManager, runtime::{ http::{Request as HttpRequest, Response as HttpResponse}, monitor::Monitor as RuntimeMonitor, webview::{WebviewAttributes, WindowBuilder as _}, window::{ dpi::{PhysicalPosition, PhysicalSize}, DetachedWindow, JsEventListenerKey, PendingWindow, }, Dispatch, RuntimeHandle, }, sealed::ManagerBase, sealed::RuntimeOrDispatch, utils::config::{WindowConfig, WindowUrl}, EventLoopMessage, Invoke, InvokeError, InvokeMessage, InvokeResolver, Manager, PageLoadPayload, Runtime, Theme, WindowEvent, }; #[cfg(desktop)] use crate::{ runtime::{ menu::Menu, window::dpi::{Position, Size}, UserAttentionType, }, CursorIcon, Icon, }; use serde::Serialize; #[cfg(windows)] use windows::Win32::Foundation::HWND; use tauri_macros::default_runtime; use std::{ fmt, hash::{Hash, Hasher}, path::PathBuf, sync::Arc, }; pub(crate) type WebResourceRequestHandler = dyn Fn(&HttpRequest, &mut HttpResponse) + Send + Sync; pub(crate) type NavigationHandler = dyn Fn(Url) -> bool + Send; #[derive(Clone, Serialize)] struct WindowCreatedEvent { label: String, } /// 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: WindowManager, runtime: RuntimeOrDispatch<'a, R>, app_handle: AppHandle, label: String, pub(crate) window_builder: >::WindowBuilder, pub(crate) webview_attributes: WebviewAttributes, web_resource_request_handler: Option>, navigation_handler: 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(); /// 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(); Self { manager: manager.manager().clone(), runtime, app_handle, label: label.into(), window_builder: >::WindowBuilder::new(), webview_attributes: WebviewAttributes::new(url), web_resource_request_handler: None, navigation_handler: 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 runtime = manager.runtime(); let app_handle = manager.app_handle(); let url = config.url.clone(); let file_drop_enabled = config.file_drop_enabled; let mut builder = Self { manager: manager.manager().clone(), runtime, app_handle, label: config.label.clone(), window_builder: >::WindowBuilder::with_config( config, ), webview_attributes: WebviewAttributes::new(url), web_resource_request_handler: None, navigation_handler: None, }; if !file_drop_enabled { builder = builder.disable_file_drop_handler(); } 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}, /// http::header::HeaderValue, /// window::WindowBuilder, /// }; /// 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().starts_with("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( 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}, /// http::header::HeaderValue, /// window::WindowBuilder, /// }; /// 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 } /// Creates a new webview window. pub fn build(mut self) -> crate::Result> { let web_resource_request_handler = self.web_resource_request_handler.take(); let pending = PendingWindow::new( self.window_builder.clone(), self.webview_attributes.clone(), self.label.clone(), )?; let labels = self.manager.labels().into_iter().collect::>(); let mut pending = self.manager.prepare_window( self.app_handle.clone(), pending, &labels, web_resource_request_handler, )?; pending.navigation_handler = self.navigation_handler.take(); let window = match &mut self.runtime { RuntimeOrDispatch::Runtime(runtime) => runtime.create_window(pending), RuntimeOrDispatch::RuntimeHandle(handle) => handle.create_window(pending), RuntimeOrDispatch::Dispatch(dispatcher) => dispatcher.create_window(pending), } .map(|window| self.manager.attach_window(self.app_handle.clone(), window))?; self.manager.eval_script_all(format!( "window.__TAURI_METADATA__.__windows = {window_labels_array}.map(function (label) {{ return {{ label: label }} }})", window_labels_array = serde_json::to_string(&self.manager.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.window_builder = self.window_builder.menu(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. #[must_use] pub fn resizable(mut self, resizable: bool) -> Self { self.window_builder = self.window_builder.resizable(resizable); 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( doc_cfg, 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 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 should always be on top of other windows. #[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 } } /// 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 } } // 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)] #[derive(Debug)] pub struct Window { /// The webview window created by the runtime. window: DetachedWindow, /// The manager to associate this webview window with. manager: WindowManager, pub(crate) app_handle: AppHandle, } 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(), } } } 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_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_all(&self, event: &str, payload: S) -> crate::Result<()> { self .manager() .emit_filter(event, Some(self.label()), payload, |_| true) } } impl ManagerBase for Window { fn manager(&self) -> &WindowManager { &self.manager } fn runtime(&self) -> RuntimeOrDispatch<'_, R> { RuntimeOrDispatch::Dispatch(self.dispatcher()) } fn managed_app_handle(&self) -> AppHandle { self.app_handle.clone() } } 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(doc_cfg, 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( doc_cfg, 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(doc_cfg, 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(doc_cfg, 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(doc_cfg, 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(doc_cfg, 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(doc_cfg, 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: WindowManager, window: DetachedWindow, app_handle: AppHandle, ) -> Self { Self { window, manager, app_handle, } } /// 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) } pub(crate) fn invoke_responder(&self) -> Arc> { self.manager.invoke_responder() } /// 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())); } /// Registers a menu event listener. pub fn on_menu_event(&self, f: F) -> uuid::Uuid { let menu_ids = self.window.menu_ids.clone(); self.window.dispatcher.on_menu_event(move |event| { let id = menu_ids .lock() .unwrap() .get(&event.menu_item_id) .unwrap() .clone(); f(MenuEvent { menu_item_id: id }) }) } /// 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/0.18.2/webkit2gtk/struct.WebView.html /// // and https://docs.rs/webkit2gtk/0.18.2/webkit2gtk/trait.WebViewExt.html /// use webkit2gtk::traits::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(all(feature = "wry"))] #[cfg_attr(doc_cfg, doc(all(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) } } /// Window getters. impl Window { /// Gets a handle to the window menu. pub fn menu_handle(&self) -> MenuHandle { MenuHandle { ids: self.window.menu_ids.clone(), dispatcher: self.dispatcher(), } } /// 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 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 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 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 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 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. pub fn set_resizable(&self, resizable: bool) -> crate::Result<()> { self .window .dispatcher .set_resizable(resizable) .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) } /// 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) } /// 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) } } /// Webview APIs. impl Window { /// Returns the current url of the webview. pub fn url(&self) -> crate::Result { self.window.dispatcher.url().map_err(Into::into) } /// Handles this window receiving an [`InvokeMessage`]. pub fn on_message(self, payload: InvokePayload) -> crate::Result<()> { let manager = self.manager.clone(); match payload.cmd.as_str() { "__initialized" => { let payload: PageLoadPayload = serde_json::from_value(payload.inner)?; manager.run_on_page_load(self, payload); } _ => { let message = InvokeMessage::new( self.clone(), manager.state(), payload.cmd.to_string(), payload.inner, ); #[allow(clippy::redundant_clone)] let resolver = InvokeResolver::new(self.clone(), payload.callback, payload.error); let mut invoke = Invoke { message, resolver }; if let Some(module) = &payload.tauri_module { crate::endpoints::handle( module.to_string(), invoke, manager.config(), manager.package_info(), ); } else if payload.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); let command = invoke.message.command.clone(); let resolver = invoke.resolver.clone(); #[cfg(mobile)] let message = invoke.message.clone(); #[allow(unused_mut)] let mut handled = manager.extend_api(plugin, invoke); #[cfg(target_os = "ios")] { if !handled { handled = true; let plugin = plugin.to_string(); let (callback, error) = (resolver.callback, resolver.error); self.with_webview(move |webview| { unsafe { crate::ios::post_ipc_message( webview.inner(), &plugin.as_str().into(), &heck::ToLowerCamelCase::to_lower_camel_case(message.command.as_str()) .as_str() .into(), crate::ios::json_to_dictionary(message.payload), callback.0, error.0, ) }; })?; } } #[cfg(target_os = "android")] { if !handled { handled = true; let resolver_ = resolver.clone(); let runtime_handle = self.app_handle.runtime_handle.clone(); let plugin = plugin.to_string(); self.with_webview(move |webview| { webview.jni_handle().exec(move |env, activity, webview| { use jni::{ errors::Error as JniError, objects::JObject, JNIEnv, }; use crate::api::ipc::CallbackFn; fn handle_message( plugin: &str, runtime_handle: &R::Handle, message: InvokeMessage, (callback, error): (CallbackFn, CallbackFn), env: JNIEnv<'_>, activity: JObject<'_>, webview: JObject<'_>, ) -> Result<(), JniError> { let data = crate::jni_helpers::to_jsobject::(env, activity, runtime_handle, message.payload)?; let plugin_manager = env .call_method( activity, "getPluginManager", "()Lapp/tauri/plugin/PluginManager;", &[], )? .l()?; env.call_method( plugin_manager, "postIpcMessage", "(Landroid/webkit/WebView;Ljava/lang/String;Ljava/lang/String;Lapp/tauri/plugin/JSObject;JJ)V", &[ webview.into(), env.new_string(plugin)?.into(), env.new_string(&heck::ToLowerCamelCase::to_lower_camel_case(message.command.as_str()))?.into(), data, (callback.0 as i64).into(), (error.0 as i64).into(), ], )?; Ok(()) } if let Err(e) = handle_message( &plugin, &runtime_handle, message, (resolver_.callback, resolver_.error), env, activity, webview, ) { resolver_.reject(format!("failed to reach Android layer: {e}")); } }); })?; } } if !handled { resolver.reject(format!("Command {command} not found")); } } else { let command = invoke.message.command.clone(); let resolver = invoke.resolver.clone(); let handled = manager.run_invoke_handler(invoke); if !handled { resolver.reject(format!("Command {command} not found")); } } } } Ok(()) } /// Evaluates JavaScript on this window. pub fn eval(&self, js: &str) -> crate::Result<()> { self.window.dispatcher.eval_script(js).map_err(Into::into) } pub(crate) fn register_js_listener(&self, window_label: Option, event: String, id: u64) { self .window .js_event_listeners .lock() .unwrap() .entry(JsEventListenerKey { window_label, event, }) .or_insert_with(Default::default) .insert(id); } pub(crate) fn unregister_js_listener(&self, id: u64) { let mut empty = None; let mut js_listeners = self.window.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); } } /// 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 { self .window .js_event_listeners .lock() .unwrap() .contains_key(&JsEventListenerKey { window_label, event: event.into(), }) } /// 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(doc_cfg, 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(doc_cfg, 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(doc_cfg, 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 { /// Emits an event to both the JavaScript and the Rust listeners. pub fn emit_and_trigger( &self, event: &str, payload: S, ) -> crate::Result<()> { self.trigger(event, Some(serde_json::to_string(&payload)?)); self.emit(event, payload) } pub(crate) fn emit_internal( &self, event: &str, source_window_label: Option<&str>, payload: S, ) -> crate::Result<()> { self.eval(&format!( "(function () {{ const fn = window['{}']; fn && fn({{event: {}, windowLabel: {}, payload: {}}}) }})()", self.manager.event_emit_function_name(), serde_json::to_string(event)?, serde_json::to_string(&source_window_label)?, serde_json::to_value(payload)?, ))?; Ok(()) } /// Emits an event to the JavaScript listeners on the current window. /// /// The event is only delivered to listeners that used the `WebviewWindow#listen` method on the @tauri-apps/api `window` module. pub fn emit(&self, event: &str, payload: S) -> crate::Result<()> { self .manager .emit_filter(event, Some(self.label()), payload, |w| { w.has_js_listener(None, event) || w.has_js_listener(Some(self.label().into()), event) })?; Ok(()) } /// Listen to an event on this window. /// /// This listener only receives events that are triggered using the /// [`trigger`](Window#method.trigger) and [`emit_and_trigger`](Window#method.emit_and_trigger) methods or /// the `appWindow.emit` function from the @tauri-apps/api `window` module. pub fn listen(&self, event: impl Into, handler: F) -> EventHandler where F: Fn(Event) + Send + 'static, { let label = self.window.label.clone(); self.manager.listen(event.into(), Some(label), handler) } /// Unlisten to an event on this window. pub fn unlisten(&self, handler_id: EventHandler) { self.manager.unlisten(handler_id) } /// Listen to an event on this window a single time. pub fn once(&self, event: impl Into, handler: F) -> EventHandler where F: FnOnce(Event) + Send + 'static, { let label = self.window.label.clone(); self.manager.once(event.into(), Some(label), handler) } /// Triggers an event to the Rust listeners on this window. /// /// The event is only delivered to listeners that used the [`listen`](Window#method.listen) method. pub fn trigger(&self, event: &str, data: Option) { let label = self.window.label.clone(); self.manager.trigger(event, Some(label), data) } } #[cfg(test)] mod tests { #[test] fn window_is_send_sync() { crate::test_utils::assert_send::(); crate::test_utils::assert_sync::(); } }