Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIContextMenuListener Interface Reference

An optional interface for embedding clients wishing to receive notifications for context menu events (e.g. More...

import "nsIContextMenuListener.idl";

Inheritance diagram for nsIContextMenuListener:
Inheritance graph
[legend]
Collaboration diagram for nsIContextMenuListener:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void onShowContextMenu (in unsigned long aContextFlags, in nsIDOMEvent aEvent, in nsIDOMNode aNode)
 Called when the browser receives a context menu event (e.g.

Public Attributes

const unsigned long CONTEXT_NONE = 0
 Flag.
const unsigned long CONTEXT_LINK = 1
 Flag.
const unsigned long CONTEXT_IMAGE = 2
 Flag.
const unsigned long CONTEXT_DOCUMENT = 4
 Flag.
const unsigned long CONTEXT_TEXT = 8
 Flag.
const unsigned long CONTEXT_INPUT = 16
 Flag.

Detailed Description

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 also:
nsIDOMNode
nsIDOMEvent

FROZEN

Definition at line 58 of file nsIContextMenuListener.idl.


Member Function Documentation

void nsIContextMenuListener::onShowContextMenu ( in unsigned long  aContextFlags,
in nsIDOMEvent  aEvent,
in nsIDOMNode  aNode 
)

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.

aContextFlagaNode
CONTEXT_LINK<A>
CONTEXT_IMAGE<IMG>
CONTEXT_IMAGE | CONTEXT_LINK<IMG> with an <A> as an ancestor
CONTEXT_INPUT<INPUT>
CONTEXT_TEXT<TEXTAREA>
CONTEXT_DOCUMENT<HTML>
Parameters:
aContextFlagsFlags indicating the kind of context.
aEventThe DOM context menu event.
aNodeThe DOM node most relevant to the context.
Returns:
NS_OK always.

Member Data Documentation

Flag.

Context is the whole document.

Definition at line 67 of file nsIContextMenuListener.idl.

Flag.

Context is an image element.

Definition at line 65 of file nsIContextMenuListener.idl.

Flag.

Context is an input element.

Definition at line 71 of file nsIContextMenuListener.idl.

Flag.

Context is a link element.

Definition at line 63 of file nsIContextMenuListener.idl.

Flag.

No context.

Definition at line 61 of file nsIContextMenuListener.idl.

Flag.

Context is a text area element.

Definition at line 69 of file nsIContextMenuListener.idl.


The documentation for this interface was generated from the following file: