1.9.9.2
Prysm
Window Interface Reference

The window of the view and the global object in the scripting environment. More...

+ Inheritance diagram for Window:

Public Member Functions

void scrollBy ([Default=Undefined] optional long x, [Default=Undefined] optional long y)
 Scrolls the document in the window by the given amount. More...
 
void scrollTo ([Default=Undefined] optional long x, [Default=Undefined] optional long y)
 Scrolls to a particular set of coordinates in the document. More...
 
unsigned long setTimeout (AnyCallback handler, [Default=Undefined] optional unsigned long timeout)
 schedule a callback to be executed after timeout milliseconds More...
 
void clearTimeout (unsigned long handle)
 clear a previous scheduled timer More...
 
unsigned long setInterval (AnyCallback handler, unsigned long interval)
 schedule a callback to be executed at timeout milliseconds intervals More...
 
void clearInterval (unsigned long handle)
 clear a previous scheduled repeating timer More...
 
CSSStyleDeclaration getComputedStyle (Element element)
 the last computed style of the element More...
 
long requestAnimationFrame (AnyCallback callback)
 
void cancelAnimationFrame (long id)
 Cancels an animation frame request previously scheduled through a call to requestAnimationFrame() More...
 
void addEventListener (DOMInternedString type, EventListener listener, [Default=Undefined] optional boolean useCapture)
 
void removeEventListener (DOMInternedString type, EventListener listener, [Default=Undefined] optional boolean useCapture)
 
boolean dispatchEvent (Event event)
 
Selection getSelection ()
 Returns a Selection object representing the range of text selected by the user, or the current position of the caret. More...
 

Public Attributes

readonly attribute Document document
 The document in the current window. More...
 
readonly attribute Console console
 The console API that can be used for logging. More...
 
readonly attribute Performance performance
 
readonly attribute Location location
 
readonly attribute Navigator navigator
 
readonly attribute Window self
 
readonly attribute Storage localStorage
 
readonly attribute History history
 
readonly attribute Window parent
 A reference to the parent of the current window or subframe. More...
 
readonly attribute Screen screen
 
readonly attribute CustomElementRegistry customElements
 Gets the CustomElementRegistry that can be used to register new custom or get information about registered custom elements. More...
 
readonly attribute long outerHeight
 Gets the height in pixels of the whole browser window. It represents the height of the whole browser window including sidebar (if expanded), window chrome and window resizing borders/handles. More...
 
readonly attribute long outerWidth
 Gets 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. More...
 
readonly attribute long innerHeight
 Height (in pixels) of the browser window viewport including, if rendered, the horizontal scrollbar. More...
 
readonly attribute long innerWidth
 Width (in pixels) of the browser window viewport including, if rendered, the vertical scrollbar. More...
 
readonly attribute long screenX
 Returns the horizontal distance, in CSS pixels, of the left border of the user's browser from the left side of the screen. More...
 
readonly attribute long screenY
 Returns the vertical distance, in CSS pixels of the top border of the user's browser from the top edge of the screen. More...
 
readonly attribute long screenLeft
 This is an alias for screenX. More...
 
readonly attribute long screenTop
 This is an alias for screenY. More...
 
readonly attribute long scrollX
 Returns the number of pixels that the document has already been scrolled horizontally. More...
 
readonly attribute long scrollY
 Returns the number of pixels that the document has already been scrolled vertically. More...
 
readonly attribute long pageXOffset
 This is an alias for scrollX. More...
 
readonly attribute long pageYOffset
 This is an alias for scrollY. More...
 
readonly attribute double devicePixelRatio
 Returns the ratio of the CSS pixel size to device pixel size. More...
 
readonly attribute Chrome chrome
 
attribute EventSetter gamepadconnected
 
attribute EventSetter gamepaddisconnected
 
attribute EventSetter popstate
 
attribute EventSetter resize
 
attribute EventSetter vrdisplayactivate
 
attribute EventSetter vrdisplayblur
 
attribute EventSetter vrdisplayconnect
 
attribute EventSetter vrdisplaydeactivate
 
attribute EventSetter vrdisplaydisconnect
 
