PageRenderTime 102ms CodeModel.GetById 60ms app.highlight 2ms RepoModel.GetById 39ms app.codeStats 0ms

/gecko_sdk/idl/nsITooltipListener.idl

http://firefox-mac-pdf.googlecode.com/
IDL | 78 lines | 7 code | 3 blank | 68 comment | 0 complexity | 0a1273adbfef2fee3f2fa141d152beb3 MD5 | raw file
 1/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 2/* ***** BEGIN LICENSE BLOCK *****
 3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 4 *
 5 * The contents of this file are subject to the Mozilla Public License Version
 6 * 1.1 (the "License"); you may not use this file except in compliance with
 7 * the License. You may obtain a copy of the License at
 8 * http://www.mozilla.org/MPL/
 9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 2001
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *   Mike Pinkerton <pinkerton@netscape.com>
24 *   Adam Lock <adamlock@netscape.com>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39 
40#include "nsISupports.idl"
41
42/**
43 * An optional interface for embedding clients wishing to receive
44 * notifications for when a tooltip should be displayed or removed.
45 * The embedder implements this interface on the web browser chrome
46 * object associated with the window that notifications are required
47 * for.
48 *
49 * @see nsITooltipTextProvider
50 *
51 * @status FROZEN
52 */
53[scriptable, uuid(44b78386-1dd2-11b2-9ad2-e4eee2ca1916)]
54interface nsITooltipListener : nsISupports
55{
56    /**
57     * Called when a tooltip should be displayed.
58     *
59     * @param aXCoords The tooltip left edge X coordinate.
60     * @param aYCoords The tooltip top edge Y coordinate.
61     * @param aTipText The text to display in the tooltip, typically obtained
62     *        from the TITLE attribute of the node (or containing parent)
63     *        over which the pointer has been positioned.
64     *
65     * @note
66     * Coordinates are specified in pixels, relative to the top-left
67     * corner of the browser area.
68     *
69     * @return <code>NS_OK</code> if the tooltip was displayed.
70     */
71    void onShowTooltip(in long aXCoords, in long aYCoords, in wstring aTipText);
72  
73    /**
74     * Called when the tooltip should be hidden, either because the pointer
75     * has moved or the tooltip has timed out.
76     */
77    void onHideTooltip();
78};