Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIEventSink Interface Reference

The nsIEventSink is implemented internally by Gecko as the conduit through which native events travel into Gecko. More...

import "nsIEventSink.idl";

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

List of all members.

Public Member Functions

boolean dispatchEvent (in voidPtr anEvent)
 Entry point for native events into Gecko.
boolean dragEvent (in unsigned long aMessage, in short aMouseGlobalX, in short aMouseGlobalY, in unsigned short aKeyModifiers)
 Alerts gecko of a drag event.
boolean scroll (in boolean aVertical, in short aNumLines, in short aMouseLocalX, in short aMouseLocalY)
 Tell gecko to scroll, usually in response to a mouse-wheel.
void Idle ()
 Perform any idle processing (handle timers, set the cursor, etc)

Detailed Description

The nsIEventSink is implemented internally by Gecko as the conduit through which native events travel into Gecko.

You obtain an event sink by QI'ing the top-level nsIWidget, usually a window.

UNDER_REVIEW

Definition at line 52 of file nsIEventSink.idl.


Member Function Documentation

boolean nsIEventSink::dispatchEvent ( in voidPtr  anEvent)

Entry point for native events into Gecko.

Returns:
PR_TRUE if event was handled PR_FALSE if not handled

On Mac, anEvent is a native EventRecord*.

boolean nsIEventSink::dragEvent ( in unsigned long  aMessage,
in short  aMouseGlobalX,
in short  aMouseGlobalY,
in unsigned short  aKeyModifiers 
)

Alerts gecko of a drag event.

Parameters:
aMessagethe message parameter for a Gecko NS_DRAGDROP_EVENT (See nsGUIEvent.h for list).
aMouseGlobalXx coordinate of mouse, in global coordinates
aMouseGlobalYy coordinate of mouse, in global coordinates
aKeyModifiersa native bitfield of which modifier keys are currently pressed
Returns:
PR_TRUE if event was handled PR_FALSE if not handled

Perform any idle processing (handle timers, set the cursor, etc)

boolean nsIEventSink::scroll ( in boolean  aVertical,
in short  aNumLines,
in short  aMouseLocalX,
in short  aMouseLocalY 
)

Tell gecko to scroll, usually in response to a mouse-wheel.

Parameters:
aVerticalPR_TRUE if scrolling veritcally, PR_FALSE if horizontal
aNumLinesthe number of lines to scroll, positive for down, negative for up
aMouseLocalXthe x coordinate of the mouse in window (local) coordinates
aMouseLocalYthe y coordinate of the mouse in window (local) coordinates

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