a3477c862a
BREAKING CHANGE: Redesigned the key character map format to accomodate full keyboards with more comprehensive suite of modifiers. Old key character maps will not work anymore and must be updated. The new format is plain text only and it not compiled to a binary file (so the "kcm" tool will be removed in a subsequent check-in). Added FULL keyboard type to support full PC-style keyboards. Added SPECIAL_FUNCTION keyboard type to support special function keypads that do not have any printable keys suitable for typing and only have keys like HOME and POWER Added a special VIRTUAL_KEYBOARD device id convention that maps to a virtual keyboard with a fixed known layout. This is designed to work around issues injecting input events on devices whose built-in keyboard does not have a useful key character map (ie. when the built-in keyboard is a special function keyboard only.) Modified several places where events were being synthesized to use the virtual keyboard. Removed support for the "qwerty" default layout. The new default layout is "Generic". For the most part "qwerty" was being used as a backstop in case the built-in keyboard did not have a key character map (probably because it was a special function keypad) and the framework needed to be able to inject key events anyways. The latter issue is resolved by using the special VIRTUAL_KEYBOARD device instead of BUILT_IN_KEYBOARD. Added the concept of a key modifier behavior so that MetaKeyKeyListener can distinguish between keyboards that use chorded vs. toggled modifiers. Wrote more robust key layout and key character map parsers to enable support for new keyboard features and user installable key maps. Fixed a bug in InputReader generating key ups when keys are released out of sequence. Updated tons of documentation. Currently QwertyKeyListener is being used for full keyboards with autotext and capitalization disabled. This mostly works but causes some problems with character pickers, etc. These issues will be resolved in subsequent changes. Change-Id: Ica48f6097a551141c215bc0d2c6f7b3fb634d354
88 lines
2.4 KiB
C++
88 lines
2.4 KiB
C++
/*
|
|
* Copyright (C) 2010 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef _UI_KEYBOARD_H
|
|
#define _UI_KEYBOARD_H
|
|
|
|
#include <ui/Input.h>
|
|
#include <utils/Errors.h>
|
|
#include <utils/String8.h>
|
|
|
|
namespace android {
|
|
|
|
enum {
|
|
/* Device id of the built in keyboard. */
|
|
DEVICE_ID_BUILT_IN_KEYBOARD = 0,
|
|
|
|
/* Device id of a generic virtual keyboard with a full layout that can be used
|
|
* to synthesize key events. */
|
|
DEVICE_ID_VIRTUAL_KEYBOARD = -1,
|
|
};
|
|
|
|
struct KeyMapInfo {
|
|
String8 keyMapName;
|
|
String8 keyLayoutFile;
|
|
String8 keyCharacterMapFile;
|
|
bool isDefaultKeyMap;
|
|
|
|
KeyMapInfo() : isDefaultKeyMap(false) {
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Resolves the key map to use for a particular keyboard device.
|
|
*/
|
|
extern status_t resolveKeyMap(const String8& deviceName, KeyMapInfo& outKeyMapInfo);
|
|
|
|
/**
|
|
* Sets keyboard system properties.
|
|
*/
|
|
extern void setKeyboardProperties(int32_t deviceId, const String8& deviceName,
|
|
const KeyMapInfo& keyMapInfo);
|
|
|
|
/**
|
|
* Clears keyboard system properties.
|
|
*/
|
|
extern void clearKeyboardProperties(int32_t deviceId);
|
|
|
|
/**
|
|
* Gets the key character map filename for a device using inspecting system properties
|
|
* and then falling back on a default key character map if necessary.
|
|
* Returns a NAME_NOT_FOUND if none found.
|
|
*/
|
|
extern status_t getKeyCharacterMapFile(int32_t deviceId, String8& outKeyCharacterMapFile);
|
|
|
|
/**
|
|
* Gets a key code by its short form label, eg. "HOME".
|
|
* Returns 0 if unknown.
|
|
*/
|
|
extern int32_t getKeyCodeByLabel(const char* label);
|
|
|
|
/**
|
|
* Gets a key flag by its short form label, eg. "WAKE".
|
|
* Returns 0 if unknown.
|
|
*/
|
|
extern uint32_t getKeyFlagByLabel(const char* label);
|
|
|
|
/**
|
|
* Updates a meta state field when a key is pressed or released.
|
|
*/
|
|
extern int32_t updateMetaState(int32_t keyCode, bool down, int32_t oldMetaState);
|
|
|
|
} // namespace android
|
|
|
|
#endif // _UI_KEYBOARD_H
|