tauri_runtime/
lib.rs

1// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
2// SPDX-License-Identifier: Apache-2.0
3// SPDX-License-Identifier: MIT
4
5//! Internal runtime between Tauri and the underlying webview runtime.
6//!
7//! None of the exposed API of this crate is stable, and it may break semver
8//! compatibility in the future. The major version only signifies the intended Tauri version.
9
10#![doc(
11  html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/.github/icon.png",
12  html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/.github/icon.png"
13)]
14#![cfg_attr(docsrs, feature(doc_cfg))]
15
16use raw_window_handle::DisplayHandle;
17use serde::{Deserialize, Serialize};
18use std::{borrow::Cow, fmt::Debug, sync::mpsc::Sender};
19use tauri_utils::config::Color;
20use tauri_utils::Theme;
21use url::Url;
22use webview::{DetachedWebview, PendingWebview};
23
24/// Types useful for interacting with a user's monitors.
25pub mod monitor;
26pub mod webview;
27pub mod window;
28
29use dpi::{PhysicalPosition, PhysicalSize, Position, Size};
30use monitor::Monitor;
31use window::{
32  CursorIcon, DetachedWindow, PendingWindow, RawWindow, WebviewEvent, WindowEvent,
33  WindowSizeConstraints,
34};
35use window::{WindowBuilder, WindowId};
36
37use http::{
38  header::{InvalidHeaderName, InvalidHeaderValue},
39  method::InvalidMethod,
40  status::InvalidStatusCode,
41};
42
43/// UI scaling utilities.
44pub use dpi;
45
46/// Cookie extraction
47pub use cookie::Cookie;
48
49pub type WindowEventId = u32;
50pub type WebviewEventId = u32;
51
52/// A rectangular region.
53#[derive(Clone, Copy, Debug, Serialize)]
54pub struct Rect {
55  /// Rect position.
56  pub position: dpi::Position,
57  /// Rect size.
58  pub size: dpi::Size,
59}
60
61impl Default for Rect {
62  fn default() -> Self {
63    Self {
64      position: Position::Logical((0, 0).into()),
65      size: Size::Logical((0, 0).into()),
66    }
67  }
68}
69
70/// Progress bar status.
71#[derive(Debug, Clone, Copy, Deserialize)]
72#[serde(rename_all = "camelCase")]
73pub enum ProgressBarStatus {
74  /// Hide progress bar.
75  None,
76  /// Normal state.
77  Normal,
78  /// Indeterminate state. **Treated as Normal on Linux and macOS**
79  Indeterminate,
80  /// Paused state. **Treated as Normal on Linux**
81  Paused,
82  /// Error state. **Treated as Normal on Linux**
83  Error,
84}
85
86/// Progress Bar State
87#[derive(Debug, Deserialize)]
88#[serde(rename_all = "camelCase")]
89pub struct ProgressBarState {
90  /// The progress bar status.
91  pub status: Option<ProgressBarStatus>,
92  /// The progress bar progress. This can be a value ranging from `0` to `100`
93  pub progress: Option<u64>,
94  /// The `.desktop` filename with the Unity desktop window manager, for example `myapp.desktop` **Linux Only**
95  pub desktop_filename: Option<String>,
96}
97
98/// Type of user attention requested on a window.
99#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize)]
100#[serde(tag = "type")]
101pub enum UserAttentionType {
102  /// ## Platform-specific
103  /// - **macOS:** Bounces the dock icon until the application is in focus.
104  /// - **Windows:** Flashes both the window and the taskbar button until the application is in focus.
105  Critical,
106  /// ## Platform-specific
107  /// - **macOS:** Bounces the dock icon once.
108  /// - **Windows:** Flashes the taskbar button until the application is in focus.
109  Informational,
110}
111
112#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize)]
113#[serde(tag = "type")]
114pub enum DeviceEventFilter {
115  /// Always filter out device events.
116  Always,
117  /// Filter out device events while the window is not focused.
118  Unfocused,
119  /// Report all device events regardless of window focus.
120  Never,
121}
122
123impl Default for DeviceEventFilter {
124  fn default() -> Self {
125    Self::Unfocused
126  }
127}
128
129/// Defines the orientation that a window resize will be performed.
130#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize)]
131pub enum ResizeDirection {
132  East,
133  North,
134  NorthEast,
135  NorthWest,
136  South,
137  SouthEast,
138  SouthWest,
139  West,
140}
141
142#[derive(Debug, thiserror::Error)]
143#[non_exhaustive]
144pub enum Error {
145  /// Failed to create webview.
146  #[error("failed to create webview: {0}")]
147  CreateWebview(Box<dyn std::error::Error + Send + Sync>),
148  /// Failed to create window.
149  #[error("failed to create window")]
150  CreateWindow,
151  /// The given window label is invalid.
152  #[error("Window labels must only include alphanumeric characters, `-`, `/`, `:` and `_`.")]
153  InvalidWindowLabel,
154  /// Failed to send message to webview.
155  #[error("failed to send message to the webview")]
156  FailedToSendMessage,
157  /// Failed to receive message from webview.
158  #[error("failed to receive message from webview")]
159  FailedToReceiveMessage,
160  /// Failed to serialize/deserialize.
161  #[error("JSON error: {0}")]
162  Json(#[from] serde_json::Error),
163  /// Failed to load window icon.
164  #[error("invalid icon: {0}")]
165  InvalidIcon(Box<dyn std::error::Error + Send + Sync>),
166  /// Failed to get monitor on window operation.
167  #[error("failed to get monitor")]
168  FailedToGetMonitor,
169  /// Failed to get cursor position.
170  #[error("failed to get cursor position")]
171  FailedToGetCursorPosition,
172  #[error("Invalid header name: {0}")]
173  InvalidHeaderName(#[from] InvalidHeaderName),
174  #[error("Invalid header value: {0}")]
175  InvalidHeaderValue(#[from] InvalidHeaderValue),
176  #[error("Invalid status code: {0}")]
177  InvalidStatusCode(#[from] InvalidStatusCode),
178  #[error("Invalid method: {0}")]
179  InvalidMethod(#[from] InvalidMethod),
180  #[error("Infallible error, something went really wrong: {0}")]
181  Infallible(#[from] std::convert::Infallible),
182  #[error("the event loop has been closed")]
183  EventLoopClosed,
184  #[error("Invalid proxy url")]
185  InvalidProxyUrl,
186  #[error("window not found")]
187  WindowNotFound,
188  #[cfg(any(target_os = "macos", target_os = "ios"))]
189  #[error("failed to remove data store")]
190  FailedToRemoveDataStore,
191}
192
193/// Result type.
194pub type Result<T> = std::result::Result<T, Error>;
195
196/// Window icon.
197#[derive(Debug, Clone)]
198pub struct Icon<'a> {
199  /// RGBA bytes of the icon.
200  pub rgba: Cow<'a, [u8]>,
201  /// Icon width.
202  pub width: u32,
203  /// Icon height.
204  pub height: u32,
205}
206
207/// A type that can be used as an user event.
208pub trait UserEvent: Debug + Clone + Send + 'static {}
209
210impl<T: Debug + Clone + Send + 'static> UserEvent for T {}
211
212/// Event triggered on the event loop run.
213#[derive(Debug)]
214#[non_exhaustive]
215pub enum RunEvent<T: UserEvent> {
216  /// Event loop is exiting.
217  Exit,
218  /// Event loop is about to exit
219  ExitRequested {
220    /// The exit code.
221    code: Option<i32>,
222    tx: Sender<ExitRequestedEventAction>,
223  },
224  /// An event associated with a window.
225  WindowEvent {
226    /// The window label.
227    label: String,
228    /// The detailed event.
229    event: WindowEvent,
230  },
231  /// An event associated with a webview.
232  WebviewEvent {
233    /// The webview label.
234    label: String,
235    /// The detailed event.
236    event: WebviewEvent,
237  },
238  /// Application ready.
239  Ready,
240  /// Sent if the event loop is being resumed.
241  Resumed,
242  /// Emitted when all of the event loop's input events have been processed and redraw processing is about to begin.
243  ///
244  /// This event is useful as a place to put your code that should be run after all state-changing events have been handled and you want to do stuff (updating state, performing calculations, etc) that happens as the "main body" of your event loop.
245  MainEventsCleared,
246  /// Emitted when the user wants to open the specified resource with the app.
247  #[cfg(any(target_os = "macos", target_os = "ios"))]
248  Opened { urls: Vec<url::Url> },
249  /// Emitted when the NSApplicationDelegate's applicationShouldHandleReopen gets called
250  #[cfg(target_os = "macos")]
251  Reopen {
252    /// Indicates whether the NSApplication object found any visible windows in your application.
253    has_visible_windows: bool,
254  },
255  /// A custom event defined by the user.
256  UserEvent(T),
257}
258
259/// Action to take when the event loop is about to exit
260#[derive(Debug)]
261pub enum ExitRequestedEventAction {
262  /// Prevent the event loop from exiting
263  Prevent,
264}
265
266/// Application's activation policy. Corresponds to NSApplicationActivationPolicy.
267#[cfg(target_os = "macos")]
268#[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
269#[non_exhaustive]
270pub enum ActivationPolicy {
271  /// Corresponds to NSApplicationActivationPolicyRegular.
272  Regular,
273  /// Corresponds to NSApplicationActivationPolicyAccessory.
274  Accessory,
275  /// Corresponds to NSApplicationActivationPolicyProhibited.
276  Prohibited,
277}
278
279/// A [`Send`] handle to the runtime.
280pub trait RuntimeHandle<T: UserEvent>: Debug + Clone + Send + Sync + Sized + 'static {
281  type Runtime: Runtime<T, Handle = Self>;
282
283  /// Creates an `EventLoopProxy` that can be used to dispatch user events to the main event loop.
284  fn create_proxy(&self) -> <Self::Runtime as Runtime<T>>::EventLoopProxy;
285
286  /// Sets the activation policy for the application.
287  #[cfg(target_os = "macos")]
288  #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
289  fn set_activation_policy(&self, activation_policy: ActivationPolicy) -> Result<()>;
290
291  /// Sets the dock visibility for the application.
292  ///
293  #[cfg(target_os = "macos")]
294  #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
295  fn set_dock_visibility(&self, visible: bool) -> Result<()>;
296
297  /// Requests an exit of the event loop.
298  fn request_exit(&self, code: i32) -> Result<()>;
299
300  /// Create a new window.
301  fn create_window<F: Fn(RawWindow) + Send + 'static>(
302    &self,
303    pending: PendingWindow<T, Self::Runtime>,
304    after_window_creation: Option<F>,
305  ) -> Result<DetachedWindow<T, Self::Runtime>>;
306
307  /// Create a new webview.
308  fn create_webview(
309    &self,
310    window_id: WindowId,
311    pending: PendingWebview<T, Self::Runtime>,
312  ) -> Result<DetachedWebview<T, Self::Runtime>>;
313
314  /// Run a task on the main thread.
315  fn run_on_main_thread<F: FnOnce() + Send + 'static>(&self, f: F) -> Result<()>;
316
317  fn display_handle(&self) -> std::result::Result<DisplayHandle, raw_window_handle::HandleError>;
318
319  fn primary_monitor(&self) -> Option<Monitor>;
320  fn monitor_from_point(&self, x: f64, y: f64) -> Option<Monitor>;
321  fn available_monitors(&self) -> Vec<Monitor>;
322
323  fn cursor_position(&self) -> Result<PhysicalPosition<f64>>;
324
325  fn set_theme(&self, theme: Option<Theme>);
326
327  /// Shows the application, but does not automatically focus it.
328  #[cfg(target_os = "macos")]
329  #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
330  fn show(&self) -> Result<()>;
331
332  /// Hides the application.
333  #[cfg(target_os = "macos")]
334  #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
335  fn hide(&self) -> Result<()>;
336
337  /// Finds an Android class in the project scope.
338  #[cfg(target_os = "android")]
339  fn find_class<'a>(
340    &self,
341    env: &mut jni::JNIEnv<'a>,
342    activity: &jni::objects::JObject<'_>,
343    name: impl Into<String>,
344  ) -> std::result::Result<jni::objects::JClass<'a>, jni::errors::Error>;
345
346  /// Dispatch a closure to run on the Android context.
347  ///
348  /// The closure takes the JNI env, the Android activity instance and the possibly null webview.
349  #[cfg(target_os = "android")]
350  fn run_on_android_context<F>(&self, f: F)
351  where
352    F: FnOnce(&mut jni::JNIEnv, &jni::objects::JObject, &jni::objects::JObject) + Send + 'static;
353
354  #[cfg(any(target_os = "macos", target_os = "ios"))]
355  #[cfg_attr(docsrs, doc(cfg(any(target_os = "macos", target_os = "ios"))))]
356  fn fetch_data_store_identifiers<F: FnOnce(Vec<[u8; 16]>) + Send + 'static>(
357    &self,
358    cb: F,
359  ) -> Result<()>;
360
361  #[cfg(any(target_os = "macos", target_os = "ios"))]
362  #[cfg_attr(docsrs, doc(cfg(any(target_os = "macos", target_os = "ios"))))]
363  fn remove_data_store<F: FnOnce(Result<()>) + Send + 'static>(
364    &self,
365    uuid: [u8; 16],
366    cb: F,
367  ) -> Result<()>;
368}
369
370pub trait EventLoopProxy<T: UserEvent>: Debug + Clone + Send + Sync {
371  fn send_event(&self, event: T) -> Result<()>;
372}
373
374#[derive(Default)]
375pub struct RuntimeInitArgs {
376  #[cfg(any(
377    target_os = "linux",
378    target_os = "dragonfly",
379    target_os = "freebsd",
380    target_os = "netbsd",
381    target_os = "openbsd"
382  ))]
383  pub app_id: Option<String>,
384  #[cfg(windows)]
385  pub msg_hook: Option<Box<dyn FnMut(*const std::ffi::c_void) -> bool + 'static>>,
386}
387
388/// The webview runtime interface.
389pub trait Runtime<T: UserEvent>: Debug + Sized + 'static {
390  /// The window message dispatcher.
391  type WindowDispatcher: WindowDispatch<T, Runtime = Self>;
392  /// The webview message dispatcher.
393  type WebviewDispatcher: WebviewDispatch<T, Runtime = Self>;
394  /// The runtime handle type.
395  type Handle: RuntimeHandle<T, Runtime = Self>;
396  /// The proxy type.
397  type EventLoopProxy: EventLoopProxy<T>;
398
399  /// Creates a new webview runtime. Must be used on the main thread.
400  fn new(args: RuntimeInitArgs) -> Result<Self>;
401
402  /// Creates a new webview runtime on any thread.
403  #[cfg(any(windows, target_os = "linux"))]
404  #[cfg_attr(docsrs, doc(cfg(any(windows, target_os = "linux"))))]
405  fn new_any_thread(args: RuntimeInitArgs) -> Result<Self>;
406
407  /// Creates an `EventLoopProxy` that can be used to dispatch user events to the main event loop.
408  fn create_proxy(&self) -> Self::EventLoopProxy;
409
410  /// Gets a runtime handle.
411  fn handle(&self) -> Self::Handle;
412
413  /// Create a new window.
414  fn create_window<F: Fn(RawWindow) + Send + 'static>(
415    &self,
416    pending: PendingWindow<T, Self>,
417    after_window_creation: Option<F>,
418  ) -> Result<DetachedWindow<T, Self>>;
419
420  /// Create a new webview.
421  fn create_webview(
422    &self,
423    window_id: WindowId,
424    pending: PendingWebview<T, Self>,
425  ) -> Result<DetachedWebview<T, Self>>;
426
427  fn primary_monitor(&self) -> Option<Monitor>;
428  fn monitor_from_point(&self, x: f64, y: f64) -> Option<Monitor>;
429  fn available_monitors(&self) -> Vec<Monitor>;
430
431  fn cursor_position(&self) -> Result<PhysicalPosition<f64>>;
432
433  fn set_theme(&self, theme: Option<Theme>);
434
435  /// Sets the activation policy for the application.
436  #[cfg(target_os = "macos")]
437  #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
438  fn set_activation_policy(&mut self, activation_policy: ActivationPolicy);
439
440  /// Sets the dock visibility for the application.
441  ///
442  #[cfg(target_os = "macos")]
443  #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
444  fn set_dock_visibility(&mut self, visible: bool);
445
446  /// Shows the application, but does not automatically focus it.
447  #[cfg(target_os = "macos")]
448  #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
449  fn show(&self);
450
451  /// Hides the application.
452  #[cfg(target_os = "macos")]
453  #[cfg_attr(docsrs, doc(cfg(target_os = "macos")))]
454  fn hide(&self);
455
456  /// Change the device event filter mode.
457  ///
458  /// Since the DeviceEvent capture can lead to high CPU usage for unfocused windows, [`tao`]
459  /// will ignore them by default for unfocused windows on Windows. This method allows changing
460  /// the filter to explicitly capture them again.
461  ///
462  /// ## Platform-specific
463  ///
464  /// - ** Linux / macOS / iOS / Android**: Unsupported.
465  ///
466  /// [`tao`]: https://crates.io/crates/tao
467  fn set_device_event_filter(&mut self, filter: DeviceEventFilter);
468
469  /// Runs an iteration of the runtime event loop and returns control flow to the caller.
470  #[cfg(desktop)]
471  fn run_iteration<F: FnMut(RunEvent<T>) + 'static>(&mut self, callback: F);
472
473  /// Equivalent to [`Runtime::run`] but returns the exit code instead of exiting the process.
474  fn run_return<F: FnMut(RunEvent<T>) + 'static>(self, callback: F) -> i32;
475
476  /// Run the webview runtime.
477  fn run<F: FnMut(RunEvent<T>) + 'static>(self, callback: F);
478}
479
480/// Webview dispatcher. A thread-safe handle to the webview APIs.
481pub trait WebviewDispatch<T: UserEvent>: Debug + Clone + Send + Sync + Sized + 'static {
482  /// The runtime this [`WebviewDispatch`] runs under.
483  type Runtime: Runtime<T>;
484
485  /// Run a task on the main thread.
486  fn run_on_main_thread<F: FnOnce() + Send + 'static>(&self, f: F) -> Result<()>;
487
488  /// Registers a webview event handler.
489  fn on_webview_event<F: Fn(&WebviewEvent) + Send + 'static>(&self, f: F) -> WebviewEventId;
490
491  /// Runs a closure with the platform webview object as argument.
492  fn with_webview<F: FnOnce(Box<dyn std::any::Any>) + Send + 'static>(&self, f: F) -> Result<()>;
493
494  /// Open the web inspector which is usually called devtools.
495  #[cfg(any(debug_assertions, feature = "devtools"))]
496  fn open_devtools(&self);
497
498  /// Close the web inspector which is usually called devtools.
499  #[cfg(any(debug_assertions, feature = "devtools"))]
500  fn close_devtools(&self);
501
502  /// Gets the devtools window's current open state.
503  #[cfg(any(debug_assertions, feature = "devtools"))]
504  fn is_devtools_open(&self) -> Result<bool>;
505
506  // GETTERS
507
508  /// Returns the webview's current URL.
509  fn url(&self) -> Result<String>;
510
511  /// Returns the webview's bounds.
512  fn bounds(&self) -> Result<Rect>;
513
514  /// Returns the position of the top-left hand corner of the webviews's client area relative to the top-left hand corner of the window.
515  fn position(&self) -> Result<PhysicalPosition<i32>>;
516
517  /// Returns the physical size of the webviews's client area.
518  fn size(&self) -> Result<PhysicalSize<u32>>;
519
520  // SETTER
521
522  /// Navigate to the given URL.
523  fn navigate(&self, url: Url) -> Result<()>;
524
525  /// Reloads the current page.
526  fn reload(&self) -> Result<()>;
527
528  /// Opens the dialog to prints the contents of the webview.
529  fn print(&self) -> Result<()>;
530
531  /// Closes the webview.
532  fn close(&self) -> Result<()>;
533
534  /// Sets the webview's bounds.
535  fn set_bounds(&self, bounds: Rect) -> Result<()>;
536
537  /// Resizes the webview.
538  fn set_size(&self, size: Size) -> Result<()>;
539
540  /// Updates the webview position.
541  fn set_position(&self, position: Position) -> Result<()>;
542
543  /// Bring the window to front and focus the webview.
544  fn set_focus(&self) -> Result<()>;
545
546  /// Hide the webview
547  fn hide(&self) -> Result<()>;
548
549  /// Show the webview
550  fn show(&self) -> Result<()>;
551
552  /// Executes javascript on the window this [`WindowDispatch`] represents.
553  fn eval_script<S: Into<String>>(&self, script: S) -> Result<()>;
554
555  /// Moves the webview to the given window.
556  fn reparent(&self, window_id: WindowId) -> Result<()>;
557
558  /// Get cookies for a particular url.
559  ///
560  /// # Stability
561  ///
562  /// The return value of this function leverages [`cookie::Cookie`] which re-exports the cookie crate.
563  /// This dependency might receive updates in minor Tauri releases.
564  fn cookies_for_url(&self, url: Url) -> Result<Vec<Cookie<'static>>>;
565
566  /// Return all cookies in the cookie store.
567  ///
568  /// # Stability
569  ///
570  /// The return value of this function leverages [`cookie::Cookie`] which re-exports the cookie crate.
571  /// This dependency might receive updates in minor Tauri releases.
572  fn cookies(&self) -> Result<Vec<Cookie<'static>>>;
573
574  /// Sets whether the webview should automatically grow and shrink its size and position when the parent window resizes.
575  fn set_auto_resize(&self, auto_resize: bool) -> Result<()>;
576
577  /// Set the webview zoom level
578  fn set_zoom(&self, scale_factor: f64) -> Result<()>;
579
580  /// Set the webview background.
581  fn set_background_color(&self, color: Option<Color>) -> Result<()>;
582
583  /// Clear all browsing data for this webview.
584  fn clear_all_browsing_data(&self) -> Result<()>;
585}
586
587/// Window dispatcher. A thread-safe handle to the window APIs.
588pub trait WindowDispatch<T: UserEvent>: Debug + Clone + Send + Sync + Sized + 'static {
589  /// The runtime this [`WindowDispatch`] runs under.
590  type Runtime: Runtime<T>;
591
592  /// The window builder type.
593  type WindowBuilder: WindowBuilder;
594
595  /// Run a task on the main thread.
596  fn run_on_main_thread<F: FnOnce() + Send + 'static>(&self, f: F) -> Result<()>;
597
598  /// Registers a window event handler.
599  fn on_window_event<F: Fn(&WindowEvent) + Send + 'static>(&self, f: F) -> WindowEventId;
600
601  // GETTERS
602
603  /// Returns the scale factor that can be used to map logical pixels to physical pixels, and vice versa.
604  fn scale_factor(&self) -> Result<f64>;
605
606  /// 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.
607  fn inner_position(&self) -> Result<PhysicalPosition<i32>>;
608
609  /// Returns the position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.
610  fn outer_position(&self) -> Result<PhysicalPosition<i32>>;
611
612  /// Returns the physical size of the window's client area.
613  ///
614  /// The client area is the content of the window, excluding the title bar and borders.
615  fn inner_size(&self) -> Result<PhysicalSize<u32>>;
616
617  /// Returns the physical size of the entire window.
618  ///
619  /// These dimensions include the title bar and borders. If you don't want that (and you usually don't), use inner_size instead.
620  fn outer_size(&self) -> Result<PhysicalSize<u32>>;
621
622  /// Gets the window's current fullscreen state.
623  fn is_fullscreen(&self) -> Result<bool>;
624
625  /// Gets the window's current minimized state.
626  fn is_minimized(&self) -> Result<bool>;
627
628  /// Gets the window's current maximized state.
629  fn is_maximized(&self) -> Result<bool>;
630
631  /// Gets the window's current focus state.
632  fn is_focused(&self) -> Result<bool>;
633
634  /// Gets the window's current decoration state.
635  fn is_decorated(&self) -> Result<bool>;
636
637  /// Gets the window's current resizable state.
638  fn is_resizable(&self) -> Result<bool>;
639
640  /// Gets the window's native maximize button state.
641  ///
642  /// ## Platform-specific
643  ///
644  /// - **Linux / iOS / Android:** Unsupported.
645  fn is_maximizable(&self) -> Result<bool>;
646
647  /// Gets the window's native minimize button state.
648  ///
649  /// ## Platform-specific
650  ///
651  /// - **Linux / iOS / Android:** Unsupported.
652  fn is_minimizable(&self) -> Result<bool>;
653
654  /// Gets the window's native close button state.
655  ///
656  /// ## Platform-specific
657  ///
658  /// - **iOS / Android:** Unsupported.
659  fn is_closable(&self) -> Result<bool>;
660
661  /// Gets the window's current visibility state.
662  fn is_visible(&self) -> Result<bool>;
663
664  /// Whether the window is enabled or disable.
665  fn is_enabled(&self) -> Result<bool>;
666
667  /// Gets the window alwaysOnTop flag state.
668  ///
669  /// ## Platform-specific
670  ///
671  /// - **iOS / Android:** Unsupported.
672  fn is_always_on_top(&self) -> Result<bool>;
673
674  /// Gets the window's current title.
675  fn title(&self) -> Result<String>;
676
677  /// Returns the monitor on which the window currently resides.
678  ///
679  /// Returns None if current monitor can't be detected.
680  fn current_monitor(&self) -> Result<Option<Monitor>>;
681
682  /// Returns the primary monitor of the system.
683  ///
684  /// Returns None if it can't identify any monitor as a primary one.
685  fn primary_monitor(&self) -> Result<Option<Monitor>>;
686
687  /// Returns the monitor that contains the given point.
688  fn monitor_from_point(&self, x: f64, y: f64) -> Result<Option<Monitor>>;
689
690  /// Returns the list of all the monitors available on the system.
691  fn available_monitors(&self) -> Result<Vec<Monitor>>;
692
693  /// Returns the `ApplicationWindow` from gtk crate that is used by this window.
694  #[cfg(any(
695    target_os = "linux",
696    target_os = "dragonfly",
697    target_os = "freebsd",
698    target_os = "netbsd",
699    target_os = "openbsd"
700  ))]
701  fn gtk_window(&self) -> Result<gtk::ApplicationWindow>;
702
703  /// Returns the vertical [`gtk::Box`] that is added by default as the sole child of this window.
704  #[cfg(any(
705    target_os = "linux",
706    target_os = "dragonfly",
707    target_os = "freebsd",
708    target_os = "netbsd",
709    target_os = "openbsd"
710  ))]
711  fn default_vbox(&self) -> Result<gtk::Box>;
712
713  /// Raw window handle.
714  fn window_handle(
715    &self,
716  ) -> std::result::Result<raw_window_handle::WindowHandle<'_>, raw_window_handle::HandleError>;
717
718  /// Returns the current window theme.
719  fn theme(&self) -> Result<Theme>;
720
721  // SETTERS
722
723  /// Centers the window.
724  fn center(&self) -> Result<()>;
725
726  /// Requests user attention to the window.
727  ///
728  /// Providing `None` will unset the request for user attention.
729  fn request_user_attention(&self, request_type: Option<UserAttentionType>) -> Result<()>;
730
731  /// Create a new window.
732  fn create_window<F: Fn(RawWindow) + Send + 'static>(
733    &mut self,
734    pending: PendingWindow<T, Self::Runtime>,
735    after_window_creation: Option<F>,
736  ) -> Result<DetachedWindow<T, Self::Runtime>>;
737
738  /// Create a new webview.
739  fn create_webview(
740    &mut self,
741    pending: PendingWebview<T, Self::Runtime>,
742  ) -> Result<DetachedWebview<T, Self::Runtime>>;
743
744  /// Updates the window resizable flag.
745  fn set_resizable(&self, resizable: bool) -> Result<()>;
746
747  /// Enable or disable the window.
748  ///
749  /// ## Platform-specific
750  ///
751  /// - **Android / iOS**: Unsupported.
752  fn set_enabled(&self, enabled: bool) -> Result<()>;
753
754  /// Updates the window's native maximize button state.
755  ///
756  /// ## Platform-specific
757  ///
758  /// - **macOS:** Disables the "zoom" button in the window titlebar, which is also used to enter fullscreen mode.
759  /// - **Linux / iOS / Android:** Unsupported.
760  fn set_maximizable(&self, maximizable: bool) -> Result<()>;
761
762  /// Updates the window's native minimize button state.
763  ///
764  /// ## Platform-specific
765  ///
766  /// - **Linux / iOS / Android:** Unsupported.
767  fn set_minimizable(&self, minimizable: bool) -> Result<()>;
768
769  /// Updates the window's native close button state.
770  ///
771  /// ## Platform-specific
772  ///
773  /// - **Linux:** "GTK+ will do its best to convince the window manager not to show a close button.
774  ///   Depending on the system, this function may not have any effect when called on a window that is already visible"
775  /// - **iOS / Android:** Unsupported.
776  fn set_closable(&self, closable: bool) -> Result<()>;
777
778  /// Updates the window title.
779  fn set_title<S: Into<String>>(&self, title: S) -> Result<()>;
780
781  /// Maximizes the window.
782  fn maximize(&self) -> Result<()>;
783
784  /// Unmaximizes the window.
785  fn unmaximize(&self) -> Result<()>;
786
787  /// Minimizes the window.
788  fn minimize(&self) -> Result<()>;
789
790  /// Unminimizes the window.
791  fn unminimize(&self) -> Result<()>;
792
793  /// Shows the window.
794  fn show(&self) -> Result<()>;
795
796  /// Hides the window.
797  fn hide(&self) -> Result<()>;
798
799  /// Closes the window.
800  fn close(&self) -> Result<()>;
801
802  /// Destroys the window.
803  fn destroy(&self) -> Result<()>;
804
805  /// Updates the decorations flag.
806  fn set_decorations(&self, decorations: bool) -> Result<()>;
807
808  /// Updates the shadow flag.
809  fn set_shadow(&self, enable: bool) -> Result<()>;
810
811  /// Updates the window alwaysOnBottom flag.
812  fn set_always_on_bottom(&self, always_on_bottom: bool) -> Result<()>;
813
814  /// Updates the window alwaysOnTop flag.
815  fn set_always_on_top(&self, always_on_top: bool) -> Result<()>;
816
817  /// Updates the window visibleOnAllWorkspaces flag.
818  fn set_visible_on_all_workspaces(&self, visible_on_all_workspaces: bool) -> Result<()>;
819
820  /// Set the window background.
821  fn set_background_color(&self, color: Option<Color>) -> Result<()>;
822
823  /// Prevents the window contents from being captured by other apps.
824  fn set_content_protected(&self, protected: bool) -> Result<()>;
825
826  /// Resizes the window.
827  fn set_size(&self, size: Size) -> Result<()>;
828
829  /// Updates the window min inner size.
830  fn set_min_size(&self, size: Option<Size>) -> Result<()>;
831
832  /// Updates the window max inner size.
833  fn set_max_size(&self, size: Option<Size>) -> Result<()>;
834
835  /// Sets this window's minimum inner width.
836  fn set_size_constraints(&self, constraints: WindowSizeConstraints) -> Result<()>;
837
838  /// Updates the window position.
839  fn set_position(&self, position: Position) -> Result<()>;
840
841  /// Updates the window fullscreen state.
842  fn set_fullscreen(&self, fullscreen: bool) -> Result<()>;
843
844  /// Bring the window to front and focus.
845  fn set_focus(&self) -> Result<()>;
846
847  /// Updates the window icon.
848  fn set_icon(&self, icon: Icon) -> Result<()>;
849
850  /// Whether to hide the window icon from the taskbar or not.
851  fn set_skip_taskbar(&self, skip: bool) -> Result<()>;
852
853  /// Grabs the cursor, preventing it from leaving the window.
854  ///
855  /// There's no guarantee that the cursor will be hidden. You should
856  /// hide it by yourself if you want so.
857  fn set_cursor_grab(&self, grab: bool) -> Result<()>;
858
859  /// Modifies the cursor's visibility.
860  ///
861  /// If `false`, this will hide the cursor. If `true`, this will show the cursor.
862  fn set_cursor_visible(&self, visible: bool) -> Result<()>;
863
864  // Modifies the cursor icon of the window.
865  fn set_cursor_icon(&self, icon: CursorIcon) -> Result<()>;
866
867  /// Changes the position of the cursor in window coordinates.
868  fn set_cursor_position<Pos: Into<Position>>(&self, position: Pos) -> Result<()>;
869
870  /// Ignores the window cursor events.
871  fn set_ignore_cursor_events(&self, ignore: bool) -> Result<()>;
872
873  /// Starts dragging the window.
874  fn start_dragging(&self) -> Result<()>;
875
876  /// Starts resize-dragging the window.
877  fn start_resize_dragging(&self, direction: ResizeDirection) -> Result<()>;
878
879  /// Sets the badge count on the taskbar
880  /// The badge count appears as a whole for the application
881  /// Using `0` or using `None` will remove the badge
882  ///
883  /// ## Platform-specific
884  /// - **Windows:** Unsupported, use [`WindowDispatch::set_overlay_icon`] instead.
885  /// - **Android:** Unsupported.
886  /// - **iOS:** iOS expects i32, if the value is larger than i32::MAX, it will be clamped to i32::MAX.
887  fn set_badge_count(&self, count: Option<i64>, desktop_filename: Option<String>) -> Result<()>;
888
889  /// Sets the badge count on the taskbar **macOS only**. Using `None` will remove the badge
890  fn set_badge_label(&self, label: Option<String>) -> Result<()>;
891
892  /// Sets the overlay icon on the taskbar **Windows only**. Using `None` will remove the icon
893  ///
894  /// The overlay icon can be unique for each window.
895  fn set_overlay_icon(&self, icon: Option<Icon>) -> Result<()>;
896
897  /// Sets the taskbar progress state.
898  ///
899  /// ## Platform-specific
900  ///
901  /// - **Linux / macOS**: Progress bar is app-wide and not specific to this window. Only supported desktop environments with `libunity` (e.g. GNOME).
902  /// - **iOS / Android:** Unsupported.
903  fn set_progress_bar(&self, progress_state: ProgressBarState) -> Result<()>;
904
905  /// Sets the title bar style. Available on macOS only.
906  ///
907  /// ## Platform-specific
908  ///
909  /// - **Linux / Windows / iOS / Android:** Unsupported.
910  fn set_title_bar_style(&self, style: tauri_utils::TitleBarStyle) -> Result<()>;
911
912  /// Change the position of the window controls. Available on macOS only.
913  ///
914  /// Requires titleBarStyle: Overlay and decorations: true.
915  ///
916  /// ## Platform-specific
917  ///
918  /// - **Linux / Windows / iOS / Android:** Unsupported.
919  fn set_traffic_light_position(&self, position: Position) -> Result<()>;
920
921  /// Sets the theme for this window.
922  ///
923  /// ## Platform-specific
924  ///
925  /// - **Linux / macOS**: Theme is app-wide and not specific to this window.
926  /// - **iOS / Android:** Unsupported.
927  fn set_theme(&self, theme: Option<Theme>) -> Result<()>;
928}
tauri_runtime/lib.rs

tauri_runtime/
lib.rs
