Struct stdweb::web::Window

pub struct Window(_);

The Window object represents a window containing a DOM document.

(JavaScript docs)

Methods

impl Window

pub fn alert(&self, message: &str)

The Window.alert() method displays an alert dialog with the optional specified content and an OK button.

(JavaScript docs)

pub fn confirm(&self, message: &str) -> bool

The Window.confirm() method displays a modal dialog with an optional message and two buttons: OK and Cancel.

(JavaScript docs)

pub fn local_storage(&self) -> Storage

The local_storage property allows you to access a local Storage object.

It is similar to the Window::session_storage. The only difference is that, while data stored in local_storage has no expiration time, data stored in session_storage gets cleared when the browsing session ends - that is, when the browser is closed.

(JavaScript docs)

pub fn session_storage(&self) -> Storage

The session_storage property allows you to access a session Storage object for the current origin.

It is similar to the Window::local_storage, The only difference is that, while data stored in local_storage has no expiration time, data stored in session_storage gets cleared when the browsing session ends.

A page session lasts for as long as the browser is open and survives over page reloads and restores. Opening a page in a new tab or window will cause a new session to be initiated, which differs from how session cookies work.

(JavaScript docs)

pub fn location(&self) -> Option<Location>

Returns a Location object which contains information about the URL of the document and provides methods for changing that URL and loading another URL.

(JavaScript docs)

pub fn request_animation_frame<F: FnOnce(f64) + 'static>(
    &self,
    callback: F
) -> RequestAnimationFrameHandle

You should call this method whenever you're ready to update your animation onscreen. This will request that your animation function be called before the browser performs the next repaint. The number of callbacks is usually 60 times per second, but will generally match the display refresh rate in most web browsers as per W3C recommendation. request_animation_frame() calls are paused in most browsers when running in background tabs or hidden iframes in order to improve performance and battery life.

The callback method is passed a single argument, a f64, which indicates the current time when callbacks queued by requestAnimationFrame() begin to fire. Multiple callbacks in a single frame, therefore, each receive the same timestamp even though time has passed during the computation of every previous callback's workload. This timestamp is a decimal number, in milliseconds, but with a minimal precision of 1ms (1000 µs).

(JavaScript docs)

pub fn history(&self) -> History

Returns the global History object, which provides methods to manipulate the browser history.

(JavaScript docs)

pub fn inner_width(&self) -> i32

Returns the width (in pixels) of the browser window viewport including, if rendered, the vertical scrollbar.

(JavaScript docs)

pub fn inner_height(&self) -> i32

Returns the height (in pixels) of the browser window viewport including, if rendered, the horizontal scrollbar.

(JavaScript docs)

pub fn outer_width(&self) -> i32

Returns the width of the outside of the browser window. It represents the width of the whole browser window including sidebar (if expanded), window chrome and window resizing borders/handles.

(JavaScript docs)

pub fn outer_height(&self) -> i32

Returns the height of the outside of the browser window. It represents the height of the whole browser window including sidebar (if expanded), window chrome and window resizing borders/handles.

(JavaScript docs)

pub fn page_y_offset(&self) -> f64

The read-only Window property pageYOffset is an alias for scrollY; as such, it returns the number of pixels the document is currently scrolled along the vertical axis (that is, up or down), with a value of 0.0 indicating that the top edge of the Document is currently aligned with the top edge of the window's content area.

(JavaScript docs)

pub fn page_x_offset(&self) -> f64

This is an alias for scrollX.

(JavaScript docs)

pub fn device_pixel_ratio(&self) -> f64

The ratio in resolution from physical pixels to CSS pixels

(JavaScript docs)

pub fn get_selection(&self) -> Option<Selection>

Returns a Selection object representing the range of text selected by the user or the current position of the caret. (Javascript docs)

Trait Implementations

impl JsSerialize for Window

impl TryFrom<EventTarget> for Window

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: EventTarget) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Window> for Reference

type Error = Void

The type returned in the event of a conversion error.

fn try_from(value: Window) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Reference> for Window

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Reference> for Window

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: &Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Window

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for Window

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl InstanceOf for Window

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl ReferenceType for Window

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use!

impl IEventTarget for Window

fn add_event_listener<T, F>(&self, listener: F) -> EventListenerHandle where
    T: ConcreteEvent,
    F: FnMut(T) + 'static, 

Adds given event handler to the list of event listeners for the specified EventTarget on which it's called.

fn dispatch_event<T: IEvent>(&self, event: &T) -> Result<bool, TODO>

Dispatches an Event at this EventTarget, invoking the affected event listeners in the appropriate order.

impl IWindowOrWorker for Window

fn set_timeout<F: FnOnce() + 'static>(&self, callback: F, timeout: u32)

Sets a timer which executes a function once after the timer expires.

fn set_clearable_timeout<F: FnOnce() + 'static>(
    &self,
    callback: F,
    timeout: u32
) -> TimeoutHandle

Sets a timer which executes a function once after the timer expires and can be cleared

impl AsRef<Reference> for Window

fn as_ref(&self) -> &Reference

Performs the conversion.

impl From<Window> for EventTarget

fn from(value: Window) -> Self

Performs the conversion.

impl From<Window> for Reference

fn from(value: Window) -> Self

Performs the conversion.

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 Eq for Window

impl PartialEq<Window> for Window

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

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

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

This method tests for !=.

impl Debug for Window

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

Formats the value using the given formatter.