| /* -*- 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) 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 nsIDOMEvent; |
| interface nsIDOMNode; |
| |
| /** |
| * An optional interface for embedding clients wishing to receive |
| * notifications for context menu events (e.g. generated by |
| * a user right-mouse clicking on a link). The embedder implements |
| * this interface on the web browser chrome object associated |
| * with the window that notifications are required for. When a context |
| * menu event, the browser will call this interface if present. |
| * |
| * @see nsIDOMNode |
| * @see nsIDOMEvent |
| * |
| * @status FROZEN |
| */ |
| [scriptable, uuid(3478b6b0-3875-11d4-94ef-0020183bf181)] |
| interface nsIContextMenuListener : nsISupports |
| { |
| /** Flag. No context. */ |
| const unsigned long CONTEXT_NONE = 0; |
| /** Flag. Context is a link element. */ |
| const unsigned long CONTEXT_LINK = 1; |
| /** Flag. Context is an image element. */ |
| const unsigned long CONTEXT_IMAGE = 2; |
| /** Flag. Context is the whole document. */ |
| const unsigned long CONTEXT_DOCUMENT = 4; |
| /** Flag. Context is a text area element. */ |
| const unsigned long CONTEXT_TEXT = 8; |
| /** Flag. Context is an input element. */ |
| const unsigned long CONTEXT_INPUT = 16; |
| |
| /** |
| * Called when the browser receives a context menu event (e.g. user is right-mouse |
| * clicking somewhere on the document). The combination of flags, event and node |
| * provided in the call indicate where and what was clicked on. |
| * |
| * The following table describes what context flags and node combinations are |
| * possible. |
| * |
| * <TABLE> |
| * <TR><TD><B>aContextFlag</B></TD><TD>aNode</TD></TR> |
| * <TR><TD>CONTEXT_LINK</TD><TD><A></TD></TR> |
| * <TR><TD>CONTEXT_IMAGE</TD><TD><IMG></TD></TR> |
| * <TR><TD>CONTEXT_IMAGE | CONTEXT_LINK</TD><TD><IMG> |
| * with an <A> as an ancestor</TD></TR> |
| * <TR><TD>CONTEXT_INPUT</TD><TD><INPUT></TD></TR> |
| * <TR><TD>CONTEXT_TEXT</TD><TD><TEXTAREA></TD></TR> |
| * <TR><TD>CONTEXT_DOCUMENT</TD><TD><HTML></TD></TR> |
| * </TABLE> |
| * |
| * @param aContextFlags Flags indicating the kind of context. |
| * @param aEvent The DOM context menu event. |
| * @param aNode The DOM node most relevant to the context. |
| * |
| * @return <CODE>NS_OK</CODE> always. |
| */ |
| void onShowContextMenu(in unsigned long aContextFlags, in nsIDOMEvent aEvent, in nsIDOMNode aNode); |
| }; |
| |