Mozilla.org

nsITooltipTextProvider

---

This is an interface implemented by a tooltip text provider service.This service is called to discover what tooltip text is associated with the node over which the pointer is positioned. Embedders may implement and register their own tooltip text provider service if they wish to provide different tooltip text. The default service returns the text stored in the TITLE attribute of the node or a containing parent. This interface is not scriptable.

See also: nsITooltipListener, nsIComponentManager, nsIDOMNode

Note: The tooltip text provider service is registered with the contract defined in NS_TOOLTIPTEXTPROVIDER_CONTRACTID.

Methods

getNodeText

Obtains the tooltip text for a node.

Syntax:

boolean nsITooltipTextProvider::getNodeText(
	in nsIDOMNode aNode, out wstring aText) 

Parameters:

aNode:The node from which to obtain the text.

aText: [out]The tooltip text.

Returns:

PR_TRUE if tooltip text is associated with the node and was returned in the aText argument.

PR_FALSE otherwise.