dom/events/nsIEventListenerService.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 interface nsIDOMEventListener;
   9 interface nsIDOMEventTarget;
  10
  11 /**
  12  * An instance of this interface describes how an event listener
  13  * was added to an event target.
  14  */
  15 [scriptable, uuid(11ba5fd7-8db2-4b1a-9f67-342cfa11afad)]
  16 interface nsIEventListenerInfo : nsISupports
  17 {
  18   /**
  19    * The type of the event for which the listener was added.
  20    * Null if the listener is for all the events.
  21    */
  22   readonly attribute AString type;
  23   readonly attribute boolean capturing;
  24   readonly attribute boolean allowsUntrusted;
  25   readonly attribute boolean inSystemEventGroup;
  26
  27   /**
  28    * The underlying JS object of the event listener, if this listener
  29    * has one.  Null otherwise.
  30    */
  31   [implicit_jscontext]
  32   readonly attribute jsval listenerObject;
  33
  34   /**
  35    * Tries to serialize event listener to a string.
  36    * Returns null if serialization isn't possible
  37    * (for example with C++ listeners).
  38    */
  39   AString toSource();
  40 };
  41
  42 [scriptable, uuid(f6964bfb-dabe-4cab-9733-be0ee2bf8171)]
  43 interface nsIEventListenerService : nsISupports
  44 {
  45   /**
  46    * Returns an array of nsIEventListenerInfo objects.
  47    * If aEventTarget doesn't have any listeners, this returns null.
  48    */
  49   void getListenerInfoFor(in nsIDOMEventTarget aEventTarget,
  50                           [optional] out unsigned long aCount,
  51                           [retval, array, size_is(aCount)] out
  52                             nsIEventListenerInfo aOutArray);
  53
  54   /**
  55    * Returns an array of event targets.
  56    * aEventTarget will be at index 0.
  57    * The objects are the ones that would be used as DOMEvent.currentTarget while
  58    * dispatching an event to aEventTarget
  59    * @note Some events, especially 'load', may actually have a shorter
  60    *       event target chain than what this methods returns.
  61    */
  62   void getEventTargetChainFor(in nsIDOMEventTarget aEventTarget,
  63                               [optional] out unsigned long aCount,
  64                               [retval, array, size_is(aCount)] out
  65                                 nsIDOMEventTarget aOutArray);
  66
  67   /**
  68    * Returns true if a event target has any listener for the given type.
  69    */
  70   boolean hasListenersFor(in nsIDOMEventTarget aEventTarget,
  71                           in DOMString aType);
  72
  73   /**
  74    * Add a system-group eventlistener to a event target.
  75    */
  76   void addSystemEventListener(in nsIDOMEventTarget target,
  77                               in DOMString type,
  78                               in nsIDOMEventListener listener,
  79                               in boolean useCapture);
  80
  81   /**
  82    * Remove a system-group eventlistener from a event target.
  83    */
  84   void removeSystemEventListener(in nsIDOMEventTarget target,
  85                                  in DOMString type,
  86                                  in nsIDOMEventListener listener,
  87                                  in boolean useCapture);
  88
  89   void addListenerForAllEvents(in nsIDOMEventTarget target,
  90                                in nsIDOMEventListener listener,
  91                                [optional] in boolean aUseCapture,
  92                                [optional] in boolean aWantsUntrusted,
  93                                [optional] in boolean aSystemEventGroup);
  94
  95   void removeListenerForAllEvents(in nsIDOMEventTarget target,
  96                                   in nsIDOMEventListener listener,
  97                                   [optional] in boolean aUseCapture,
  98                                   [optional] in boolean aSystemEventGroup);
  99 };
 100