attribute EventSetter vrdisplayfocus
 
attribute EventSetter vrdisplaypresentchange
 
attribute EventSetter abort
 
attribute EventSetter blur
 
attribute EventSetter click
 
attribute EventSetter dblclick
 
attribute EventSetter error
 
attribute EventSetter focus
 
attribute EventSetter keydown
 
attribute EventSetter keypress
 
attribute EventSetter keyup
 
attribute EventSetter load
 
attribute EventSetter mousedown
 
attribute EventSetter mouseover
 
attribute EventSetter mouseout
 
attribute EventSetter mouseenter
 
attribute EventSetter mouseleave
 
attribute EventSetter mousemove
 
attribute EventSetter mouseup
 
attribute EventSetter input
 
attribute EventSetter scroll
 
attribute EventSetter wheel
 
attribute EventSetter touchstart
 
attribute EventSetter touchend
 
attribute EventSetter touchmove
 

Detailed Description

The window of the view and the global object in the scripting environment.

Member Function Documentation

◆ addEventListener()

void Window::addEventListener ( DOMInternedString  type,
EventListener  listener,
[Default=Undefined] optional boolean  useCapture 
)

Implements EventTarget.

◆ cancelAnimationFrame()

void Window::cancelAnimationFrame ( long  id)

Cancels an animation frame request previously scheduled through a call to requestAnimationFrame()

Parameters
idThe ID of the request to cancel.

◆ clearInterval()

void Window::clearInterval ( unsigned long  handle)

clear a previous scheduled repeating timer

Parameters
handlea handle returned from setInterval

◆ clearTimeout()

void Window::clearTimeout ( unsigned long  handle)

clear a previous scheduled timer

Parameters
handlea handle returned from setTimeout

◆ dispatchEvent()

boolean Window::dispatchEvent ( Event  event)

Implements EventTarget.

◆ getComputedStyle()

CSSStyleDeclaration Window::getComputedStyle ( Element  element)

the last computed style of the element

Parameters
elementthe element whose style to get

◆ getSelection()

Selection Window::getSelection ( )

Returns a Selection object representing the range of text selected by the user, or the current position of the caret.

◆ removeEventListener()

void Window::removeEventListener ( DOMInternedString  type,
EventListener  listener,
[Default=Undefined] optional boolean  useCapture 
)

Implements EventTarget.

◆ requestAnimationFrame()

long Window::requestAnimationFrame ( AnyCallback  callback)

◆ scrollBy()

void Window::scrollBy ( [Default=Undefined] optional long  x,
[Default=Undefined] optional long  y 
)

Scrolls the document in the window by the given amount.

Parameters
xoffset in pixels to scroll horizontally.
yoffset in pixels to scroll vertically.

◆ scrollTo()

void Window::scrollTo ( [Default=Undefined] optional long  x,
[Default=Undefined] optional long  y 
)

Scrolls to a particular set of coordinates in the document.

Parameters
xis the pixel along the horizontal axis of the document that you want displayed in the upper left.
yis the pixel along the vertical axis of the document that you want displayed in the upper left.

◆ setInterval()

unsigned long Window::setInterval ( AnyCallback  handler,
unsigned long  interval 
)

schedule a callback to be executed at timeout milliseconds intervals

The first call to the callback will be after timeout milliseconds

Parameters
handlera callback without arguments
intervalthe delay in milliseconds.
Note
A 0 delay makes the callback to be executed on the next frame
Returns
a handle to the scheduled timer

◆ setTimeout()

unsigned long Window::setTimeout ( AnyCallback  handler,
[Default=Undefined] optional unsigned long  timeout 
)

schedule a callback to be executed after timeout milliseconds

Parameters
handlera callback without arguments
timeoutthe delay in milliseconds.
Note
A 0 delay makes the callback to be executed on the next frame
Returns
a handle to the scheduled timer

Member Data Documentation

◆ abort

attribute EventSetter Window::abort

◆ blur

attribute EventSetter Window::blur

◆ chrome

readonly attribute Chrome Window::chrome

◆ click

attribute EventSetter Window::click

◆ console

readonly attribute Console Window::console

