Struct xpcom::interfaces::nsITooltipListener [] [src]

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

interface nsITooltipListener : nsISupports

/**
 * 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 nsITooltipTextProvider
 */

Methods

impl nsITooltipListener
[src]

[src]

Cast this nsITooltipListener to one of its base interfaces.

impl nsITooltipListener
[src]

[src]

/**
     * Called when a tooltip should be displayed.
     *
     * @param aXCoords The tooltip left edge X coordinate.
     * @param aYCoords The tooltip top edge Y coordinate.
     * @param 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.
     * @param aTipDir  The direction (ltr or rtl) in which to display the text
     *
     * @note
     * Coordinates are specified in pixels, relative to the top-left
     * corner of the browser area.
     *
     * @return <code>NS_OK</code> if the tooltip was displayed.
     */

void onShowTooltip (in long aXCoords, in long aYCoords, in wstring aTipText, in wstring aTipDir);

[src]

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

void onHideTooltip ();

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 nsITooltipListener
[src]

IID: nsIID = nsID(1152877446, 7634, 4530, [154, 210, 228, 238, 226, 202, 25, 22])

[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 nsITooltipListener
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsITooltipListener
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.