Public Member Functions | Public Attributes

nsIEventTarget Interface Reference

import "nsIEventTarget.idl";

Inheritance diagram for nsIEventTarget:

List of all members.

Public Member Functions

void dispatch (in nsIRunnable event, in unsigned long flags)
 Dispatch an event to this event target.
boolean isOnCurrentThread ()
 Check to see if this event target is associated with the current thread.

Public Attributes

const unsigned long DISPATCH_NORMAL = 0
 This flag specifies the default mode of event dispatch, whereby the event is simply queued for later processing.
const unsigned long DISPATCH_SYNC = 1
 This flag specifies the synchronous mode of event dispatch, in which the dispatch method does not return until the event has been processed.

Member Function Documentation

void nsIEventTarget::dispatch ( in nsIRunnable  event,
in unsigned long  flags 
)

Dispatch an event to this event target.

This function may be called from any thread, and it may be called re-entrantly.

Parameters:
event The event to dispatch.
flags The flags modifying event dispatch. The flags are described in detail below.
Exceptions:
NS_ERROR_INVALID_ARG Indicates that event is null.
NS_ERROR_UNEXPECTED Indicates that the thread is shutting down and has finished processing events, so this event would never run and has not been dispatched.
boolean nsIEventTarget::isOnCurrentThread (  ) 

Check to see if this event target is associated with the current thread.

Returns:
A boolean value that if "true" indicates that events dispatched to this event target will run on the current thread (i.e., the thread calling this method).

Member Data Documentation

const unsigned long nsIEventTarget::DISPATCH_NORMAL = 0

This flag specifies the default mode of event dispatch, whereby the event is simply queued for later processing.

When this flag is specified, dispatch returns immediately after the event is queued.

const unsigned long nsIEventTarget::DISPATCH_SYNC = 1

This flag specifies the synchronous mode of event dispatch, in which the dispatch method does not return until the event has been processed.

NOTE: passing this flag to dispatch may have the side-effect of causing other events on the current thread to be processed while waiting for the given event to be processed.


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