widget/public/nsIEventListener.h

   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 #ifndef nsIEventListener_h__
  39 #define nsIEventListener_h__
  40
  41 #include "nsISupports.h"
  42
  43 class nsGUIEvent;
  44
  45 /**
  46  * Event listener interface.
  47  * Alternative to a callback for recieving events.
  48  */
  49
  50 // {c83f6b80-d7ce-11d2-8360-c4c894c4917c}
  51 #define NS_IEVENTLISTENER_IID \
  52 { 0xc83f6b80, 0xd7ce, 0x11d2, { 0x83, 0x60, 0xc4, 0xc8, 0x94, 0xc4, 0x91, 0x7c } }
  53
  54 class nsIEventListener : public nsISupports {
  55 public:
  56   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IEVENTLISTENER_IID)
  57
  58  /**
  59   * Processes all events.
  60   * If a mouse listener is registered this method will not process mouse events.
  61   * @param anEvent the event to process. See nsGUIEvent.h for event types.
  62   */
  63
  64   virtual nsEventStatus ProcessEvent(const nsGUIEvent & anEvent) = 0;
  65
  66 };
  67
  68 NS_DEFINE_STATIC_IID_ACCESSOR(nsIEventListener, NS_IEVENTLISTENER_IID)
  69
  70 #endif // nsIEventListener_h__