gecko/dom/interfaces/core/nsIDOMElement.idl

232 lines
8.7 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>
* Ms2ger <ms2ger@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 "nsIDOMNode.idl"
/**
* The nsIDOMElement interface represents an element in an HTML or
* XML document.
*
* For more information on this interface please see
* http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-element
*/
[scriptable, uuid(295e05d9-9174-48ae-bc59-d7e6a8757726)]
interface nsIDOMElement : nsIDOMNode
{
readonly attribute DOMString tagName;
/**
* Returns a DOMTokenList object reflecting the class attribute.
*/
readonly attribute nsIDOMDOMTokenList classList;
DOMString getAttribute(in DOMString name);
DOMString getAttributeNS(in DOMString namespaceURI,
in DOMString localName);
void setAttribute(in DOMString name,
in DOMString value);
void setAttributeNS(in DOMString namespaceURI,
in DOMString qualifiedName,
in DOMString value);
void removeAttribute(in DOMString name);
void removeAttributeNS(in DOMString namespaceURI,
in DOMString localName);
boolean hasAttribute(in DOMString name);
boolean hasAttributeNS(in DOMString namespaceURI,
in DOMString localName);
// Obsolete methods.
nsIDOMAttr getAttributeNode(in DOMString name);
nsIDOMAttr setAttributeNode(in nsIDOMAttr newAttr);
nsIDOMAttr removeAttributeNode(in nsIDOMAttr oldAttr);
nsIDOMAttr getAttributeNodeNS(in DOMString namespaceURI,
in DOMString localName);
nsIDOMAttr setAttributeNodeNS(in nsIDOMAttr newAttr)
raises(DOMException);
nsIDOMNodeList getElementsByTagName(in DOMString name);
nsIDOMNodeList getElementsByTagNameNS(in DOMString namespaceURI,
in DOMString localName);
/**
* Retrieve elements matching all classes listed in a
* space-separated string.
*/
nsIDOMNodeList getElementsByClassName(in DOMString classes);
/**
* Returns a live nsIDOMNodeList of the current child elements.
*/
[binaryname(ChildElements)]
readonly attribute nsIDOMNodeList children;
/**
* Similar as the attributes on nsIDOMNode, but navigates just elements
* rather than all nodes.
*/
readonly attribute nsIDOMElement firstElementChild;
readonly attribute nsIDOMElement lastElementChild;
readonly attribute nsIDOMElement previousElementSibling;
readonly attribute nsIDOMElement nextElementSibling;
/**
* Returns the number of child nodes that are nsIDOMElements.
*/
readonly attribute unsigned long childElementCount;
// HTML
[implicit_jscontext] attribute jsval onmouseenter;
[implicit_jscontext] attribute jsval onmouseleave;
// CSSOM View
/**
* Retrieve a list of rectangles, one for each CSS border-box associated with
* the element. The coordinates are in CSS pixels, and relative to
* the top-left of the document's viewport, unless the document
* has an SVG foreignobject ancestor, in which case the coordinates are
* relative to the top-left of the content box of the nearest SVG foreignobject
* ancestor. The coordinates are calculated as if every scrollable element
* is scrolled to its default position.
*
* Note: the boxes of overflowing children do not affect these rectangles.
* Note: some elements have empty CSS boxes. Those return empty rectangles,
* but the coordinates may still be meaningful.
* Note: some elements have no CSS boxes (including display:none elements,
* HTML AREA elements, and SVG elements that do not render). Those return
* an empty list.
*/
nsIDOMClientRectList getClientRects();
/**
* Returns the union of all rectangles in the getClientRects() list. Empty
* rectangles are ignored, except that if all rectangles are empty,
* we return an empty rectangle positioned at the top-left of the first
* rectangle in getClientRects().
*/
nsIDOMClientRect getBoundingClientRect();
/**
* The vertical scroll position of the element, or 0 if the element is not
* scrollable. This property may be assigned a value to change the
* vertical scroll position.
*/
attribute long scrollTop;
/**
* The horizontal scroll position of the element, or 0 if the element is not
* scrollable. This property may be assigned a value to change the
* horizontal scroll position.
*/
attribute long scrollLeft;
/**
* The width of the scrollable area of the element. If the element is not
* scrollable, scrollWidth is equivalent to the offsetWidth.
*/
readonly attribute long scrollWidth;
/**
* The height of the scrollable area of the element. If the element is not
* scrollable, scrollHeight is equivalent to the offsetHeight.
*/
readonly attribute long scrollHeight;
/**
* The height in CSS pixels of the element's top border.
*/
readonly attribute long clientTop;
/**
* The width in CSS pixels of the element's left border and scrollbar
* if it is present on the left side.
*/
readonly attribute long clientLeft;
/**
* The height in CSS pixels of the element's padding box. If the element is
* scrollable, the scroll bars are included inside this width.
*/
readonly attribute long clientWidth;
/**
* The width in CSS pixels of the element's padding box. If the element is
* scrollable, the scroll bars are included inside this height.
*/
readonly attribute long clientHeight;
// Selectors API
/**
* Returns whether this element would be selected by the given selector
* string.
*
* See <http://dev.w3.org/2006/webapi/selectors-api2/#matchesselector>
*/
boolean mozMatchesSelector([Null(Stringify)] in DOMString selector);
// Proprietary extensions
/**
* Set this during a mousedown event to grab and retarget all mouse events
* to this element until the mouse button is released or releaseCapture is
* called. If retargetToElement is true, then all events are targetted at
* this element. If false, events can also fire at descendants of this
* element.
*
*/
void setCapture([optional] in boolean retargetToElement);
/**
* If this element has captured the mouse, release the capture. If another
* element has captured the mouse, this method has no effect.
*/
void releaseCapture();
// Mozilla extensions
/**
* Requests that this element be made the full-screen element, as per the DOM
* full-screen api.
*
* @see <https://wiki.mozilla.org/index.php?title=Gecko:FullScreenAPI>
*/
void mozRequestFullScreen();
};