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

PlugIns编程

开发平台:

Visual C++

  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.  * An optional interface for embedding clients wishing to receive
  43.  * notifications for when a tooltip should be displayed or removed.
  44.  * The embedder implements this interface on the web browser chrome
  45.  * object associated with the window that notifications are required
  46.  * for.
  47.  *
  48.  * @see nsITooltipTextProvider
  49.  *
  50.  * @status FROZEN
  51.  */
  52. [scriptable, uuid(44b78386-1dd2-11b2-9ad2-e4eee2ca1916)]
  53. interface nsITooltipListener : nsISupports
  54. {
  55.     /**
  56.      * Called when a tooltip should be displayed.
  57.      *
  58.      * @param aXCoords The tooltip left edge X coordinate.
  59.      * @param aYCoords The tooltip top edge Y coordinate.
  60.      * @param aTipText The text to display in the tooltip, typically obtained
  61.      *        from the TITLE attribute of the node (or containing parent)
  62.      *        over which the pointer has been positioned.
  63.      *
  64.      * @note
  65.      * Coordinates are specified in pixels, relative to the top-left
  66.      * corner of the browser area.
  67.      *
  68.      * @return <code>NS_OK</code> if the tooltip was displayed.
  69.      */
  70.     void onShowTooltip(in long aXCoords, in long aYCoords, in wstring aTipText);
  71.   
  72.     /**
  73.      * Called when the tooltip should be hidden, either because the pointer
  74.      * has moved or the tooltip has timed out.
  75.      */
  76.     void onHideTooltip();
  77. };