Back to index

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

An interface implemented by a tooltip text provider service. More...

import "nsITooltipTextProvider.idl";

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

List of all members.

Public Member Functions

boolean getNodeText (in nsIDOMNode aNode, out wstring aText)
 Called to obtain the tooltip text for a node.

Detailed Description

An interface implemented by a tooltip text provider service.

This service is called to discover what tooltip text is associated with the node that the pointer is positioned over.

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.

Note:
The tooltip text provider service is registered with the contract defined in NS_TOOLTIPTEXTPROVIDER_CONTRACTID.
See also:
nsITooltipListener
nsIComponentManager
nsIDOMNode

FROZEN

Definition at line 65 of file nsITooltipTextProvider.idl.


Member Function Documentation

Called to obtain the tooltip text for a node.

  • aNode The node to obtain the text from.
  • aText The tooltip text.
Returns:
PR_TRUE if tooltip text is associated with the node and was returned in the aText argument; PR_FALSE otherwise.

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