Public Member Functions | Public Attributes

nsIDOMXULDocument Interface Reference

import "nsIDOMXULDocument.idl";

Collaboration diagram for nsIDOMXULDocument:

List of all members.

Public Member Functions

nsIDOMNodeList getElementsByAttribute (in DOMString name, in DOMString value)
nsIDOMNodeList getElementsByAttributeNS (in DOMString namespaceURI, in DOMString name, in DOMString value)
void addBroadcastListenerFor (in nsIDOMElement broadcaster, in nsIDOMElement observer, in DOMString attr)
void removeBroadcastListenerFor (in nsIDOMElement broadcaster, in nsIDOMElement observer, in DOMString attr)
void persist (in DOMString id, in DOMString attr)
nsIBoxObject getBoxObjectFor (in nsIDOMElement elt)
void loadOverlay (in DOMString url, in nsIObserver aObserver)
 Loads a XUL overlay and merges it with the current document, notifying an observer when the merge is complete.
nsIDOMNode trustedGetPopupNode ()
 Get the popup node from this XUL document without doing a security check to make sure that the caller has access to this node.
nsIDOMNode trustedGetTooltipNode ()
 Like trustedGetPopupNode, but gets the tooltip node instead.

Public Attributes

attribute nsIDOMNode popupNode
readonly attribute nsIDOMNode popupRangeParent
 These attributes correspond to trustedGetPopupNode().rangeOffset and rangeParent.
readonly attribute long popupRangeOffset
attribute nsIDOMNode tooltipNode
readonly attribute
nsIDOMXULCommandDispatcher 
commandDispatcher
readonly attribute long width
readonly attribute long height

Member Function Documentation

void nsIDOMXULDocument::addBroadcastListenerFor ( in nsIDOMElement  broadcaster,
in nsIDOMElement  observer,
in DOMString  attr 
)
nsIBoxObject nsIDOMXULDocument::getBoxObjectFor ( in nsIDOMElement  elt  ) 
nsIDOMNodeList nsIDOMXULDocument::getElementsByAttribute ( in DOMString  name,
in DOMString  value 
)
nsIDOMNodeList nsIDOMXULDocument::getElementsByAttributeNS ( in DOMString  namespaceURI,
in DOMString  name,
in DOMString  value 
)
void nsIDOMXULDocument::loadOverlay ( in DOMString  url,
in nsIObserver  aObserver 
)

Loads a XUL overlay and merges it with the current document, notifying an observer when the merge is complete.

Parameters:
url The URL of the overlay to load and merge
observer An object implementing nsIObserver that will be notified with a message of topic "xul-overlay-merged" when the merge is complete. The subject parameter of |observe| will QI to a nsIURI - the URI of the merged overlay. This parameter is optional and may be null.

NOTICE: In the 2.0 timeframe this API will change such that the implementation will fire a DOMXULOverlayMerged event upon merge completion rather than notifying an observer. Do not rely on this API's behavior _not_ to change because it will!

  • Ben Goodger (8/23/2005)
void nsIDOMXULDocument::persist ( in DOMString  id,
in DOMString  attr 
)
void nsIDOMXULDocument::removeBroadcastListenerFor ( in nsIDOMElement  broadcaster,
in nsIDOMElement  observer,
in DOMString  attr 
)
nsIDOMNode nsIDOMXULDocument::trustedGetPopupNode (  ) 

Get the popup node from this XUL document without doing a security check to make sure that the caller has access to this node.

This is for use from C++ callers that can indirectly be called from content.

nsIDOMNode nsIDOMXULDocument::trustedGetTooltipNode (  ) 

Like trustedGetPopupNode, but gets the tooltip node instead.


Member Data Documentation

readonly attribute long nsIDOMXULDocument::height
readonly attribute long nsIDOMXULDocument::popupRangeOffset

These attributes correspond to trustedGetPopupNode().rangeOffset and rangeParent.

They will help you find where in the DOM the popup is happening. Can be accessed from chrome only, and only during a popup event. Accessing any other time will be an error.

readonly attribute long nsIDOMXULDocument::width

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