PageRenderTime 147ms CodeModel.GetById 71ms app.highlight 5ms RepoModel.GetById 65ms app.codeStats 1ms

/gecko_sdk/idl/nsITooltipTextProvider.idl

http://firefox-mac-pdf.googlecode.com/
IDL | 78 lines | 7 code | 3 blank | 68 comment | 0 complexity | 79de6c09322abaf5253a64a560600b2c MD5 | raw file
 1/* -*- Mode: C++; 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 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) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *   Adam Lock <adamlock@netscape.com>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38 
39#include "nsISupports.idl"
40
41interface nsIDOMNode;
42
43/**
44 * An interface implemented by a tooltip text provider service. This
45 * service is called to discover what tooltip text is associated
46 * with the node that the pointer is positioned over.
47 *
48 * Embedders may implement and register their own tooltip text provider
49 * service if they wish to provide different tooltip text. 
50 *
51 * The default service returns the text stored in the TITLE
52 * attribute of the node or a containing parent.
53 *
54 * @note
55 * The tooltip text provider service is registered with the contract
56 * defined in NS_TOOLTIPTEXTPROVIDER_CONTRACTID.
57 *
58 * @see nsITooltipListener
59 * @see nsIComponentManager
60 * @see nsIDOMNode
61 *
62 * @status FROZEN
63 */
64[scriptable, uuid(b128a1e6-44f3-4331-8fbe-5af360ff21ee)]
65interface nsITooltipTextProvider : nsISupports
66{
67    /**
68     * Called to obtain the tooltip text for a node.
69     *
70     * @arg aNode The node to obtain the text from.
71     * @arg aText The tooltip text.
72     *
73     * @return <CODE>PR_TRUE</CODE> if tooltip text is associated
74     *         with the node and was returned in the aText argument;
75     *         <CODE>PR_FALSE</CODE> otherwise.
76     */
77    boolean getNodeText(in nsIDOMNode aNode, out wstring aText);
78};