Interface nsITooltipTextProviderType

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

  • nsITooltipListener
  • nsIComponentManager
  • Node

Hierarchy

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Called to obtain the tooltip text for a node.

    Arg

    aNode The node to obtain the text from.

    Arg

    aText The tooltip text.

    Arg

    aDirection The text direction (ltr or rtl) to use

    Returns

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

    Parameters

    • aNode: Node
    • aText: wstring
    • aDirection: wstring

    Returns boolean

Generated using TypeDoc