Struct xpcom::interfaces::nsIDOMHTMLDocument

#[repr(C)]
pub struct nsIDOMHTMLDocument { /* fields omitted */ }

interface nsIDOMHTMLDocument : nsIDOMDocument

Methods

impl nsIDOMHTMLDocument

pub fn coerce<T: nsIDOMHTMLDocumentCoerce>(&self) -> &T

Cast this nsIDOMHTMLDocument to one of its base interfaces.

impl nsIDOMHTMLDocument

pub unsafe fn GetDomain(&self, aDomain: &mut nsAString) -> nsresult

attribute DOMString domain;

pub unsafe fn SetDomain(&self, aDomain: &nsAString) -> nsresult

attribute DOMString domain;

pub unsafe fn GetCookie(&self, aCookie: &mut nsAString) -> nsresult

attribute DOMString cookie;

pub unsafe fn SetCookie(&self, aCookie: &nsAString) -> nsresult

attribute DOMString cookie;

pub unsafe fn GetHead(&self, aHead: *mut *const nsISupports) -> nsresult

readonly attribute nsISupports head;

pub unsafe fn GetBody(&self, aBody: *mut *const nsIDOMHTMLElement) -> nsresult

attribute nsIDOMHTMLElement body;

pub unsafe fn SetBody(&self, aBody: *const nsIDOMHTMLElement) -> nsresult

attribute nsIDOMHTMLElement body;

pub unsafe fn Close(&self) -> nsresult

void close ();

pub unsafe fn GetDesignMode(&self, aDesignMode: &mut nsAString) -> nsresult

/**
   * Midas additions
   */

attribute DOMString designMode;

pub unsafe fn SetDesignMode(&self, aDesignMode: &nsAString) -> nsresult

/**
   * Midas additions
   */

attribute DOMString designMode;

pub unsafe fn QueryCommandIndeterm(
    &self,
    commandID: &nsAString,
    _retval: *mut bool
) -> nsresult

boolean queryCommandIndeterm (in DOMString commandID);

pub unsafe fn QueryCommandState(
    &self,
    commandID: &nsAString,
    _retval: *mut bool
) -> nsresult

boolean queryCommandState (in DOMString commandID);

pub unsafe fn QueryCommandValue(
    &self,
    commandID: &nsAString,
    _retval: &mut nsAString
) -> nsresult

DOMString queryCommandValue (in DOMString commandID);

pub unsafe fn GetFgColor(&self, aFgColor: &mut nsAString) -> nsresult

attribute DOMString fgColor;

pub unsafe fn SetFgColor(&self, aFgColor: &nsAString) -> nsresult

attribute DOMString fgColor;

pub unsafe fn GetBgColor(&self, aBgColor: &mut nsAString) -> nsresult

attribute DOMString bgColor;

pub unsafe fn SetBgColor(&self, aBgColor: &nsAString) -> nsresult

attribute DOMString bgColor;

pub unsafe fn GetLinkColor(&self, aLinkColor: &mut nsAString) -> nsresult

attribute DOMString linkColor;

pub unsafe fn SetLinkColor(&self, aLinkColor: &nsAString) -> nsresult

attribute DOMString linkColor;

pub unsafe fn GetVlinkColor(&self, aVlinkColor: &mut nsAString) -> nsresult

attribute DOMString vlinkColor;

pub unsafe fn SetVlinkColor(&self, aVlinkColor: &nsAString) -> nsresult

attribute DOMString vlinkColor;

pub unsafe fn GetAlinkColor(&self, aAlinkColor: &mut nsAString) -> nsresult

attribute DOMString alinkColor;

pub unsafe fn SetAlinkColor(&self, aAlinkColor: &nsAString) -> nsresult

attribute DOMString alinkColor;

pub unsafe fn Clear(&self) -> nsresult

void clear ();

pub unsafe fn GetSelection(&self, _retval: *mut *const nsISelection) -> nsresult

nsISelection getSelection ();

pub unsafe fn CaptureEvents(&self) -> nsresult

/**
   * @deprecated These are old Netscape 4 methods. Do not use,
   *             the implementation is no-op.
   */

