Struct tauri::Window

pub struct Window<P: Params> { /* 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.

TODO: expand these docs since this is a pretty important type

Implementations

impl<P: Params> Window<P>

pub fn label(&self) -> &P::Label

The label of this window.

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

Emits an event to the current window.

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

Emits an event on all windows except this one.

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

Listen to an event on this window.

pub fn once<F>(&self, event: P::Event, 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: P::Event, data: Option<String>)

Triggers an event on this window.

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

Evaluates JavaScript on this window.

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_width(&self, width: impl Into<f64>) -> Result<()>

Sets this window’s width.

pub fn set_height(&self, height: impl Into<f64>) -> Result<()>

Sets this window’s height.

pub fn resize(
    &self,
    width: impl Into<f64>,
    height: impl Into<f64>
) -> Result<()>

Resizes this window.

pub fn set_min_size(
    &self,
    min_width: impl Into<f64>,
    min_height: impl Into<f64>
) -> Result<()>

Sets this window’s minimum size.

pub fn set_max_size(
    &self,
    max_width: impl Into<f64>,
    max_height: impl Into<f64>
) -> Result<()>

Sets this window’s maximum size.

pub fn set_x(&self, x: impl Into<f64>) -> Result<()>

Sets this window’s x position.

pub fn set_y(&self, y: impl Into<f64>) -> Result<()>

Sets this window’s y position.

pub fn set_position(&self, x: impl Into<f64>, y: impl Into<f64>) -> Result<()>

Sets this window’s position.

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

Determines if this window should be fullscreen.

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

Sets this window’ icon.

Trait Implementations

impl<M: Params> Clone for Window<M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Params> Eq for Window<P>

impl<P: Params> Hash for Window<P>

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

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

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

Feeds a slice of this type into the given Hasher.

impl<P: Params> Manager<P> for Window<P>

fn config(&self) -> &Config

The Config the manager was created with.

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

Emits a event to all windows.

fn emit_to<S: Serialize + Clone>(
    &self,
    label: &M::Label,
    event: M::Event,
    payload: Option<S>
) -> Result<()>

Emits an event to a window with the specified label.

fn create_window(&mut self, pending: PendingWindow<M>) -> Result<Window<M>>

Creates a new Window on the Runtime and attaches it to the Manager.

fn listen_global<F>(&self, event: M::Event, handler: F) -> EventHandler where
    F: Fn(Event) + Send + 'static, 

Listen to a global event.

fn once_global<F>(&self, event: M::Event, handler: F) -> EventHandler where
    F: Fn(Event) + Send + 'static, 

Listen to a global event only once.

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

Trigger a global event.

fn unlisten(&self, handler_id: EventHandler)

Remove an event listener.

fn get_window(&self, label: &M::Label) -> Option<Window<M>>

Fetch a single window from the manager.

fn windows(&self) -> HashMap<M::Label, Window<M>>

Fetch all managed windows.

impl<P: Params> PartialEq<Window<P>> for Window<P>

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

Only use the Window’s label to compare equality.

#[must_use]

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

This method tests for !=.