Struct nw_sys::Window

#[repr(transparent)]
pub struct Window { /* private fields */ }

Interface for managing application windows. For usage example please refer to nw_sys::window

Implementations

impl Window

pub fn window(&self) -> Window

Get the corresponding DOM window object of the native window.

⧉ NWJS Documentation

impl Window

pub fn x(&self) -> i32

Get left offset from window frame to screen.

⧉ NWJS Documentation

impl Window

pub fn set_x(&self, x: i32)

Set left offset from window frame to screen.

⧉ NWJS Documentation

impl Window

pub fn y(&self) -> i32

Get top offset from window frame to screen.

⧉ NWJS Documentation

impl Window

pub fn set_y(&self, y: i32)

Set top offset from window frame to screen.

⧉ NWJS Documentation

impl Window

pub fn width(&self) -> u32

Get window’s size, including the window’s frame.

⧉ NWJS Documentation

impl Window

pub fn set_width(&self, width: u32)

Set window’s size, including the window’s frame.

⧉ NWJS Documentation

impl Window

pub fn height(&self) -> u32

Get window’s size, including the window’s frame.

⧉ NWJS Documentation

impl Window

pub fn set_height(&self, height: u32)

Set window’s size, including the window’s frame.

⧉ NWJS Documentation

impl Window

pub fn title(&self) -> String

Get window’s title.

⧉ NWJS Documentation

impl Window

pub fn set_title(&self, title: &str)

Set window’s title.

⧉ NWJS Documentation

impl Window

pub fn menu(&self) -> Menu

Get window’s menubar.

⧉ NWJS Documentation

impl Window

pub fn set_menu(&self, menu: &Menu)

Set window’s menubar.

⧉ NWJS Documentation

impl Window

pub fn remove_menu_impl(&self, menu: JsValue)

Set window’s menubar = null.

⧉ NWJS Documentation

impl Window

pub fn is_always_on_top(&self) -> bool

Get whether the window is always on top of other windows.

⧉ NWJS Documentation

impl Window

pub fn is_fullscreen(&self) -> bool

Get whether we’re in fullscreen mode.

⧉ NWJS Documentation

impl Window

pub fn is_transparent(&self) -> bool

Get whether transparency is turned on

⧉ NWJS Documentation

impl Window

pub fn is_kiosk_mode(&self) -> bool

Get whether we’re in kiosk mode.

⧉ NWJS Documentation

impl Window

pub fn zoom_level(&self) -> i16

Get the page zoom. 0 for normal size; positive value for zooming in; negative value for zooming out.

⧉ NWJS Documentation

impl Window

pub fn set_zoom_level(&self, zoom: i16)

Set the page zoom. 0 for normal size; positive value for zooming in; negative value for zooming out.

⧉ NWJS Documentation

impl Window

pub fn move_to(&self, x: u32, y: u32)

Moves a window’s left and top edge to the specified coordinates.

⧉ NWJS Documentation

impl Window

pub fn move_by(&self, x: u32, y: u32)

Moves a window a specified number of pixels relative to its current coordinates.

⧉ NWJS Documentation

impl Window

pub fn resize_to(&self, width: u32, height: u32)

Resizes a window to the specified width and height.

⧉ NWJS Documentation

impl Window

pub fn set_inner_width(&self, width: u32)

Set the inner width of the window

⧉ NWJS Documentation

impl Window

pub fn set_inner_height(&self, height: u32)

Set the inner height of the window

⧉ NWJS Documentation

impl Window

pub fn resize_by(&self, width: u32, height: u32)

Resizes a window by the specified amount.

⧉ NWJS Documentation

impl Window

pub fn focus(&self)

Focus on the window.

⧉ NWJS Documentation

impl Window

pub fn blur(&self)

Move focus away. Usually it will move focus to other windows of your app, since on some platforms there is no concept of blur.

⧉ NWJS Documentation

impl Window

pub fn show(&self)

Show the window if it’s not shown.

⧉ NWJS Documentation

impl Window

