Back to index

lightning-sunbird  0.9+nobinonly
nsINativeKeyBindings.h
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.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * IBM Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2004
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Brian Ryner <bryner@brianryner.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 #ifndef nsINativeKeyBindings_h_
00040 #define nsINativeKeyBindings_h_
00041 
00042 #include "nsISupports.h"
00043 
00044 #define NS_INATIVEKEYBINDINGS_IID \
00045 {0x606c54e7, 0x0593, 0x4750, {0x99, 0xd9, 0x4e, 0x1b, 0xcc, 0xec, 0x98, 0xd9}}
00046 
00047 #define NS_NATIVEKEYBINDINGS_CONTRACTID_PREFIX \
00048   "@mozilla.org/widget/native-key-bindings;1?type="
00049 
00050 struct nsNativeKeyEvent
00051 {
00052   PRUint32 keyCode;
00053   PRUint32 charCode;
00054   PRBool   altKey;
00055   PRBool   ctrlKey;
00056   PRBool   shiftKey;
00057   PRBool   metaKey;
00058 };
00059 
00060 class nsINativeKeyBindings : public nsISupports
00061 {
00062  public:
00063   typedef void (*DoCommandCallback)(const char *, void*);
00064 
00065   NS_DEFINE_STATIC_IID_ACCESSOR(NS_INATIVEKEYBINDINGS_IID)
00066 
00067   virtual NS_HIDDEN_(PRBool) KeyDown(const nsNativeKeyEvent& aEvent,
00068                                      DoCommandCallback aCallback,
00069                                      void *aCallbackData) = 0;
00070 
00071   virtual NS_HIDDEN_(PRBool) KeyPress(const nsNativeKeyEvent& aEvent,
00072                                       DoCommandCallback aCallback,
00073                                       void *aCallbackData) = 0;
00074 
00075   virtual NS_HIDDEN_(PRBool) KeyUp(const nsNativeKeyEvent& aEvent,
00076                                    DoCommandCallback aCallback,
00077                                    void *aCallbackData) = 0;
00078 };
00079 
00080 #endif