| /* -*- Mode: IDL; 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 mozilla.org code. |
| * |
| * The Initial Developer of the Original Code is |
| * Netscape Communications Corporation. |
| * Portions created by the Initial Developer are Copyright (C) 2001 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * Mike Pinkerton <pinkerton@netscape.com> |
| * 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" |
| |
| /** |
| * An optional interface for embedding clients wishing to receive |
| * notifications for when a tooltip should be displayed or removed. |
| * The embedder implements this interface on the web browser chrome |
| * object associated with the window that notifications are required |
| * for. |
| * |
| * @see nsITooltipTextProvider |
| * |
| * @status FROZEN |
| */ |
| [scriptable, uuid(44b78386-1dd2-11b2-9ad2-e4eee2ca1916)] |
| interface nsITooltipListener : nsISupports |
| { |
| /** |
| * Called when a tooltip should be displayed. |
| * |
| * @param aXCoords The tooltip left edge X coordinate. |
| * @param aYCoords The tooltip top edge Y coordinate. |
| * @param aTipText The text to display in the tooltip, typically obtained |
| * from the TITLE attribute of the node (or containing parent) |
| * over which the pointer has been positioned. |
| * |
| * @note |
| * Coordinates are specified in pixels, relative to the top-left |
| * corner of the browser area. |
| * |
| * @return <code>NS_OK</code> if the tooltip was displayed. |
| */ |
| void onShowTooltip(in long aXCoords, in long aYCoords, in wstring aTipText); |
| |
| /** |
| * Called when the tooltip should be hidden, either because the pointer |
| * has moved or the tooltip has timed out. |
| */ |
| void onHideTooltip(); |
| }; |