nsITooltipTextProvider.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:3k
源码类别:

PlugIns编程

开发平台:

Visual C++

  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. interface nsIDOMNode;
  41. /**
  42.  * An interface implemented by a tooltip text provider service. This
  43.  * service is called to discover what tooltip text is associated
  44.  * with the node that the pointer is positioned over.
  45.  *
  46.  * Embedders may implement and register their own tooltip text provider
  47.  * service if they wish to provide different tooltip text. 
  48.  *
  49.  * The default service returns the text stored in the TITLE
  50.  * attribute of the node or a containing parent.
  51.  *
  52.  * @note
  53.  * The tooltip text provider service is registered with the contract
  54.  * defined in NS_TOOLTIPTEXTPROVIDER_CONTRACTID.
  55.  *
  56.  * @see nsITooltipListener
  57.  * @see nsIComponentManager
  58.  * @see nsIDOMNode
  59.  *
  60.  * @status FROZEN
  61.  */
  62. [scriptable, uuid(b128a1e6-44f3-4331-8fbe-5af360ff21ee)]
  63. interface nsITooltipTextProvider : nsISupports
  64. {
  65.     /**
  66.      * Called to obtain the tooltip text for a node.
  67.      *
  68.      * @arg aNode The node to obtain the text from.
  69.      * @arg aText The tooltip text.
  70.      *
  71.      * @return <CODE>PR_TRUE</CODE> if tooltip text is associated
  72.      *         with the node and was returned in the aText argument;
  73.      *         <CODE>PR_FALSE</CODE> otherwise.
  74.      */
  75.     boolean getNodeText(in nsIDOMNode aNode, out wstring aText);
  76. };