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";

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
Status:
FROZEN

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:
aContextFlags Flags indicating the kind of context.
aEvent The DOM context menu event.
aNode The DOM node most relevant to the context.
Returns:
NS_OK always.

Member Data Documentation

Flag.

Context is the whole document.

const unsigned long nsIContextMenuListener::CONTEXT_IMAGE = 2

Flag.

Context is an image element.

const unsigned long nsIContextMenuListener::CONTEXT_INPUT = 16

Flag.

Context is an input element.

const unsigned long nsIContextMenuListener::CONTEXT_LINK = 1

Flag.

Context is a link element.

const unsigned long nsIContextMenuListener::CONTEXT_NONE = 0

Flag.

No context.

const unsigned long nsIContextMenuListener::CONTEXT_TEXT = 8

Flag.

Context is a text area element.


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