Public Member Functions | Public Attributes

nsIDOMWindow Interface Reference

The nsIDOMWindow interface is the primary interface for a DOM window object. More...

import "nsIDOMWindow.idl";

Inheritance diagram for nsIDOMWindow:
Collaboration diagram for nsIDOMWindow:

List of all members.

Public Member Functions

void scrollTo (in long xScroll, in long yScroll)
 Method for scrolling this window to an absolute pixel offset.
void scrollBy (in long xScrollDif, in long yScrollDif)
 Method for scrolling this window to a pixel offset relative to the current scroll position.
nsISelection getSelection ()
 Method for accessing this window's selection object.
void scrollByLines (in long numLines)
 Method for scrolling this window by a number of lines.
void scrollByPages (in long numPages)
 Method for scrolling this window by a number of pages.
void sizeToContent ()
 Method for sizing this window to the content in the window.

Public Attributes

readonly attribute nsIDOMDocument document
 Accessor for the document in this window.
readonly attribute nsIDOMWindow parent
 Accessor for this window's parent window, or the window itself if there is no parent, or if the parent is of different type (i.e.
readonly attribute nsIDOMWindow top
 Accessor for the root of this hierarchy of windows.
readonly attribute nsIDOMBarProp scrollbars
 Accessor for the object that controls whether or not scrollbars are shown in this window.
readonly attribute
nsIDOMWindowCollection 
frames
 Accessor for the child windows in this window.
attribute DOMString name
 Set/Get the name of this window.
attribute float textZoom
 Set/Get the document scale factor as a multiplier on the default size.
readonly attribute long scrollX
 Accessor for the current x scroll position in this window in pixels.
readonly attribute long scrollY
 Accessor for the current y scroll position in this window in pixels.

Detailed Description

The nsIDOMWindow interface is the primary interface for a DOM window object.

It represents a single window object that may contain child windows if the document in the window contains a HTML frameset document or if the document contains iframe elements.

This interface is not officially defined by any standard bodies, it originates from the defacto DOM Level 0 standard.

Status:
FROZEN

Member Function Documentation

nsISelection nsIDOMWindow::getSelection (  ) 

Method for accessing this window's selection object.

void nsIDOMWindow::scrollBy ( in long  xScrollDif,
in long  yScrollDif 
)

Method for scrolling this window to a pixel offset relative to the current scroll position.

void nsIDOMWindow::scrollByLines ( in long  numLines  ) 

Method for scrolling this window by a number of lines.

void nsIDOMWindow::scrollByPages ( in long  numPages  ) 

Method for scrolling this window by a number of pages.

void nsIDOMWindow::scrollTo ( in long  xScroll,
in long  yScroll 
)

Method for scrolling this window to an absolute pixel offset.

void nsIDOMWindow::sizeToContent (  ) 

Method for sizing this window to the content in the window.


Member Data Documentation

Accessor for the document in this window.

Accessor for the child windows in this window.

attribute DOMString nsIDOMWindow::name

Set/Get the name of this window.

This attribute is "replaceable" in JavaScript

readonly attribute nsIDOMWindow nsIDOMWindow::parent

Accessor for this window's parent window, or the window itself if there is no parent, or if the parent is of different type (i.e.

this does not cross chrome-content boundaries).

Accessor for the object that controls whether or not scrollbars are shown in this window.

This attribute is "replaceable" in JavaScript

readonly attribute long nsIDOMWindow::scrollX

Accessor for the current x scroll position in this window in pixels.

This attribute is "replaceable" in JavaScript

readonly attribute long nsIDOMWindow::scrollY

Accessor for the current y scroll position in this window in pixels.

This attribute is "replaceable" in JavaScript

attribute float nsIDOMWindow::textZoom

Set/Get the document scale factor as a multiplier on the default size.

When setting this attribute, a NS_ERROR_NOT_IMPLEMENTED error may be returned by implementations not supporting zoom. Implementations not supporting zoom should return 1.0 all the time for the Get operation. 1.0 is equals normal size, i.e. no zoom.

readonly attribute nsIDOMWindow nsIDOMWindow::top

Accessor for the root of this hierarchy of windows.

This root may be the window itself if there is no parent, or if the parent is of different type (i.e. this does not cross chrome-content boundaries).

This property is "replaceable" in JavaScript


The documentation for this interface was generated from the following file: