Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsITooltipListener Interface Reference

An optional interface for embedding clients wishing to receive notifications for when a tooltip should be displayed or removed. More...

import "nsITooltipListener.idl";

Inheritance diagram for nsITooltipListener:
Inheritance graph
[legend]
Collaboration diagram for nsITooltipListener:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void onShowTooltip (in long aXCoords, in long aYCoords, in wstring aTipText)
 Called when a tooltip should be displayed.
void onHideTooltip ()
 Called when the tooltip should be hidden, either because the pointer has moved or the tooltip has timed out.

Detailed Description

An optional interface for embedding clients wishing to receive notifications for when a tooltip should be displayed or removed.

The embedder implements this interface on the web browser chrome object associated with the window that notifications are required for.

See also:
nsITooltipTextProvider

FROZEN

Definition at line 54 of file nsITooltipListener.idl.


Member Function Documentation

Called when the tooltip should be hidden, either because the pointer has moved or the tooltip has timed out.

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

Called when a tooltip should be displayed.

Parameters:
aXCoordsThe tooltip left edge X coordinate.
aYCoordsThe tooltip top edge Y coordinate.
aTipTextThe 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.
Returns:
NS_OK if the tooltip was displayed.

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