Back to index

lightning-sunbird  0.9+nobinonly
nsIScriptEventManager.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications
00019  * Portions created by the Initial Developer are Copyright (C) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Rick Potts <rpotts@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 
00042 [uuid(b6427ace-dc77-495b-ab21-43baeb52bc27)]
00043 interface nsIScriptEventManager : nsISupports
00044 {
00045  /*
00046   * FindEventHandler:
00047   *
00048   * Returns a script event handler for the given object and event name.
00049   *
00050   * @param aObjectName    Name of the object raising the event.
00051   *
00052   * @param aEventName     Name of the event being raised.
00053   *
00054   * @param aArgCount      Number of arguments expected by the event handler.
00055   *
00056   */
00057   nsISupports FindEventHandler(in AString aObjectName,
00058                                in AString aEventName,
00059                                in unsigned long aArgCount);
00060 
00061  /*
00062   *
00063   * InvokeEventHandler:
00064   *
00065   * Executes the script handler that was returned from FindEventHandler.
00066   *
00067   * @param aHandler       Script event handler that was returned from
00068   *                       FindEventHandler.
00069   *
00070   * @param aTargetObject  Object to which the script handler is bound.
00071   *
00072   * @param aArgs          Array of arguments passed to the script handler.
00073   *                       This is an array of jsvals.
00074   *
00075   * @param aArgCount      Number of elements in the aArgs array.
00076   *
00077   */
00078   void InvokeEventHandler(in nsISupports aHandler,
00079                           in nsISupports aTargetObject,
00080                           in voidPtr aArgs,
00081                           in unsigned long aArgCount);
00082 };
00083