Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIDOMWindowUtils Interface Reference

nsIDOMWindowUtils is intended for giving privileged script access to additional properties and methods of nsIDOMWindow unavailable to content script. More...

import "nsIDOMWindowUtils.idl";

Inheritance diagram for nsIDOMWindowUtils:
Inheritance graph
[legend]
Collaboration diagram for nsIDOMWindowUtils:
Collaboration graph
[legend]

List of all members.

Public Member Functions

AString getDocumentMetadata (in AString aName)
 Function to get metadata associated with the window's current document.

Public Attributes

attribute unsigned short imageAnimationMode
 Image animation mode of the window.

Detailed Description

nsIDOMWindowUtils is intended for giving privileged script access to additional properties and methods of nsIDOMWindow unavailable to content script.

Access this interface by calling getInterface on a DOMWindow.

Definition at line 47 of file nsIDOMWindowUtils.idl.


Member Function Documentation

AString nsIDOMWindowUtils::getDocumentMetadata ( in AString  aName)

Function to get metadata associated with the window's current document.

Parameters:
aNamethe name of the metadata. This should be all lowercase.
Returns:
the value of the metadata, or the empty string if it's not set

Member Data Documentation

Image animation mode of the window.

When this attribute's value is changed, the implementation should set all images in the window to the given value. That is, when set to kDontAnimMode, all images will stop animating. The attribute's value must be one of the animationMode values from imgIContainer.

Note:
Images may individually override the window's setting after the window's mode is set. Therefore images given different modes since the last setting of the window's mode may behave out of line with the window's overall mode.
The attribute's value is the window's overall mode. It may for example continue to report kDontAnimMode after all images have subsequently been individually animated.
Only images immediately in this window are affected; this is not recursive to subwindows.
See also:
imgIContainer

Definition at line 66 of file nsIDOMWindowUtils.idl.


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