author Michael Wu <mwu@mozilla.com>
Sat, 28 May 2011 00:16:11 -0700
changeset 70270 c8bc6089f86dcafd8b07b4ebf16746e54961be28
parent 47159 84c1694a4ca9af3a0fd5605a7ec0e9b9e7bd0129
child 94484 f4157e8c410708d76703f19e4dfb61859bfe32d8
permissions -rw-r--r--
Merge backout of Bug 592943 due to extensions bustage

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ 
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 * The Original Code is is mozilla.org code.
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 * Contributor(s):
 *   Adam Lock <adamlock@netscape.com>
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 * ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"

interface nsIDOMNode;

 * 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
 * @see nsITooltipListener
 * @see nsIComponentManager
 * @see nsIDOMNode
[scriptable, uuid(b128a1e6-44f3-4331-8fbe-5af360ff21ee)]
interface nsITooltipTextProvider : nsISupports
     * Called to obtain the tooltip text for a node.
     * @arg aNode The node to obtain the text from.
     * @arg aText The tooltip text.
     * @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);