Struct tauri::window::Window

pub struct Window<R: Runtime = Wry> { /* fields omitted */ }

A webview window managed by Tauri.

This type also implements Manager which allows you to manage other windows attached to the same application.

Implementations

impl<R: Runtime> Window<R>

pub fn create_window<F>(
    &mut self,
    label: String,
    url: WindowUrl,
    setup: F
) -> Result<Window<R>> where
    F: FnOnce(<R::Dispatcher as Dispatch>::WindowBuilder, WebviewAttributes) -> (<R::Dispatcher as Dispatch>::WindowBuilder, WebviewAttributes), 

Creates a new webview window.

pub fn label(&self) -> &str

The label of this window.

pub fn emit<S: Serialize>(&self, event: &str, payload: S) -> Result<()>

Emits an event to the current window.

pub fn emit_others<S: Serialize + Clone>(
    &self,
    event: &str,
    payload: S
) -> Result<()>

Emits an event on all windows except this one.

pub fn listen<F>(&self, event: impl Into<String>, handler: F) -> EventHandler where
    F: Fn(Event) + Send + 'static, 

Listen to an event on this window.

pub fn once<F>(&self, event: impl Into<String>, handler: F) -> EventHandler where
    F: Fn(Event) + Send + 'static, 

Listen to a an event on this window a single time.

pub fn trigger(&self, event: &str, data: Option<String>)

Triggers an event on this window.

pub fn eval(&self, js: &str) -> Result<()>

Evaluates JavaScript on this window.

pub fn on_window_event<F: Fn(&WindowEvent) + Send + 'static>(&self, f: F)

Registers a window event listener.

pub fn on_menu_event<F: Fn(MenuEvent) + Send + 'static>(&self, f: F) -> Uuid

This is supported on crate feature menu only.

Registers a menu event listener.

pub fn menu_handle(&self) -> MenuHandle<R>

Gets a handle to the window menu.

pub fn scale_factor(&self) -> Result<f64>

Returns the scale factor that can be used to map logical pixels to physical pixels, and vice versa.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn inner_position(&self) -> Result<PhysicalPosition<i32>>

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.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn outer_position(&self) -> Result<PhysicalPosition<i32>>

Returns the position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn inner_size(&self) -> Result<PhysicalSize<u32>>

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.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn outer_size(&self) -> Result<PhysicalSize<u32>>

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.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn is_fullscreen(&self) -> Result<bool>

Gets the window’s current fullscreen state.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn is_maximized(&self) -> Result<bool>

Gets the window’s current maximized state.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn is_decorated(&self) -> Result<bool>

Gets the window’s current decoration state.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn is_resizable(&self) -> Result<bool>

Gets the window’s current resizable state.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn is_visible(&self) -> Result<bool>

Gets the window’s current vibility state.

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn current_monitor(&self) -> Result<Option<Monitor>>

Returns the monitor on which the window currently resides.

Returns None if current monitor can’t be detected.

Platform-specific

• Linux: Unsupported

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn primary_monitor(&self) -> Result<Option<Monitor>>

Returns the primary monitor of the system.

Returns None if it can’t identify any monitor as a primary one.

Platform-specific

• Linux: Unsupported

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn available_monitors(&self) -> Result<Vec<Monitor>>

Returns the list of all the monitors available on the system.

Platform-specific

• Linux: Unsupported

Panics

Panics if the app is not running yet, usually when called on the setup closure. You can spawn a task to use the API using the async_runtime to prevent the panic.

pub fn gtk_window(&self) -> Result<ApplicationWindow>

Returns the ApplicatonWindow from gtk crate that is used by this window.

Note that this can only be used on the main thread.

pub fn center(&self) -> Result<()>

Centers the window.

pub fn request_user_attention(
    &self,
    request_type: Option<UserAttentionType>
) -> Result<()>

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.

pub fn print(&self) -> Result<()>

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 set_resizable(&self, resizable: bool) -> Result<()>

