gecko/dom/interfaces/core/nsIDOMNSDocument.idl

132 lines
5.2 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2000
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Vidur Apparao <vidur@netscape.com> (original author)
* Johnny Stenback <jst@netscape.com>
* Robert Sayre <sayrer@gmail.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "domstubs.idl"
interface nsIBoxObject;
interface nsIDOMLocation;
[scriptable, uuid(92f2c6f8-3668-4a47-8251-2a900afe11fa)]
interface nsIDOMNSDocument : nsISupports
{
readonly attribute DOMString characterSet;
attribute DOMString dir;
readonly attribute nsIDOMLocation location;
attribute DOMString title;
readonly attribute DOMString contentType;
readonly attribute DOMString readyState;
readonly attribute DOMString lastModified;
readonly attribute DOMString referrer;
boolean hasFocus();
readonly attribute nsIDOMElement activeElement;
readonly attribute nsIDOMElement currentScript;
/*
* Retrieve elements matching all classes listed in a
* space-separated string.
*
* See <http://whatwg.org/specs/web-apps/current-work/>
*/
nsIDOMNodeList getElementsByClassName(in DOMString classes);
/**
* Returns the element from the caller's document at the given point,
* relative to the upper-left-most point in the (possibly scrolled)
* window or frame.
*
* If the element at the given point belongs to another document (such as
* an iframe's subdocument), the element in the calling document's DOM
* (e.g. the iframe) is returned. If the element at the given point is
* anonymous or XBL generated content, such as a textbox's scrollbars, then
* the first non-anonymous parent element (that is, the textbox) is returned.
*
* This method returns null if either coordinate is negative, or if the
* specified point lies outside the visible bounds of the document.
*
* Callers from XUL documents should wait until the onload event has fired
* before calling this method.
*
* See <http://www.w3.org/TR/cssom-view/#the-documentview-interface>
*/
nsIDOMElement elementFromPoint(in float x, in float y);
/**
* Release the current mouse capture if it is on an element within this
* document.
*/
void releaseCapture();
/**
* Use the given DOM element as the source image of target |-moz-element()|.
*
* This function introduces a new special ID (called "image element ID"),
* which is only used by |-moz-element()|, and associates it with the given
* DOM element. Image elements ID's have the higher precedence than general
* HTML id's, so if |document.mozSetImageElement(<id>, <element>)| is called,
* |-moz-element(#<id>)| uses |<element>| as the source image even if there
* is another element with id attribute = |<id>|. To unregister an image
* element ID |<id>|, call |document.mozSetImageElement(<id>, null)|.
*
* Example:
* <script>
* canvas = document.createElement("canvas");
* canvas.setAttribute("width", 100);
* canvas.setAttribute("height", 100);
* // draw to canvas
* document.mozSetImageElement("canvasbg", canvas);
* </script>
* <div style="background-image: -moz-element(#canvasbg);"></div>
*
* @param aImageElementId an image element ID to associate with
* |aImageElement|
* @param aImageElement a DOM element to be used as the source image of
* |-moz-element(#aImageElementId)|. If this is null, the function will
* unregister the image element ID |aImageElementId|.
*/
void mozSetImageElement(in DOMString aImageElementId,
in nsIDOMElement aImageElement);
};