1 /*
2  * Copyright (C) 2010 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef _ANDROID_VIEW_KEYEVENT_H
18 #define _ANDROID_VIEW_KEYEVENT_H
19 
20 #include <nativehelper/scoped_local_ref.h>
21 #include <utils/Errors.h>
22 #include <utils/threads.h>
23 
24 #include "jni.h"
25 
26 namespace android {
27 
28 class KeyEvent;
29 
30 /* Obtains an instance of a DVM KeyEvent object as a copy of a native KeyEvent instance.
31  * Returns NULL on error. */
32 extern ScopedLocalRef<jobject> android_view_KeyEvent_obtainAsCopy(JNIEnv* env,
33                                                                   const KeyEvent& event);
34 
35 /* Copies the contents of a DVM KeyEvent object to a native KeyEvent instance.
36  * Returns non-zero on error. */
37 extern KeyEvent android_view_KeyEvent_obtainAsCopy(JNIEnv* env, jobject eventObj);
38 
39 /* Recycles a DVM KeyEvent object.
40  * Key events should only be recycled if they are owned by the system since user
41  * code expects them to be essentially immutable, "tracking" notwithstanding.
42  * Returns non-zero on error. */
43 extern status_t android_view_KeyEvent_recycle(JNIEnv* env, jobject eventObj);
44 
45 } // namespace android
46 
47 #endif // _ANDROID_VIEW_KEYEVENT_H
48