pub fn set_show(&self, is_show: bool)

Show/Hide the window

⧉ NWJS Documentation

impl Window

pub fn hide(&self)

Hide the window. User will not be able to find the window once it’s hidden.

⧉ NWJS Documentation

impl Window

pub fn close(&self)

Closes the current window. You can prevent the closing by listening to the close event.

⧉ NWJS Documentation

impl Window

pub fn close_impl(&self, force: bool)

Closes the current window. You can prevent the closing by listening to the close event. if force is equals true, then the close event will be ignored.

⧉ NWJS Documentation

impl Window

pub fn reload(&self)

Reloads the current window.

⧉ NWJS Documentation

impl Window

pub fn reload_dev(&self)

Reloads the current page by starting a new renderer process from scratch.

⧉ NWJS Documentation

impl Window

pub fn reload_ignoring_cache(&self)

Like reload(), but don’t use caches (aka “shift-reload”).

⧉ NWJS Documentation

impl Window

pub fn maximize(&self)

Maximize the window on GTK and Windows, and zoom the window on Mac OS X.

⧉ NWJS Documentation

impl Window

pub fn unmaximize(&self)

Unmaximize the window, i.e. the reverse of maximize().

⧉ NWJS Documentation

impl Window

pub fn minimize(&self)

Minimize the window to task bar on Windows, iconify the window on GTK, and miniaturize the window on Mac OS X.

⧉ NWJS Documentation

impl Window

pub fn restore(&self)

Restore window to previous state after the window is minimized, i.e. the reverse of minimize(). It’s not named unminimize since restore is used commonly.

⧉ NWJS Documentation

impl Window

pub fn enter_fullscreen(&self)

Make the window fullscreen.

⧉ NWJS Documentation

impl Window

pub fn leave_fullscreen(&self)

Leave the fullscreen mode.

⧉ NWJS Documentation

impl Window

pub fn toggle_fullscreen(&self)

Toggle the fullscreen mode.

⧉ NWJS Documentation

impl Window

pub fn enter_kiosk_mode(&self)

Enter the Kiosk mode. In Kiosk mode, the app will be fullscreen and try to prevent users from leaving the app, so you should remember to provide a way in app to leave Kiosk mode. This mode is mainly used for presentation on public displays.

⧉ NWJS Documentation

impl Window

pub fn leave_kiosk_mode(&self)

Leave the Kiosk mode.

⧉ NWJS Documentation

impl Window

pub fn toggle_kiosk_mode(&self)

Toggle the kiosk mode.

⧉ NWJS Documentation

impl Window

pub fn set_transparent(&self, transparent: bool)

Turn on/off the transparency support.

See more info on Transparent Window.

⧉ NWJS Documentation

impl Window

pub fn set_shadow(&self, shadow: bool)

(Mac) Turn the window’s native shadow on/off. Useful for frameless, transparent windows.

⧉ NWJS Documentation

impl Window

pub fn show_dev_tools(&self)

Open the devtools to inspect the window.

⧉ NWJS Documentation

impl Window

pub fn show_dev_tools_with_id(&self, iframe_id: &str)

Open the devtools to inspect the window.

⧉ NWJS Documentation

impl Window

pub fn show_dev_tools_with_id_and_callback(
    &self,
    iframe_id: &str,
    callback: &Function
)

Open the devtools to inspect the window.

⧉ NWJS Documentation

impl Window

pub fn show_dev_tools_with_iframe(&self, iframe_element: &HtmlIFrameElement)

Open the devtools to inspect the window.

⧉ NWJS Documentation

impl Window

pub fn show_dev_tools_with_iframe_and_callback(
    &self,
    iframe_element: &HtmlIFrameElement,
    callback: &Function
)

Open the devtools to inspect the window.

⧉ NWJS Documentation

impl Window

pub fn close_dev_tools(&self)

Close the devtools window.

⧉ NWJS Documentation

impl Window

pub fn get_printers(&self, callback: &Function)

Enumerate the printers in the system. The callback function will receive an array of JSON objects for the printer information. The device name of the JSON object can be used as parameter in win.print()

