core/jni/android_view_KeyEvent.h

   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 "jni.h"
  21 #include <utils/Errors.h>
  22 #include <utils/threads.h>
  23
  24 namespace android {
  25
  26 class KeyEvent;
  27
  28 /* Obtains an instance of a DVM KeyEvent object as a copy of a native KeyEvent instance.
  29  * Returns NULL on error. */
  30 extern jobject android_view_KeyEvent_fromNative(JNIEnv* env, const KeyEvent* event);
  31
  32 /* Copies the contents of a DVM KeyEvent object to a native KeyEvent instance.
  33  * Returns non-zero on error. */
  34 extern status_t android_view_KeyEvent_toNative(JNIEnv* env, jobject eventObj,
  35         KeyEvent* event);
  36
  37 /* Recycles a DVM KeyEvent object.
  38  * Key events should only be recycled if they are owned by the system since user
  39  * code expects them to be essentially immutable, "tracking" notwithstanding.
  40  * Returns non-zero on error. */
  41 extern status_t android_view_KeyEvent_recycle(JNIEnv* env, jobject eventObj);
  42
  43 } // namespace android
  44
  45 #endif // _ANDROID_OS_KEYEVENT_H