void captureEvents ();

pub unsafe fn ReleaseEvents(&self) -> nsresult

void releaseEvents ();

Methods from Deref<Target = nsIDOMDocument>

pub fn coerce<T: nsIDOMDocumentCoerce>(&self) -> &T

Cast this nsIDOMDocument to one of its base interfaces.

pub unsafe fn GetDoctype(
    &self,
    aDoctype: *mut *const nsIDOMDocumentType
) -> nsresult

/**
 * The nsIDOMDocument interface represents the entire HTML or XML document.
 * Conceptually, it is the root of the document tree, and provides the
 * primary access to the document's data.
 * Since elements, text nodes, comments, processing instructions, etc.
 * cannot exist outside the context of a Document, the nsIDOMDocument
 * interface also contains the factory methods needed to create these
 * objects.
 *
 * For more information on this interface please see
 * http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html
 */

readonly attribute nsIDOMDocumentType doctype;

pub unsafe fn GetImplementation(
    &self,
    aImplementation: *mut *const nsIDOMDOMImplementation
) -> nsresult

readonly attribute nsIDOMDOMImplementation implementation;

pub unsafe fn GetDocumentElement(
    &self,
    aDocumentElement: *mut *const nsIDOMElement
) -> nsresult

readonly attribute nsIDOMElement documentElement;

pub unsafe fn CreateElement(
    &self,
    tagName: &nsAString,
    _retval: *mut *const nsIDOMElement
) -> nsresult

nsIDOMElement createElement ([Null (Stringify)] in DOMString tagName) raises (DOMException);

pub unsafe fn CreateDocumentFragment(
    &self,
    _retval: *mut *const nsIDOMDocumentFragment
) -> nsresult

nsIDOMDocumentFragment createDocumentFragment ();

pub unsafe fn CreateTextNode(
    &self,
    data: &nsAString,
    _retval: *mut *const nsIDOMText
) -> nsresult

nsIDOMText createTextNode (in DOMString data);

pub unsafe fn CreateComment(
    &self,
    data: &nsAString,
    _retval: *mut *const nsIDOMComment
) -> nsresult

nsIDOMComment createComment (in DOMString data);

pub unsafe fn CreateCDATASection(
    &self,
    data: &nsAString,
    _retval: *mut *const nsIDOMCDATASection
) -> nsresult

nsIDOMCDATASection createCDATASection (in DOMString data) raises (DOMException);

pub unsafe fn CreateProcessingInstruction(
    &self,
    target: &nsAString,
    data: &nsAString,
    _retval: *mut *const nsIDOMProcessingInstruction
) -> nsresult

nsIDOMProcessingInstruction createProcessingInstruction (in DOMString target, in DOMString data) raises (DOMException);

pub unsafe fn CreateAttribute(
    &self,
    name: &nsAString,
    _retval: *mut *const nsIDOMAttr
) -> nsresult

nsIDOMAttr createAttribute (in DOMString name) raises (DOMException);

pub unsafe fn GetElementsByTagName(
    &self,
    tagname: &nsAString,
    _retval: *mut *const nsIDOMNodeList
) -> nsresult

nsIDOMNodeList getElementsByTagName (in DOMString tagname);

pub unsafe fn CreateElementNS(
    &self,
    namespaceURI: &nsAString,
    qualifiedName: &nsAString,
    _retval: *mut *const nsIDOMElement
) -> nsresult

nsIDOMElement createElementNS (in DOMString namespaceURI, [Null (Stringify)] in DOMString qualifiedName) raises (DOMException);

pub unsafe fn CreateAttributeNS(
    &self,
    namespaceURI: &nsAString,
    qualifiedName: &nsAString,
    _retval: *mut *const nsIDOMAttr
) -> nsresult

nsIDOMAttr createAttributeNS (in DOMString namespaceURI, in DOMString qualifiedName) raises (DOMException);

pub unsafe fn GetElementsByTagNameNS(
    &self,
    namespaceURI: &nsAString,
    localName: &nsAString,
    _retval: *mut *const nsIDOMNodeList
) -> nsresult