⧉ NWJS Documentation

impl Window

pub fn is_dev_tools_open(&self) -> bool

Query the status of devtools window.

⧉ NWJS Documentation

impl Window

pub fn print(&self, options: &PrintOptions)

Print the web contents in the window with or without the need for user’s interaction.

⧉ NWJS Documentation

impl Window

pub fn set_maximum_size(&self, width: u32, height: u32)

Set window’s maximum size.

⧉ NWJS Documentation

impl Window

pub fn set_minimum_size(&self, width: u32, height: u32)

Set window’s minimum size.

⧉ NWJS Documentation

impl Window

pub fn set_resizable(&self, resizable: bool)

Set whether window is resizable.

⧉ NWJS Documentation

impl Window

pub fn set_always_on_top(&self, top: bool)

Sets the widget to be on top of all other windows in the window system.

⧉ NWJS Documentation

impl Window

pub fn set_visible_on_all_workspaces(&self, top: bool)

(Mac and Linux) Sets the widget to be on top of all other windows in the window system.

⧉ NWJS Documentation

impl Window

pub fn can_set_visible_on_all_workspaces(&self) -> bool

(Mac and Linux) Returns a boolean indicating if the platform (currently Mac OS X and Linux) support Window API method win.set_visible_on_all_workspaces(true/false).

⧉ NWJS Documentation

impl Window

pub fn set_position_impl(&self, position: JsValue)

Move window to specified position. Currently only center is supported on all platforms, which will put window in the middle of the screen.

There are three valid positions: null or center or mouse

⧉ NWJS Documentation

impl Window

pub fn set_show_in_taskbar(&self, show: bool)

Control whether to show window in taskbar or dock.

See also show_in_taskbar in Manifest-format.

⧉ NWJS Documentation

impl Window

pub fn request_attention(&self, attension: bool)

Request the user’s attension by making the window flashes in the task bar.

⧉ NWJS Documentation

impl Window

pub fn request_attention_with_number(&self, attension: i16)

Request the user’s attension by making the window flashes in the task bar.

On Mac, value < 0 will trigger NSInformationalRequest, while value > 0 will trigger NSCriticalRequest.

⧉ NWJS Documentation

impl Window

pub fn capture_page(&self, callback: &Function)

Captures the visible area of the window.

To capture the full page, see win.captureScreenshot.

⧉ NWJS Documentation

impl Window

pub fn capture_page_with_config(
    &self,
    callback: &Function,
    config: &CaptureConfig
)

Captures the visible area of the window.

To capture the full page, see win.captureScreenshot.

⧉ NWJS Documentation

impl Window

pub fn capture_screenshot(&self, config: &ScreenshotConfig) -> Promise

Captures the the window. It can be used to capture the full page beyond the visible area.

Note: This API is experimental and subject to change in the future.

⧉ NWJS Documentation

impl Window

pub fn capture_screenshot_with_callback(
    &self,
    config: &ScreenshotConfig,
    callback: &Function
)

Captures the the window. It can be used to capture the full page beyond the visible area.

Note: This API is experimental and subject to change in the future.

⧉ NWJS Documentation

impl Window

pub fn set_progress_bar(&self, progress: f32)

Set progress bar

Note: Only Ubuntu is supported, and you’ll need to specify the application .desktop file through NW_DESKTOP env.

If NW_DESKTOP env variable is not found, it uses nw.desktop by default.

⧉ NWJS Documentation

impl Window

pub fn set_badge_label(&self, label: &str)

Set the badge label on the window icon in taskbar or dock.

Note: This API is only supported on Ubuntu and the label is restricted to a string number only. You’ll also need to specify the .desktop file for your application (see the note on set_progress_bar)

⧉ NWJS Documentation

impl Window

pub fn eval_impl(&self, iframe: JsValue, script: &str)

Execute a piece of JavaScript in the frame.

⧉ NWJS Documentation

impl Window

pub fn eval_with_iframe(&self, iframe: &HtmlIFrameElement, script: &str)

