nsITooltipTextProvider and contract id split out into its own files frozen and documented. b=99181 r=chak@netscape.com sr=rpotts@netscape.com

This commit is contained in:
locka%iol.ie 2001-09-20 13:25:40 +00:00
Родитель 87d3f70038
Коммит dc743acdc5
7 изменённых файлов: 112 добавлений и 77 удалений

Просмотреть файл

@ -29,3 +29,5 @@ nsIEmbeddingSiteWindow.idl
nsIWebBrowserPersist.idl
nsIWebBrowserFocus.idl
nsIWebBrowserPrint.idl
nsITooltipListener.idl
nsITooltipTextProvider.idl

Просмотреть файл

@ -49,6 +49,10 @@ REQUIRES = xpcom \
include $(DEPTH)/config/autoconf.mk
EXPORTS = \
nsCTooltipTextProvider.h \
$(NULL)
XPIDLSRCS = \
nsCWebBrowser.idl \
nsIWebBrowser.idl \
@ -59,6 +63,7 @@ XPIDLSRCS = \
nsIContextMenuListener.idl \
nsIEmbeddingSiteWindow.idl \
nsITooltipListener.idl \
nsITooltipTextProvider.idl \
nsIWebBrowserPersist.idl \
nsIWebBrowserFocus.idl \
nsIWebBrowserPrint.idl \

Просмотреть файл

@ -44,9 +44,14 @@ REQUIRES = xpcom \
history \
$(NULL)
EXPORTS = \
nsCTooltipTextProvider.h \
$(NULL)
XPIDLSRCS= \
.\nsIContextMenuListener.idl \
.\nsITooltipListener.idl \
.\nsITooltipTextProvider.idl \
.\nsCWebBrowser.idl \
.\nsIWebBrowser.idl \
.\nsIWebBrowserChrome.idl \

Просмотреть файл

@ -1,24 +1,40 @@
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* -*- 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 Netscape Communications Corporation are
* Copyright (C) 1998 Netscape Communications Corporation.
* All Rights Reserved.
*
* 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 the Mozilla browser.
*
* The Initial Developer of the Original Code is Netscape
* Communications, Inc. Portions created by Netscape are
* Copyright (C) 1999, Mozilla. All Rights Reserved.
*
* Contributor(s):
* Adam Lock <adamlock@netscape.com>
*/
*
* Alternatively, the contents of this file may be used under the terms of
* either of 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 LGPL or the GPL. 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 ----- */
#ifndef NSCTOOLTIPTEXTPROVIDER_H
#define NSCTOOLTIPTEXTPROVIDER_H

Просмотреть файл

@ -47,6 +47,8 @@
#include "nsIPrompt.h"
#include "nsIAuthPrompt.h"
#include "nsITooltipListener.h"
#include "nsITooltipTextProvider.h"
#include "nsCTooltipTextProvider.h"
#include "nsCommandHandler.h"

Просмотреть файл

@ -21,53 +21,45 @@
* Mike Pinkerton <pinkerton@netscape.com>
*
* Contributor(s):
* Adam Lock <adamlock@netscape.com>
*/
#include "nsISupports.idl"
interface nsIDOMNode;
//
// nsITooltipTextProvider
//
// Interface implemented by a tooltip text provider service, returns
// the text to display above a particular node (e.g. the TITLE tag).
//
[uuid(b128a1e6-44f3-4331-8fbe-5af360ff21ee)]
interface nsITooltipTextProvider : nsISupports
{
boolean getNodeText(in nsIDOMNode aNode, out wstring aText);
};
%{ C++
#define NS_TOOLTIPTEXTPROVIDER_CONTRACTID \
"@mozilla.org/embedcomp/tooltiptextprovider;1"
%}
//
// nsITooltipListener interface
//
// Used to tell an embedding client when a tooltip should be displayed or hidden.
//
/**
* 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
*/
[uuid(44b78386-1dd2-11b2-9ad2-e4eee2ca1916)]
interface nsITooltipListener : nsISupports
{
// Called when the tooltip should be displayed. The tooltip will
// time out after a pre-determined length of time.
//
// aXCoords, aYCoords - the X/Y coordinates of where to display
// the tooltip. Note these coordinates are local to the the browser
// content area, not the top-level window.
// aTipText - the text to display, obtained from the TITLE attribute
// on the node (or a containing parent) over which the mouse is hovering.
// This is a unicode string.
//
// Returning any result other than NS_OK will cause Gecko to
// behave as if no tooltip was displayed (no auto-timeout, etc).
void onShowTooltip ( in long aXCoords, in long aYCoords, in wstring aTipText ) ;
/**
* 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 by a mouse move
// or an auto-hide of the tooltip.
void onHideTooltip ( ) ;
/**
* Called when the tooltip should be hidden, either because the pointer
* has moved or the tooltip has timed out.
*/
void onHideTooltip();
};

Просмотреть файл

@ -1,27 +1,40 @@
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* -*- 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 Netscape 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/NPL/
* 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.
* 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 Original Code is is mozilla.org code.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 2001 Netscape Communications Corporation. All
* Rights Reserved.
*
* Author:
* The Initial Developer of the Original Code is Netscape Communications Corporation.
* Portions created by Netscape Communications Corporation are
* Copyright (C) 1998 Netscape Communications Corporation.
* All Rights Reserved.
*
* Contributor(s):
* Adam Lock <adamlock@netscape.com>
*
* Contributor(s):
*/
* Alternatively, the contents of this file may be used under the terms of
* either of 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 LGPL or the GPL. 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"