Trait tauri_runtime::Runtime

pub trait Runtime<T: UserEvent>: Debug + Sized + 'static {
    type Dispatcher: Dispatch<T, Runtime = Self>;
    type Handle: RuntimeHandle<T, Runtime = Self>;
    type GlobalShortcutManager: GlobalShortcutManager;
    type ClipboardManager: ClipboardManager;
    type TrayHandler: TrayHandle;
    type EventLoopProxy: EventLoopProxy<T>;

    fn new() -> Result<Self>;
    fn create_proxy(&self) -> Self::EventLoopProxy;
    fn handle(&self) -> Self::Handle;
    fn global_shortcut_manager(&self) -> Self::GlobalShortcutManager;
    fn clipboard_manager(&self) -> Self::ClipboardManager;
    fn create_window(
        &self,
        pending: PendingWindow<T, Self>
    ) -> Result<DetachedWindow<T, Self>>;
    fn system_tray(&self, system_tray: SystemTray) -> Result<Self::TrayHandler>;
    fn on_system_tray_event<F: Fn(TrayId, &SystemTrayEvent) + Send + 'static>(
        &mut self,
        f: F
    );
    fn set_activation_policy(&mut self, activation_policy: ActivationPolicy);
    fn show(&self);
    fn hide(&self);
    fn run_iteration<F: Fn(RunEvent<T>) + 'static>(
        &mut self,
        callback: F
    ) -> RunIteration;
    fn run<F: FnMut(RunEvent<T>) + 'static>(self, callback: F);
}

The webview runtime interface.

Required Associated Types

type Dispatcher: Dispatch<T, Runtime = Self>

The message dispatcher.

type Handle: RuntimeHandle<T, Runtime = Self>

The runtime handle type.

type GlobalShortcutManager: GlobalShortcutManager

The global shortcut manager type.

type ClipboardManager: ClipboardManager

The clipboard manager type.

type TrayHandler: TrayHandle

The tray handler type.

type EventLoopProxy: EventLoopProxy<T>

The proxy type.

Required Methods

fn new() -> Result<Self>

Creates a new webview runtime. Must be used on the main thread.

fn create_proxy(&self) -> Self::EventLoopProxy

Creates an EventLoopProxy that can be used to dispatch user events to the main event loop.

fn handle(&self) -> Self::Handle

Gets a runtime handle.

fn global_shortcut_manager(&self) -> Self::GlobalShortcutManager

Gets the global shortcut manager.

fn clipboard_manager(&self) -> Self::ClipboardManager

Gets the clipboard manager.

fn create_window(
    &self,
    pending: PendingWindow<T, Self>
) -> Result<DetachedWindow<T, Self>>

Create a new webview window.

fn system_tray(&self, system_tray: SystemTray) -> Result<Self::TrayHandler>

Available on crate feature system-tray only.

Adds the icon to the system tray with the specified menu items.

fn on_system_tray_event<F: Fn(TrayId, &SystemTrayEvent) + Send + 'static>(
    &mut self,
    f: F
)

Available on crate feature system-tray only.

Registers a system tray event handler.

fn set_activation_policy(&mut self, activation_policy: ActivationPolicy)

Available on macOS only.

Sets the activation policy for the application. It is set to NSApplicationActivationPolicyRegular by default.

fn show(&self)

Available on macOS only.

Shows the application, but does not automatically focus it.

fn hide(&self)

Available on macOS only.

Hides the application.

fn run_iteration<F: Fn(RunEvent<T>) + 'static>(
    &mut self,
    callback: F
) -> RunIteration

Runs the one step of the webview runtime event loop and returns control flow to the caller.

fn run<F: FnMut(RunEvent<T>) + 'static>(self, callback: F)

Run the webview runtime.

Implementors