Struct BrowserWindow

pub struct BrowserWindow { /* private fields */ }

Docs: http://electronjs.org/docs/api/browser-window

Implementations

impl BrowserWindow

pub fn add_dev_tools_extension(path: &str)

impl BrowserWindow

pub fn add_extension(path: &str)

impl BrowserWindow

pub fn from_browser_view(browser_view: &BrowserView) -> Option<BrowserWindow>

impl BrowserWindow

pub fn from_id(id: u32) -> BrowserWindow

impl BrowserWindow

pub fn from_web_contents(web_contents: &WebContents) -> Option<BrowserWindow>

impl BrowserWindow

pub fn get_all_windows() -> Box<[JsValue]>

impl BrowserWindow

pub fn get_dev_tools_extension() -> Map

impl BrowserWindow

pub fn get_focused_window() -> Option<BrowserWindow>

impl BrowserWindow

pub fn remove_dev_tools_extension(name: &str)

impl BrowserWindow

pub fn remove_extension(name: &str)

impl BrowserWindow

pub fn new(options: Option<BrowserWindowOptions>) -> BrowserWindow

impl BrowserWindow

pub fn add_browser_view(&self, browser_view: &BrowserView)

impl BrowserWindow

pub fn add_tabbed_window(&self, browser_view: &BrowserWindow)

impl BrowserWindow

pub fn blur(&self)

impl BrowserWindow

pub fn blur_web_view(&self)

impl BrowserWindow

pub fn capture_page(&self, rectangle: Option<Rectangle>)

impl BrowserWindow

pub fn center(&self)

impl BrowserWindow

pub fn close(&self)

impl BrowserWindow

pub fn close_file_preview(&self)

impl BrowserWindow

pub fn destroy(&self)

impl BrowserWindow

pub fn flash_frame(&self)

impl BrowserWindow

pub fn focus(&self)

impl BrowserWindow

pub fn focus_on_web_view(&self)

impl BrowserWindow

pub fn get_bounds(&self) -> Rectangle

impl BrowserWindow

pub fn get_browser_view(&self) -> Option<BrowserView>

impl BrowserWindow

pub fn get_browser_views(&self) -> Box<[JsValue]>

impl BrowserWindow

pub fn get_child_windows(&self) -> Box<[JsValue]>

impl BrowserWindow

pub fn get_content_bounds(&self) -> Rectangle

impl BrowserWindow

pub fn get_content_size(&self) -> Box<[u32]>

impl BrowserWindow

pub fn get_maximum_size(&self) -> Box<[u32]>

impl BrowserWindow

pub fn get_media_source_id(&self) -> JsString

impl BrowserWindow

pub fn get_minimum_size(&self) -> Box<[JsValue]>

impl BrowserWindow

pub fn get_native_window_handle(&self) -> Buffer

impl BrowserWindow

pub fn get_normal_bounds(&self) -> Rectangle

impl BrowserWindow

pub fn get_opacity(&self) -> f32

impl BrowserWindow

pub fn get_parent_window(&self) -> BrowserWindow

impl BrowserWindow

pub fn get_position(&self) -> Box<[JsValue]>

impl BrowserWindow

pub fn get_represented_filename(&self) -> Box<[JsValue]>

impl BrowserWindow

pub fn get_size(&self) -> Box<[JsValue]>

impl BrowserWindow

pub fn get_title(&self) -> JsString

impl BrowserWindow

pub fn has_shadow(&self) -> bool

impl BrowserWindow

pub fn hide(&self)

impl BrowserWindow

pub fn hook_window_message(&self, message: u32, callback: &Function)

impl BrowserWindow

pub fn is_always_on_top(&self) -> bool

impl BrowserWindow

pub fn is_destroyed(&self) -> bool

impl BrowserWindow

pub fn is_document_edited(&self) -> bool

impl BrowserWindow

pub fn is_enabled(&self) -> bool

impl BrowserWindow

pub fn is_focused(&self) -> bool

impl BrowserWindow

pub fn is_full_screenable(&self) -> bool

impl BrowserWindow

pub fn is_kiosk(&self) -> bool

impl BrowserWindow

pub fn is_maximized(&self) -> bool

impl BrowserWindow

pub fn is_menu_bar_visible(&self) -> bool

impl BrowserWindow

pub fn is_minimized(&self) -> bool

impl BrowserWindow

pub fn is_modal(&self) -> bool

impl BrowserWindow

pub fn is_normal(&self) -> bool

impl BrowserWindow

pub fn is_simple_full_screen(&self) -> bool

impl BrowserWindow

pub fn is_visible(&self) -> bool

impl BrowserWindow

pub fn is_visible_on_all_workspaces(&self) -> bool

impl BrowserWindow

pub fn is_window_message_hooked(&self, message: u32) -> bool

impl BrowserWindow

pub fn load_file(&self, path: &str, options: Option<LoadFileOptions>)

impl BrowserWindow

pub fn load_url(&self, url: &str, options: Option<LoadUrlOptions>)

impl BrowserWindow

