nsIContextMenuListener frozen. Updated documentation. b=99181 r=chak@netscape.com sr=rpotts@netscape.com

2001-09-20 12:15:52 +00:00 · 2001-09-20 12:15:52 +00:00 · 4accdb9db9
--- a/embedding/browser/webBrowser/nsIContextMenuListener.idl
+++ b/embedding/browser/webBrowser/nsIContextMenuListener.idl
@ -29,43 +29,59 @@ interface nsIDOMEvent;
 interface nsIDOMNode;

 /**
- * The nsIContextMenuListener interface is called on embedding clients when
- * a context menu should be displayed.
+ * 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 UNDER_REVIEW
+ * @status FROZEN
 */
-
 [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 user attempts to display a context menu, e.g. by
-     * right-clicking on a link. The combination of flags indicates what was
-     * clicked on, the DOM event and node objects allow the client to interrogate
-     * for more information if they like.
+     * 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 aNode points two given a particular
-     * aContextFlag. No other combinations are possible.
+     * The following table describes what context flags and node combinations are
+     * possible.
     *
-     * aContextFlag                  |  aNode
-     * ------------------------------+-----------------
-     * CONTEXT_LINK                  |  <A>
-     * CONTEXT_IMAGE                 |  <IMG>
-     * CONTEXT_IMAGE | CONTEXT_LINK  |  <IMG> *
-     * CONTEXT_INPUT                 |  <INPUT>
-     * CONTEXT_TEXT                  |  <TEXTAREA>
-     * CONTEXT_DOCUMENT              |  <HTML>
+     * <TABLE>
+     * <TR><TD><B>aContextFlag</B></TD><TD>aNode</TD></TR>
+     * <TR><TD>CONTEXT_LINK</TD><TD>&lt;A&gt;</TD></TR>
+     * <TR><TD>CONTEXT_IMAGE</TD><TD>&lt;IMG&gt;</TD></TR>
+     * <TR><TD>CONTEXT_IMAGE | CONTEXT_LINK</TD><TD>&lt;IMG&gt;
+     *       with an &lt;A&gt; as an ancestor</TD></TR>
+     * <TR><TD>CONTEXT_INPUT</TD><TD>&lt;INPUT&gt;</TD></TR>
+     * <TR><TD>CONTEXT_TEXT</TD><TD>&lt;TEXTAREA&gt;</TD></TR>
+     * <TR><TD>CONTEXT_DOCUMENT</TD><TD>&lt;HTML&gt;</TD></TR>
+     * </TABLE>
     *
-     * * <A> node is guaranteed to be an ancestor of this node
+     * @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);
+    void onShowContextMenu(in unsigned long aContextFlags, in nsIDOMEvent aEvent, in nsIDOMNode aNode);
 };