Execute a piece of JavaScript in the frame.

⧉ NWJS Documentation

impl Window

pub fn eval_nw_bin_impl(&self, iframe: JsValue, script: JsValue)

Load and execute the compiled binary in the frame.

See Protect JavaScript Source Code.

⧉ NWJS Documentation

impl Window

pub fn eval_nw_bin_with_iframe_impl(
    &self,
    iframe: &HtmlIFrameElement,
    script: JsValue
)

Load and execute the compiled binary in the frame.

See Protect JavaScript Source Code.

⧉ NWJS Documentation

impl Window

pub fn eval_nw_bin_module_impl(
    &self,
    iframe: JsValue,
    script: JsValue,
    module_path: &str
)

Load and execute the compiled binary for Modules in the frame.

The binary should be compiled with nwjc –nw-module. The following code will load lib.bin as module and other modules can refer to it with something like import * from "./lib.js"

⧉ NWJS Documentation

impl Window

pub fn eval_nw_bin_module_with_iframe(
    &self,
    iframe: &HtmlIFrameElement,
    script: JsValue,
    module_path: &str
)

Load and execute the compiled binary for Modules in the frame.

The binary should be compiled with nwjc –nw-module. The following code will load lib.bin as module and other modules can refer to it with something like import * from "./lib.js"

⧉ NWJS Documentation

impl Window

pub fn remove_all_listeners(&self)

Removes all listeners

⧉ NWJS Documentation

impl Window

pub fn remove_all_listeners_with_name(&self, event_name: &str)

Removes all listeners of the specified event_name

⧉ NWJS Documentation

impl Window

pub fn on(&self, event_name: &str, callback: &Function)

Add event listener to the specified event_name

⧉ NWJS Documentation

impl Window

pub fn remove_menu(&self)

Set window’s menubar = null.

⧉ NWJS Documentation

pub fn close_with_force(&self)

Closes the current window without triggering close event.

⧉ NWJS Documentation

pub fn set_position(&self, position: WindowPosition)

Move window to specified position. Currently only center is supported on all platforms, which will put window in the middle of the screen.

There are three valid positions: null or center or mouse

⧉ NWJS Documentation

pub fn eval(&self, iframe: Option<HtmlIFrameElement>, script: &str)

Execute a piece of JavaScript in the frame.

⧉ NWJS Documentation

pub fn eval_nw_bin(&self, iframe: Option<HtmlIFrameElement>, script: NWBinary)

Load and execute the compiled binary in the frame.

See Protect JavaScript Source Code.

⧉ NWJS Documentation

pub fn eval_nw_bin_module(
    &self,
    iframe: Option<HtmlIFrameElement>,
    script: NWBinary,
    module_path: &str
)

Load and execute the compiled binary for Modules in the frame.

The binary should be compiled with nwjc –nw-module. The following code will load lib.bin as module and other modules can refer to it with something like import * from "./lib.js"

⧉ NWJS Documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = JsValue{ idx: JSIDX_NULL, _marker: marker::PhantomData,}

pub const UNDEFINED: JsValue = JsValue{ idx: JSIDX_UNDEFINED, _marker: marker::PhantomData,}

pub const TRUE: JsValue = JsValue{ idx: JSIDX_TRUE, _marker: marker::PhantomData,}

pub const FALSE: JsValue = JsValue{ idx: JSIDX_FALSE, _marker: marker::PhantomData,}

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Window

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Window> for Window

fn as_ref(&self) -> &Window

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Window

fn clone(&self) -> Window

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Window

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Window

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<JsValue> for Window

fn from(obj: JsValue) -> Window

Converts to this type from the input type.

impl From<Window> for JsValue

fn from(obj: Window) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for Window

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Window

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for Window

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Window

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> boolwhere
    T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>where
    T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>where
    T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> Twhere
    T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &Twhere
    T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> boolwhere
    T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl OptionFromWasmAbi for Window

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a Window

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for Window

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Window

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Window>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for Window

fn describe()