widget/public/nsIMouseListener.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
  39 #ifndef nsIMouseListener_h__
  40 #define nsIMouseListener_h__
  41
  42 #include "nsEvent.h"
  43 #include "nsISupports.h"
  44
  45 /**
  46  *
  47  * Mouse up/down/move event listener
  48  *
  49  */
  50
  51 // {c83f6b81-d7ce-11d2-8360-c4c894c4917c}
  52 #define NS_IMOUSELISTENER_IID \
  53 { 0xc83f6b81, 0xd7ce, 0x11d2, { 0x83, 0x60, 0xc4, 0xc8, 0x94, 0xc4, 0x91, 0x7c } }
  54
  55 class nsIMouseListener : public nsISupports {
  56 public:
  57     NS_DECLARE_STATIC_IID_ACCESSOR(NS_IMOUSELISTENER_IID)
  58
  59     /**
  60      * Processes a mouse pressed event
  61      * @param aMouseEvent See nsGUIEvent.h
  62      * @return whether the event was consumed or ignored. See nsEventStatus
  63      */
  64     virtual nsEventStatus MousePressed(const nsGUIEvent & aMouseEvent) = 0;
  65
  66     /**
  67      * Processes a mouse release event
  68      * @param aMouseEvent See nsGUIEvent.h
  69      * @return whether the event was consumed or ignored. See nsEventStatus
  70      */
  71     virtual nsEventStatus MouseReleased(const nsGUIEvent & aMouseEvent) = 0;
  72
  73     /**
  74      * Processes a mouse clicked event
  75      * @param aMouseEvent See nsGUIEvent.h
  76      * @return whether the event was consumed or ignored. See nsEventStatus
  77      *
  78      */
  79     virtual nsEventStatus MouseClicked(const nsGUIEvent & aMouseEvent) = 0;
  80
  81     /**
  82      * Processes a mouse moved event
  83      * @param aMouseEvent See nsGUIEvent.h
  84      * @return whether the event was consumed or ignored. See nsEventStatus
  85      */
  86     virtual nsEventStatus MouseMoved(const nsGUIEvent & aMouseEvent) = 0;
  87
  88 };
  89
  90 NS_DEFINE_STATIC_IID_ACCESSOR(nsIMouseListener, NS_IMOUSELISTENER_IID)
  91
  92 #endif // nsIMouseListener_h__