pub fn maximize(&self)

impl BrowserWindow

pub fn merge_all_windows(&self)

impl BrowserWindow

pub fn minimize(&self)

impl BrowserWindow

pub fn move_above(&self, media_source_id: &str)

impl BrowserWindow

pub fn move_tab_to_new_window(&self)

impl BrowserWindow

pub fn move_top(&self)

impl BrowserWindow

pub fn preview_file(&self, path: &str, display_name: Option<&str>)

impl BrowserWindow

pub fn reload(&self)

impl BrowserWindow

pub fn remove_browser_view(&self, browser_view: &BrowserView)

impl BrowserWindow

pub fn remove_menu(&self)

impl BrowserWindow

pub fn restore(&self)

impl BrowserWindow

pub fn select_next_tab(&self)

impl BrowserWindow

pub fn select_previous_tab(&self)

impl BrowserWindow

pub fn set_always_on_top( &self, flag: bool, level: Option<&str>, relative_level: Option<i32>, )

impl BrowserWindow

pub fn set_app_details(&self, options: AppDetailsOptions)

impl BrowserWindow

pub fn set_aspect_ratio(&self, aspect_ratio: f32, extra_size: Option<Size>)

impl BrowserWindow

pub fn set_auto_hide_cursor(&self, auto_hide: bool)

impl BrowserWindow

pub fn set_background_color(&self, background_color: &str)

impl BrowserWindow

pub fn set_bounds(&self, bounds: Rectangle, animate: Option<bool>)

impl BrowserWindow

pub fn set_browser_view(&self, browser_view: &BrowserView)

impl BrowserWindow

pub fn set_content_bounds(&self, bounds: Rectangle, animate: Option<bool>)

impl BrowserWindow

pub fn set_content_protection(&self, enable: bool)

impl BrowserWindow

pub fn set_content_size(&self, width: u32, height: u32, animate: Option<bool>)

impl BrowserWindow

pub fn set_document_edited(&self, edited: bool)

impl BrowserWindow

pub fn set_enabled(&self, edited: bool)

impl BrowserWindow

pub fn set_focusable(&self, focusable: bool)

impl BrowserWindow

pub fn set_full_screen(&self, flag: bool)

impl BrowserWindow

pub fn set_has_shadow(&self, has_shadow: bool)

impl BrowserWindow

pub fn set_icon(&self, icon: &NativeImage)

impl BrowserWindow

pub fn set_ignore_mouse_events( &self, ignore: bool, options: Option<IgnoreMouseEventsOptions>, )

impl BrowserWindow

pub fn set_kiosk(&self, flag: bool)

impl BrowserWindow

pub fn set_maximumizable(&self, maximizable: bool)

impl BrowserWindow

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

impl BrowserWindow

pub fn set_menu(&self, menu: Option<Menu>)

impl BrowserWindow

pub fn set_menu_bar_visibility(&self, visible: bool)

impl BrowserWindow

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

impl BrowserWindow

pub fn set_opacity(&self, opacity: f32)

impl BrowserWindow

pub fn set_overlay_icon(&self, overlay: Option<&NativeImage>, description: &str)

impl BrowserWindow

pub fn set_parent_window(&self, parent: Option<&BrowserWindow>)

impl BrowserWindow

pub fn set_position(&self, x: u32, y: u32, animate: Option<bool>)

impl BrowserWindow

pub fn set_progress_bar( &self, progress: u32, options: Option<ProgressBarOptions>, )

impl BrowserWindow

pub fn set_represented_filename(&self, filename: &str)

impl BrowserWindow

pub fn set_shape(&self, rectangles: Box<[JsValue]>)

impl BrowserWindow

pub fn set_sheet_offset(&self, y: i32, x: Option<i32>)

impl BrowserWindow

pub fn set_simple_full_screen(&self, flag: bool)

impl BrowserWindow

pub fn set_size(&self, width: u32, height: u32, animate: Option<bool>)

impl BrowserWindow

pub fn set_skip_taskbar(&self, skip: bool)

impl BrowserWindow

pub fn set_thumbar_buttons(&self, buttons: Box<[JsValue]>) -> bool

impl BrowserWindow

pub fn set_thumbnail_clip(&self, region: Rectangle)

impl BrowserWindow

pub fn set_thumbnail_tool_tip(&self, tool_tip: &str)

impl BrowserWindow

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

impl BrowserWindow

pub fn set_touch_bar(&self, touch_bar: Option<&TouchBar>)

impl BrowserWindow

pub fn set_vibrancy(&self, kind: Option<&str>)

impl BrowserWindow

pub fn set_visible_on_all_workspaces( &self, visible: bool, options: Option<VisibleOnAllWorkspacesOptions>, )

impl BrowserWindow

pub fn set_window_button_visibility(&self, visible: bool)

impl BrowserWindow

pub fn show(&self)

impl BrowserWindow

pub fn show_app_details(&self)

impl BrowserWindow

pub fn show_aspect_ratio(&self)

impl BrowserWindow

