Struct xpcom::interfaces::nsITooltipTextProvider [] [src]

#[repr(C)]
pub struct nsITooltipTextProvider { /* fields omitted */ }

interface nsITooltipTextProvider : nsISupports

/**
 * 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
 * @see nsIComponentManager
 * @see nsIDOMNode
 */

Methods

impl nsITooltipTextProvider
[src]

[src]

Cast this nsITooltipTextProvider to one of its base interfaces.

impl nsITooltipTextProvider
[src]

[src]

/**
     * 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
     *
     * @return <CODE>PR_TRUE</CODE> if tooltip text is associated
     *         with the node and was returned in the aText argument;
     *         <CODE>PR_FALSE</CODE> otherwise.
     */

boolean getNodeText (in nsIDOMNode aNode, out wstring aText, out wstring aDirection);

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsITooltipTextProvider
[src]

IID: nsIID = nsID(2972230118, 17651, 17201, [143, 190, 90, 243, 96, 255, 33, 238])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsITooltipTextProvider
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsITooltipTextProvider
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.