Determines if this window should be resizable.

pub fn set_title(&self, title: &str) -> Result<()>

Set this window’s title.

pub fn maximize(&self) -> Result<()>

Maximizes this window.

pub fn unmaximize(&self) -> Result<()>

Un-maximizes this window.

pub fn minimize(&self) -> Result<()>

Minimizes this window.

pub fn unminimize(&self) -> Result<()>

Un-minimizes this window.

pub fn show(&self) -> Result<()>

Show this window.

pub fn hide(&self) -> Result<()>

Hide this window.

pub fn close(&self) -> Result<()>

Closes this window.

pub fn set_decorations(&self, decorations: bool) -> Result<()>

Determines if this window should be decorated.

pub fn set_always_on_top(&self, always_on_top: bool) -> Result<()>

Determines if this window should always be on top of other windows.

pub fn set_size<S: Into<Size>>(&self, size: S) -> Result<()>

Resizes this window.

pub fn set_min_size<S: Into<Size>>(&self, size: Option<S>) -> Result<()>

Sets this window’s minimum size.

pub fn set_max_size<S: Into<Size>>(&self, size: Option<S>) -> Result<()>

Sets this window’s maximum size.

pub fn set_position<Pos: Into<Position>>(&self, position: Pos) -> Result<()>

Sets this window’s position.

pub fn set_fullscreen(&self, fullscreen: bool) -> Result<()>

Determines if this window should be fullscreen.

pub fn set_focus(&self) -> Result<()>

Bring the window to front and focus.

pub fn set_icon(&self, icon: Icon) -> Result<()>

Sets this window’ icon.

pub fn set_skip_taskbar(&self, skip: bool) -> Result<()>

Whether to show the window icon in the task bar or not.

pub fn start_dragging(&self) -> Result<()>

Starts dragging the window.

Trait Implementations

impl<R: Runtime> Clone for Window<R>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'de, R: Runtime> CommandArg<'de, R> for Window<R>

fn from_command(command: CommandItem<'de, R>) -> Result<Self, InvokeError>

Grabs the Window from the CommandItem. This will never fail.

impl<R: Runtime> Hash for Window<R>

fn hash<H: Hasher>(&self, state: &mut H)

Only use the Window’s label to represent its hash.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<R: Runtime> Manager<R> for Window<R>

fn config(&self) -> Arc<Config>

The Config the manager was created with.

fn emit_all<S: Serialize + Clone>(&self, event: &str, payload: S) -> Result<()>

Emits a event to all windows.

fn emit_to<S: Serialize + Clone>(
    &self,
    label: &str,
    event: &str,
    payload: S
) -> Result<()>

Emits an event to a window with the specified label.

fn listen_global<F>(&self, event: impl Into<String>, handler: F) -> EventHandler where
    F: Fn(EmittedEvent) + Send + 'static, 

Listen to a global event.

fn once_global<F>(&self, event: impl Into<String>, handler: F) -> EventHandler where
    F: Fn(EmittedEvent) + Send + 'static, 

Listen to a global event only once.

fn trigger_global(&self, event: &str, data: Option<String>)

Trigger a global event.

fn unlisten(&self, handler_id: EventHandler)

Remove an event listener.

fn get_window(&self, label: &str) -> Option<Window<R>>

Fetch a single window from the manager.

fn windows(&self) -> HashMap<String, Window<R>>

Fetch all managed windows.

fn manage<T>(&self, state: T) where
    T: Send + Sync + 'static, 

Add state to the state managed by the application. See crate::Builder for instructions.

fn state<T>(&self) -> State<'_, T> where
    T: Send + Sync + 'static, 

Gets the managed state for the type T.

impl<R: Runtime> PartialEq<Window<R>> for Window<R>

fn eq(&self, other: &Self) -> bool

Only use the Window’s label to compare equality.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<R: Runtime> Eq for Window<R>