pub fn show_definition_for_selection(&self)

impl BrowserWindow

pub fn show_inactive(&self)

impl BrowserWindow

pub fn toggle_tab_bar(&self)

impl BrowserWindow

pub fn unhook_all_window_messages(&self)

impl BrowserWindow

pub fn unhook_window_messages(&self, message: u32)

impl BrowserWindow

pub fn accessible_title(&self) -> JsString

impl BrowserWindow

pub fn set_accessible_title(&self, value: JsString)

impl BrowserWindow

pub fn auto_hide_menu_bar(&self) -> bool

impl BrowserWindow

pub fn set_auto_hide_menu_bar(&self, value: bool)

impl BrowserWindow

pub fn closable(&self) -> bool

impl BrowserWindow

pub fn set_closable(&self, value: bool)

impl BrowserWindow

pub fn excluded_from_shown_windows_menu(&self) -> bool

impl BrowserWindow

pub fn set_excluded_from_shown_windows_menu(&self, value: bool)

impl BrowserWindow

pub fn full_screenable(&self) -> bool

impl BrowserWindow

pub fn set_full_screenable(&self, value: bool)

impl BrowserWindow

pub fn id(&self) -> u32

impl BrowserWindow

pub fn maximizable(&self) -> bool

impl BrowserWindow

pub fn set_maximizable(&self, value: bool)

impl BrowserWindow

pub fn minimizable(&self) -> bool

impl BrowserWindow

pub fn set_minimizable(&self, value: bool)

impl BrowserWindow

pub fn movable(&self) -> bool

impl BrowserWindow

pub fn set_movable(&self, value: bool)

impl BrowserWindow

pub fn resizable(&self) -> bool

impl BrowserWindow

pub fn set_resizable(&self, value: bool)

impl BrowserWindow

pub fn web_contents(&self) -> WebContents

Methods from Deref<Target = EventEmitter>

pub fn default_max_listeners(&self) -> f64

pub fn set_default_max_listeners(&self, value: f64)

pub fn add_listener( &self, event_name: &str, listener: &Function, ) -> EventEmitter

pub fn emit(&self, event_name: &str, args: Box<[JsValue]>) -> bool

pub fn event_names(&self) -> Box<[JsValue]>

pub fn get_max_listeners(&self)

pub fn listener_count(&self) -> f64

pub fn listeners(&self, event_name: &str) -> Box<[JsValue]>

pub fn off(&self, event_name: &str, listener: &Function) -> EventEmitter

pub fn on(&self, event_name: &str, listener: &Function) -> EventEmitter

pub fn once(&self, event_name: &str, listener: &Function) -> EventEmitter

pub fn prepend_listener( &self, event_name: &str, listener: &Function, ) -> EventEmitter

pub fn prepend_once_listener( &self, event_name: &str, listener: &Function, ) -> EventEmitter

pub fn remove_all_listeners(&self, event_name: Option<&str>) -> EventEmitter

pub fn remove_listener( &self, event_name: &str, listener: &Function, ) -> EventEmitter

pub fn set_max_listeners(&self, n: f64) -> EventEmitter

pub fn raw_listeners(&self, event_name: &str) -> Box<[JsValue]>

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.

MDN documentation

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).

MDN documentation

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

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

MDN documentation

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

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

MDN documentation

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.

MDN documentation

pub fn to_string(&self) -> JsString

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

MDN documentation

pub fn value_of(&self) -> Object

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

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: 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.

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<BrowserWindow> for BrowserWindow

fn as_ref(&self) -> &BrowserWindow

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

impl AsRef<EventEmitter> for BrowserWindow

fn as_ref(&self) -> &EventEmitter

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

impl AsRef<JsValue> for BrowserWindow

fn as_ref(&self) -> &JsValue

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

impl Clone for BrowserWindow

fn clone(&self) -> BrowserWindow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BrowserWindow

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

Formats the value using the given formatter.

impl Deref for BrowserWindow

type Target = EventEmitter

The resulting type after dereferencing.

fn deref(&self) -> &EventEmitter

Dereferences the value.

impl From<BrowserWindow> for EventEmitter

fn from(obj: BrowserWindow) -> EventEmitter

Converts to this type from the input type.

impl From<BrowserWindow> for JsValue

fn from(obj: BrowserWindow) -> JsValue

Converts to this type from the input type.

impl From<JsValue> for BrowserWindow

fn from(obj: JsValue) -> BrowserWindow

Converts to this type from the input type.

impl FromWasmAbi for BrowserWindow

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 BrowserWindow

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 BrowserWindow

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 BrowserWindow

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) -> bool

where 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) -> T

where T: JsCast,

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

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

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

fn is_instance_of<T>(&self) -> bool

where 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 LongRefFromWasmAbi for BrowserWindow

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = BrowserWindow

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for BrowserWindow

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 BrowserWindow

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for BrowserWindow

fn none() -> Self::Abi

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

impl RefFromWasmAbi for BrowserWindow

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<BrowserWindow>

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 BrowserWindow

fn describe()