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

nsITooltipListener

This is an optional interface for embedding clients wishing to receive notifications indicating when a tooltip should be displayed or removed.The embedder implements this interface on the WebBrowser chrome object associated with the window for which notifications are required. This interface is not scriptable.

See also: nsITooltipTextProvider

Methods
showTooltip

Displays a tooltip.

Syntax: 

void nsITooltipListener::onShowTooltip(in long aXCoords,
	in long aYCoords,in wstring aTipText)

Parameters:

aXCoords: The tooltip left edge X coordinate.
aYCoords: The tooltip top edge Y coordinate.
aTipText: The text to display in the tooltip, typically obtained from the TITLE attribute of the node (or containing parent) over which the pointer has been positioned.
Note: Coordinates are specified in pixels, relative to the top-left corner of the browser area.

nsresult:

NS_OK if the tooltip was displayed.
onHideToolTip

Hides tooltip, either because the pointer has moved or the tooltip has timed out.

Syntax: 

void nsITooltipListener::onHideTooltip()

Parameters:

None.

nsresult:

NS_OK if successful.
Written by:Ellen Evans | Comments, questions, complaints? Bug 143387
TOC PREV NEXT INDEX