You are currently viewing a snapshot of www.mozilla.org taken on April 21, 2008. Most of this content is highly out of date (some pages haven't been updated since the project began in 1998) and exists for historical purposes only. If there are any pages on this archive site that you think should be added back to www.mozilla.org, please file a bug.

Skip to main content

TOC PREV NEXT INDEX

Embedding Gecko API

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.
Written by:Ellen Evans | Comments, questions, complaints? Bug 143387
TOC PREV NEXT INDEX