Struct nw_sys::window::Options

Implementations§

impl Options

pub fn id(self, id: &str) -> Self

the id used to identify the window. This will be used to remember the size and position of the window and restore that geometry when a window with the same id is later opened. See also the Chrome App documentation ⧉ NWJS Documentation

pub fn title(self, title: &str) -> Self

The default title of window created by NW.js, . it’s very useful if you want to show your own title when the app is starting

pub fn width(self, width: u32) -> Self

the initial inner width of the window.

pub fn height(self, height: u32) -> Self

the initial inner height of the window.

pub fn icon(self, icon: &String) -> Self

path to window’s icon.

pub fn position(self, position: WindowPosition) -> Self

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

pub fn min_width(self, min_width: u32) -> Self

minimum inner width of window

pub fn min_height(self, min_height: u32) -> Self

minimum inner height of window

pub fn max_width(self, max_width: u32) -> Self

maximum inner width of window

pub fn max_height(self, max_height: u32) -> Self

maximum inner height of window

pub fn as_desktop(self, as_desktop: bool) -> Self

(Linux) show as desktop background window under X11 environment

pub fn resizable(self, resizable: bool) -> Self

whether window is resizable

pub fn always_on_top(self, always_on_top: bool) -> Self

whether the window should always stay on top of other windows.

pub fn visible_on_all_workspaces(self, visible_on_all_workspaces: bool) -> Self

whether the window should be visible on all workspaces simultaneously (on platforms that support multiple workspaces, currently Mac OS X and Linux).

pub fn fullscreen(self, fullscreen: bool) -> Self

whether window is fullscreen

Beware, if frame is also set to false in fullscreen it will prevent the mouse from being captured on the very edges of the screen. You should avoid activate it if fullscreen is also set to true.

pub fn show_in_taskbar(self, show_in_taskbar: bool) -> Self

whether the window is shown in taskbar or dock. The default is true.

pub fn frame(self, frame: bool) -> Self

specify it to false to make the window frameless

Beware, if frame is set to false in fullscreen it will prevent the mouse from being captured on the very edges of the screen. You should avoid activating it if fullscreen is also set to true.

Frameless apps do not have a title bar for the user to click and drag the window. You can use CSS to designate DOM elements as draggable regions.

.drag-enable {
  -webkit-app-region: drag;
}
.drag-disable {
  -webkit-app-region: no-drag;
}

pub fn show(self, show: bool) -> Self

specify it to false if you want your app to be hidden on startup

pub fn kiosk(self, kiosk: bool) -> Self

whether to use 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

pub fn transparent(self, transparent: bool) -> Self

whether to turn on transparent window mode. The default is false. Control the transparency with rgba background value in CSS. Use command line option --disable-transparency to disable this feature completely.

There is experimental support for “click-through” on the transparent region: add --disable-gpu option to the command line.

pub fn left(self, left: u32) -> Self

the initial left of the window.

pub fn top(self, top: u32) -> Self

the initial top of the window.

pub fn new_instance(self, value: bool) -> Self

whether to open a new window in a separate render process.

pub fn mixed_context(self, value: bool) -> Self

If true, the Node context and DOM context are merged in the new window’s process. Use only when new_instance is true.

pub fn inject_js_start(self, js: &str) -> Self

the script to be injected before any DOM is constructed and any script is run.

pub fn inject_js_end(self, js: &str) -> Self

the script to be injected after the document object is loaded, before onload event is fired.

Methods from Deref<Target = Object>§

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

Methods from Deref<Target = JsValue>§

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_array(&self) -> bool

Tests whether this JS value is an instance of Array.

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.

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

Applies the binary in JS operator on the two JsValues.

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.

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

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

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

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

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

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

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

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

Applies the binary < JS operator on the two JsValues.

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

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

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

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

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

Applies the binary > JS operator on the two JsValues.

pub fn unchecked_into_f64(&self) -> f64

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

Trait Implementations§

impl AsRef<JsValue> for Options

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for Options

fn as_ref(&self) -> &Object

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

impl AsRef<Options> for Options

fn as_ref(&self) -> &Options

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

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Options

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

Formats the value using the given formatter. Read more

impl Deref for Options

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl Display for Options

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

Formats the value using the given formatter. Read more

impl From<JsValue> for Options

fn from(obj: JsValue) -> Options

Converts to this type from the input type.

impl From<Options> for JsValue

fn from(obj: Options) -> JsValue

Converts to this type from the input type.

impl From<Options> for Object

fn from(obj: Options) -> Object

Converts to this type from the input type.

impl FromWasmAbi for Options

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. Read more

impl<'a> IntoWasmAbi for &'a Options

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 Options

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 Options

fn instanceof(val: &JsValue) -> bool

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

fn unchecked_from_js(val: JsValue) -> Self

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

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

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

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

Test whether this JS value has a type T. Read more

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. Read more

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. Read more

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

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

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

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

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

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

fn is_type_of(val: &JsValue) -> bool

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

impl LongRefFromWasmAbi for Options

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Options

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Options

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 Options

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for Options

fn none() -> Self::Abi

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

impl OptionsTrait for Options

fn new() -> Selfwhere Self: JsCast,

“Construct a new Options.

fn initialize(self) -> Selfwhere Self: JsCast,

fn set(self, key: &str, value: JsValue) -> Selfwhere Self: JsCast,

impl PartialEq<Options> for Options

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

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefFromWasmAbi for Options

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Options>

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.