embedding/browser/webBrowser/nsITooltipTextProvider.idl@6474c204b198 (annotated)
embedding/browser/webBrowser/nsITooltipTextProvider.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | interface nsIDOMNode; |
| michael@0 | 9 | |
| michael@0 | 10 | /** |
| michael@0 | 11 | * An interface implemented by a tooltip text provider service. This |
| michael@0 | 12 | * service is called to discover what tooltip text is associated |
| michael@0 | 13 | * with the node that the pointer is positioned over. |
| michael@0 | 14 | * |
| michael@0 | 15 | * Embedders may implement and register their own tooltip text provider |
| michael@0 | 16 | * service if they wish to provide different tooltip text. |
| michael@0 | 17 | * |
| michael@0 | 18 | * The default service returns the text stored in the TITLE |
| michael@0 | 19 | * attribute of the node or a containing parent. |
| michael@0 | 20 | * |
| michael@0 | 21 | * @note |
| michael@0 | 22 | * The tooltip text provider service is registered with the contract |
| michael@0 | 23 | * defined in NS_TOOLTIPTEXTPROVIDER_CONTRACTID. |
| michael@0 | 24 | * |
| michael@0 | 25 | * @see nsITooltipListener |
| michael@0 | 26 | * @see nsIComponentManager |
| michael@0 | 27 | * @see nsIDOMNode |
| michael@0 | 28 | */ |
| michael@0 | 29 | [scriptable, uuid(b128a1e6-44f3-4331-8fbe-5af360ff21ee)] |
| michael@0 | 30 | interface nsITooltipTextProvider : nsISupports |
| michael@0 | 31 | { |
| michael@0 | 32 | /** |
| michael@0 | 33 | * Called to obtain the tooltip text for a node. |
| michael@0 | 34 | * |
| michael@0 | 35 | * @arg aNode The node to obtain the text from. |
| michael@0 | 36 | * @arg aText The tooltip text. |
| michael@0 | 37 | * |
| michael@0 | 38 | * @return <CODE>PR_TRUE</CODE> if tooltip text is associated |
| michael@0 | 39 | * with the node and was returned in the aText argument; |
| michael@0 | 40 | * <CODE>PR_FALSE</CODE> otherwise. |
| michael@0 | 41 | */ |
| michael@0 | 42 | boolean getNodeText(in nsIDOMNode aNode, out wstring aText); |
| michael@0 | 43 | }; |