nsIDOMNodeList getElementsByTagNameNS (in DOMString namespaceURI, in DOMString localName);

pub unsafe fn GetElementById(
    &self,
    elementId: &nsAString,
    _retval: *mut *const nsIDOMElement
) -> nsresult

nsIDOMElement getElementById (in DOMString elementId);

pub unsafe fn GetInputEncoding(
    &self,
    aInputEncoding: &mut nsAString
) -> nsresult

readonly attribute DOMString inputEncoding;

pub unsafe fn GetDocumentURI(&self, aDocumentURI: &mut nsAString) -> nsresult

readonly attribute DOMString documentURI;

pub unsafe fn GetURL(&self, aURL: &mut nsAString) -> nsresult

readonly attribute DOMString URL;

pub unsafe fn CreateRange(&self, _retval: *mut *const nsIDOMRange) -> nsresult

/**
   * Create a range
   *
   * @see http://html5.org/specs/dom-range.html#dom-document-createrange
   */

nsIDOMRange createRange ();

pub unsafe fn CreateEvent(
    &self,
    eventType: &nsAString,
    _retval: *mut *const nsIDOMEvent
) -> nsresult

nsIDOMEvent createEvent (in DOMString eventType) raises (DOMException);

pub unsafe fn GetDefaultView(
    &self,
    aDefaultView: *mut *const mozIDOMWindowProxy
) -> nsresult

/**
   * The window associated with this document.
   *
   * @see <http://www.whatwg.org/html/#dom-document-defaultview>
   */

readonly attribute mozIDOMWindowProxy defaultView;

pub unsafe fn GetCharacterSet(&self, aCharacterSet: &mut nsAString) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#dom-document-characterset>
   */

readonly attribute DOMString characterSet;

pub unsafe fn GetDir(&self, aDir: &mut nsAString) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#dom-document-dir>
   */

attribute DOMString dir;

pub unsafe fn SetDir(&self, aDir: &nsAString) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#dom-document-dir>
   */

attribute DOMString dir;

pub unsafe fn GetTitle(&self, aTitle: &mut nsAString) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#document.title>
   */

attribute DOMString title;

pub unsafe fn SetTitle(&self, aTitle: &nsAString) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#document.title>
   */

attribute DOMString title;

pub unsafe fn GetReadyState(&self, aReadyState: &mut nsAString) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#dom-document-readystate>
   */

readonly attribute DOMString readyState;

pub unsafe fn GetLastModified(&self, aLastModified: &mut nsAString) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#dom-document-lastmodified>
   */

readonly attribute DOMString lastModified;

pub unsafe fn GetReferrer(&self, aReferrer: &mut nsAString) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#dom-document-referrer>
   */

readonly attribute DOMString referrer;

pub unsafe fn HasFocus(&self, _retval: *mut bool) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#dom-document-hasfocus>
   */

boolean hasFocus ();

pub unsafe fn GetActiveElement(
    &self,
    aActiveElement: *mut *const nsIDOMElement
) -> nsresult

/**
   * @see <http://www.whatwg.org/html/#dom-document-activeelement>
   */

readonly attribute nsIDOMElement activeElement;

pub unsafe fn GetElementsByClassName(
    &self,
    classes: &nsAString,
    _retval: *mut *const nsIDOMNodeList
) -> nsresult

/**
   * Retrieve elements matching all classes listed in a
   * space-separated string.
   *
   * @see <http://www.whatwg.org/html/#dom-document-getelementsbyclassname>
   */

nsIDOMNodeList getElementsByClassName (in DOMString classes);

pub unsafe fn GetStyleSheets(
    &self,
    aStyleSheets: *mut *const nsIDOMStyleSheetList
) -> nsresult

/**
   * @see <http://dev.w3.org/csswg/cssom/#dom-document-stylesheets>
   */

readonly attribute nsIDOMStyleSheetList styleSheets;

pub unsafe fn GetPreferredStyleSheetSet(
    &self,
    aPreferredStyleSheetSet: &mut nsAString
) -> nsresult

