content/base/public/nsIScriptEventHandler.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications
  19  * Portions created by the Initial Developer are Copyright (C) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Rick Potts <rpotts@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41
  42 [uuid(375f787f-8d3a-4344-b540-293d5645c22c)]
  43 interface nsIScriptEventHandler : nsISupports
  44 {
  45  /**
  46   * IsSameEvent:
  47   *
  48   * Determines if this script event handler is bound to the given
  49   * object and event name.
  50   *
  51   * @param aObjectName  Name of the object raising the event.
  52   *
  53   * @param aEventName   Name of the event being raised.
  54   *
  55   * @param aArgCount    Number of arguments expected by the event handler.
  56   *
  57   */
  58   boolean IsSameEvent(in AString aObjectName,
  59                       in AString aEventName,
  60                       in unsigned long aArgCount);
  61
  62  /**
  63   * Invoke:
  64   *
  65   * Executes this script handler.
  66   *
  67   * @param aTargetObject  Object to which the script handler is bound.
  68   *
  69   * @param aArgs          Array of arguments passed to the script handler.
  70   *                       This is an array of jsvals.
  71   *
  72   * @param aArgCount      Number of elements in the aArgs array.
  73   *
  74   */
  75   void Invoke(in nsISupports aTargetObject,
  76               in voidPtr aArgs,
  77               in unsigned long aArgCount);
  78 };