widget/public/nsINativeKeyBindings.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.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * IBM Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Brian Ryner <bryner@brianryner.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 #ifndef nsINativeKeyBindings_h_
  40 #define nsINativeKeyBindings_h_
  41
  42 #include "nsISupports.h"
  43 #include "nsEvent.h"
  44
  45 #define NS_INATIVEKEYBINDINGS_IID \
  46 {0x606c54e7, 0x0593, 0x4750, {0x99, 0xd9, 0x4e, 0x1b, 0xcc, 0xec, 0x98, 0xd9}}
  47
  48 #define NS_NATIVEKEYBINDINGS_CONTRACTID_PREFIX \
  49   "@mozilla.org/widget/native-key-bindings;1?type="
  50
  51 struct nsNativeKeyEvent
  52 {
  53   nsEvent *nativeEvent; // see bug 406407 to see how this is used
  54   PRUint32 keyCode;
  55   PRUint32 charCode;
  56   PRBool   altKey;
  57   PRBool   ctrlKey;
  58   PRBool   shiftKey;
  59   PRBool   metaKey;
  60 };
  61
  62 class nsINativeKeyBindings : public nsISupports
  63 {
  64  public:
  65   typedef void (*DoCommandCallback)(const char *, void*);
  66
  67   NS_DECLARE_STATIC_IID_ACCESSOR(NS_INATIVEKEYBINDINGS_IID)
  68
  69   virtual NS_HIDDEN_(PRBool) KeyDown(const nsNativeKeyEvent& aEvent,
  70                                      DoCommandCallback aCallback,
  71                                      void *aCallbackData) = 0;
  72
  73   virtual NS_HIDDEN_(PRBool) KeyPress(const nsNativeKeyEvent& aEvent,
  74                                       DoCommandCallback aCallback,
  75                                       void *aCallbackData) = 0;
  76
  77   virtual NS_HIDDEN_(PRBool) KeyUp(const nsNativeKeyEvent& aEvent,
  78                                    DoCommandCallback aCallback,
  79                                    void *aCallbackData) = 0;
  80 };
  81
  82 NS_DEFINE_STATIC_IID_ACCESSOR(nsINativeKeyBindings, NS_INATIVEKEYBINDINGS_IID)
  83
  84 #endif