/**
   * This attribute must return the preferred style sheet set as set by the
   * author. It is determined from the order of style sheet declarations and
   * the Default-Style HTTP headers, as eventually defined elsewhere in the Web
   * Apps 1.0 specification. If there is no preferred style sheet set, this
   * attribute must return the empty string. The case of this attribute must
   * exactly match the case given by the author where the preferred style sheet
   * is specified or implied. This attribute must never return null.
   *
   * @see <http://dev.w3.org/csswg/cssom/#dom-document-preferredStyleSheetSet>
   */

readonly attribute DOMString preferredStyleSheetSet;

pub unsafe fn GetMozSelectedStyleSheetSet(
    &self,
    aSelectedStyleSheetSet: &mut nsAString
) -> nsresult

/**
   * This attribute indicates which style sheet set is in use. This attribute
   * is live; changing the disabled attribute on style sheets directly will
   * change the value of this attribute.
   *
   * If all the sheets that are enabled and have a title have the same title
   * (by case-sensitive comparisons) then the value of this attribute must be
   * exactly equal to the title of the first enabled style sheet with a title
   * in the styleSheets list. Otherwise, if style sheets from different sets
   * are enabled, then the return value must be null (there is no way to
   * determine what the currently selected style sheet set is in those
   * conditions). Otherwise, either all style sheets that have a title are
   * disabled, or there are no alternate style sheets, and
   * selectedStyleSheetSet must return the empty string.
   *
   * Setting this attribute to the null value must have no effect.
   *
   * Setting this attribute to a non-null value must call
   * enableStyleSheetsForSet() with that value as the function's argument, and
   * set lastStyleSheetSet to that value.
   *
   * From the DOM's perspective, all views have the same
   * selectedStyleSheetSet. If a UA supports multiple views with different
   * selected alternate style sheets, then this attribute (and the StyleSheet
   * interface's disabled attribute) must return and set the value for the
   * default view.
   *
   * @see <http://dev.w3.org/csswg/cssom/#dom-document-selectedStyleSheetSet>
   */

[binaryname(MozSelectedStyleSheetSet)] attribute DOMString selectedStyleSheetSet;

pub unsafe fn SetMozSelectedStyleSheetSet(
    &self,
    aSelectedStyleSheetSet: &nsAString
) -> nsresult

/**
   * This attribute indicates which style sheet set is in use. This attribute
   * is live; changing the disabled attribute on style sheets directly will
   * change the value of this attribute.
   *
   * If all the sheets that are enabled and have a title have the same title
   * (by case-sensitive comparisons) then the value of this attribute must be
   * exactly equal to the title of the first enabled style sheet with a title
   * in the styleSheets list. Otherwise, if style sheets from different sets
   * are enabled, then the return value must be null (there is no way to
   * determine what the currently selected style sheet set is in those
   * conditions). Otherwise, either all style sheets that have a title are
   * disabled, or there are no alternate style sheets, and
   * selectedStyleSheetSet must return the empty string.
   *
   * Setting this attribute to the null value must have no effect.
   *
   * Setting this attribute to a non-null value must call
   * enableStyleSheetsForSet() with that value as the function's argument, and
   * set lastStyleSheetSet to that value.
   *
   * From the DOM's perspective, all views have the same
   * selectedStyleSheetSet. If a UA supports multiple views with different
   * selected alternate style sheets, then this attribute (and the StyleSheet
   * interface's disabled attribute) must return and set the value for the
   * default view.
   *
   * @see <http://dev.w3.org/csswg/cssom/#dom-document-selectedStyleSheetSet>
   */

[binaryname(MozSelectedStyleSheetSet)] attribute DOMString selectedStyleSheetSet;

pub unsafe fn GetLastStyleSheetSet(
    &self,
    aLastStyleSheetSet: &mut nsAString
) -> nsresult

readonly attribute DOMString lastStyleSheetSet;

pub unsafe fn GetStyleSheetSets(
    &self,
    aStyleSheetSets: *mut *const nsISupports
) -> nsresult