The console API that can be used for logging.

◆ customElements

readonly attribute CustomElementRegistry Window::customElements

Gets the CustomElementRegistry that can be used to register new custom or get information about registered custom elements.

◆ dblclick

attribute EventSetter Window::dblclick

◆ devicePixelRatio

readonly attribute double Window::devicePixelRatio

Returns the ratio of the CSS pixel size to device pixel size.

◆ document

readonly attribute Document Window::document

The document in the current window.

◆ error

attribute EventSetter Window::error

◆ focus

attribute EventSetter Window::focus

◆ gamepadconnected

attribute EventSetter Window::gamepadconnected

◆ gamepaddisconnected

attribute EventSetter Window::gamepaddisconnected

◆ history

readonly attribute History Window::history

◆ innerHeight

readonly attribute long Window::innerHeight

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

◆ innerWidth

readonly attribute long Window::innerWidth

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

◆ input

attribute EventSetter Window::input

◆ keydown

attribute EventSetter Window::keydown

◆ keypress

attribute EventSetter Window::keypress

◆ keyup

attribute EventSetter Window::keyup

◆ load

attribute EventSetter Window::load

◆ localStorage

readonly attribute Storage Window::localStorage

◆ location

readonly attribute Location Window::location

◆ mousedown

attribute EventSetter Window::mousedown

◆ mouseenter

attribute EventSetter Window::mouseenter

◆ mouseleave

attribute EventSetter Window::mouseleave

◆ mousemove

attribute EventSetter Window::mousemove

◆ mouseout

attribute EventSetter Window::mouseout

◆ mouseover

attribute EventSetter Window::mouseover

◆ mouseup

attribute EventSetter Window::mouseup

◆ navigator

readonly attribute Navigator Window::navigator

◆ outerHeight

readonly attribute long Window::outerHeight

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

◆ outerWidth

readonly attribute long Window::outerWidth

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

◆ pageXOffset

readonly attribute long Window::pageXOffset

This is an alias for scrollX.

◆ pageYOffset

readonly attribute long Window::pageYOffset

This is an alias for scrollY.

◆ parent

readonly attribute Window Window::parent

A reference to the parent of the current window or subframe.

Note
If a window does not have a parent, its parent property is a reference to itself.

◆ performance

readonly attribute Performance Window::performance

◆ popstate

attribute EventSetter Window::popstate

◆ resize

attribute EventSetter Window::resize

◆ screen

readonly attribute Screen Window::screen

◆ screenLeft

readonly attribute long Window::screenLeft

This is an alias for screenX.

◆ screenTop

readonly attribute long Window::screenTop

This is an alias for screenY.

◆ screenX

readonly attribute long Window::screenX

Returns the horizontal distance, in CSS pixels, of the left border of the user's browser from the left side of the screen.

◆ screenY

readonly attribute long Window::screenY

Returns the vertical distance, in CSS pixels of the top border of the user's browser from the top edge of the screen.

◆ scroll

attribute EventSetter Window::scroll

◆ scrollX

readonly attribute long Window::scrollX

Returns the number of pixels that the document has already been scrolled horizontally.

◆ scrollY

readonly attribute long Window::scrollY

Returns the number of pixels that the document has already been scrolled vertically.

◆ self

readonly attribute Window Window::self

◆ touchend

attribute EventSetter Window::touchend

◆ touchmove

attribute EventSetter Window::touchmove

◆ touchstart

attribute EventSetter Window::touchstart

◆ vrdisplayactivate

attribute EventSetter Window::vrdisplayactivate

◆ vrdisplayblur

attribute EventSetter Window::vrdisplayblur

◆ vrdisplayconnect

attribute EventSetter Window::vrdisplayconnect

◆ vrdisplaydeactivate

attribute EventSetter Window::vrdisplaydeactivate

◆ vrdisplaydisconnect

attribute EventSetter Window::vrdisplaydisconnect

◆ vrdisplayfocus

attribute EventSetter Window::vrdisplayfocus

◆ vrdisplaypresentchange

attribute EventSetter Window::vrdisplaypresentchange

◆ wheel

attribute EventSetter Window::wheel