modules/plugin/base/public/nsIEventHandler.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.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 #include "nspluginroot.idl"
  40
  41 %{C++
  42 #include "nsplugindefs.h"
  43 %}
  44
  45 [uuid(a447ddf0-1a99-11d2-815f-006008119d7a)]
  46 interface nsIEventHandler : nsISupports
  47 {
  48   /**
  49    * Handles an event. An nsIEventHandler can also get registered with with
  50    * nsIPluginManager2::RegisterWindow and will be called whenever an event
  51    * comes in for that window.
  52    *
  53    * Note that for Unix and Mac the nsPluginEvent structure is different
  54    * from the old NPEvent structure -- it's no longer the native event
  55    * record, but is instead a struct. This was done for future extensibility,
  56    * and so that the Mac could receive the window argument too. For Windows
  57    * and OS2, it's always been a struct, so there's no change for them.
  58    *
  59    * (Corresponds to NPP_HandleEvent.)
  60    *
  61    * @param aEvent   - the event to be handled
  62    * @param aHandled - set to PR_TRUE if event was handled
  63    * @result         - NS_OK if this operation was successful
  64    */
  65   void handleEvent(in nsPluginEventPtr aEvent, out boolean aHandled);
  66 };