/**
   * This must return the live list of the currently available style sheet
   * sets. This list is constructed by enumerating all the style sheets for
   * this document available to the implementation, in the order they are
   * listed in the styleSheets attribute, adding the title of each style sheet
   * with a title to the list, avoiding duplicates by dropping titles that
   * match (case-sensitively) titles that have already been added to the
   * list.
   *
   * @see <http://dev.w3.org/csswg/cssom/#dom-document-styleSheetSets>
   */

readonly attribute nsISupports styleSheetSets;

pub unsafe fn MozEnableStyleSheetsForSet(&self, name: &nsAString) -> nsresult

/**
   * Calling this method must change the disabled attribute on each StyleSheet
   * object with a title attribute with a length greater than 0 in the
   * styleSheets attribute, so that all those whose title matches the name
   * argument are enabled, and all others are disabled. Title matches must be
   * case-sensitive. Calling this method with the empty string disables all
   * alternate and preferred style sheets (but does not change the state of
   * persistent style sheets, that is those with no title attribute).
   *
   * Calling this method with a null value must have no effect.
   *
   * Style sheets that do not have a title are never affected by this
   * method. This method does not change the values of the lastStyleSheetSet or
   * preferredStyleSheetSet attributes.
   *
   * @see <http://dev.w3.org/csswg/cssom/#dom-document-enableStyleSheetsForSet>
   */

[binaryname(MozEnableStyleSheetsForSet)] void enableStyleSheetsForSet (in DOMString name);

pub unsafe fn ElementFromPoint(
    &self,
    x: c_float,
    y: c_float,
    _retval: *mut *const nsIDOMElement
) -> nsresult

/**
   * 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://dev.w3.org/csswg/cssom-view/#dom-document-elementfrompoint>
   */

nsIDOMElement elementFromPoint (in float x, in float y);

pub unsafe fn GetContentType(&self, aContentType: &mut nsAString) -> nsresult

/**
   * @see <https://developer.mozilla.org/en/DOM/document.contentType>
   */

readonly attribute DOMString contentType;

pub unsafe fn GetMozSyntheticDocument(
    &self,
    aMozSyntheticDocument: *mut bool
) -> nsresult

/**
   * True if this document is synthetic : stand alone image, video, audio file,
   * etc.
   */

readonly attribute boolean mozSyntheticDocument;

pub unsafe fn GetCurrentScript(
    &self,
    aCurrentScript: *mut *const nsIDOMElement
) -> nsresult

/**
   * Returns the script element whose script is currently being processed.
   *
   * @see <https://developer.mozilla.org/en/DOM/document.currentScript>
   */

readonly attribute nsIDOMElement currentScript;

pub unsafe fn MozSetImageElement(
    &self,
    aImageElementId: &nsAString,
    aImageElement: *const nsIDOMElement
) -> nsresult

/**
   * 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|.
   *
   * @see <https://developer.mozilla.org/en/DOM/document.mozSetImageElement>
   */

void mozSetImageElement (in DOMString aImageElementId, in nsIDOMElement aImageElement);

pub unsafe fn CaretPositionFromPoint(
    &self,
    x: c_float,
    y: c_float,
    _retval: *mut *const nsISupports
) -> nsresult

/**
   * Retrieve the location of the caret position (DOM node and character
   * offset within that node), given a point.
   *
   * @param x Horizontal point at which to determine the caret position, in
   *          page coordinates.
   * @param y Vertical point at which to determine the caret position, in
   *          page coordinates.
   */

nsISupports caretPositionFromPoint (in float x, in float y);

pub unsafe fn GetHidden(&self, aHidden: *mut bool) -> nsresult

/**
   * Visibility API implementation.
   */

readonly attribute boolean hidden;

pub unsafe fn GetVisibilityState(
    &self,
    aVisibilityState: &mut nsAString
) -> nsresult

readonly attribute DOMString visibilityState;

Trait Implementations

impl XpCom for nsIDOMHTMLDocument

const IID: nsIID

IID: nsIID = nsID(3442599455, 53186, 19345, [147, 133, 23, 182, 162, 208, 99, 61])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for nsIDOMHTMLDocument

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIDOMHTMLDocument

type Target = nsIDOMDocument

The resulting type after dereferencing.

fn deref(&self) -> &nsIDOMDocument

Dereferences the value.