2010-12-02 09:46:21 +00:00
|
|
|
/*
|
2011-05-20 03:09:57 +00:00
|
|
|
* Copyright (C) 2010 The Android Open Source Project
|
2010-12-02 09:46:21 +00:00
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
package com.android.inputmethod.keyboard;
|
|
|
|
|
|
|
|
public interface KeyboardActionListener {
|
|
|
|
|
|
|
|
/**
|
2010-12-30 16:35:24 +00:00
|
|
|
* Called when the user presses a key. This is sent before the {@link #onCodeInput} is called.
|
|
|
|
* For keys that repeat, this is only called once.
|
2010-12-02 09:46:21 +00:00
|
|
|
*
|
2010-12-30 16:35:24 +00:00
|
|
|
* @param primaryCode the unicode of the key being pressed. If the touch is not on a valid key,
|
|
|
|
* the value will be zero.
|
2011-03-02 19:43:13 +00:00
|
|
|
* @param withSliding true if pressing has occurred because the user slid finger from other key
|
|
|
|
* to this key without releasing the finger.
|
2010-12-02 09:46:21 +00:00
|
|
|
*/
|
2011-03-02 19:43:13 +00:00
|
|
|
public void onPress(int primaryCode, boolean withSliding);
|
2010-12-02 09:46:21 +00:00
|
|
|
|
|
|
|
/**
|
2010-12-30 16:35:24 +00:00
|
|
|
* Called when the user releases a key. This is sent after the {@link #onCodeInput} is called.
|
|
|
|
* For keys that repeat, this is only called once.
|
2010-12-02 09:46:21 +00:00
|
|
|
*
|
2010-12-30 16:35:24 +00:00
|
|
|
* @param primaryCode the code of the key that was released
|
2011-03-02 19:43:13 +00:00
|
|
|
* @param withSliding true if releasing has occurred because the user slid finger from the key
|
|
|
|
* to other key without releasing the finger.
|
2010-12-02 09:46:21 +00:00
|
|
|
*/
|
2011-03-02 19:43:13 +00:00
|
|
|
public void onRelease(int primaryCode, boolean withSliding);
|
2010-12-02 09:46:21 +00:00
|
|
|
|
|
|
|
/**
|
2010-12-20 07:13:57 +00:00
|
|
|
* Send a key code to the listener.
|
2010-12-02 09:46:21 +00:00
|
|
|
*
|
2010-12-30 16:35:24 +00:00
|
|
|
* @param primaryCode this is the code of the key that was pressed
|
|
|
|
* @param keyCodes the codes for all the possible alternative keys with the primary code being
|
|
|
|
* the first. If the primary key code is a single character such as an alphabet or
|
|
|
|
* number or symbol, the alternatives will include other characters that may be on
|
|
|
|
* the same key or adjacent keys. These codes are useful to correct for accidental
|
|
|
|
* presses of a key adjacent to the intended key.
|
|
|
|
* @param x x-coordinate pixel of touched event. If {@link #onCodeInput} is not called by
|
|
|
|
* {@link PointerTracker#onTouchEvent} or so, the value should be
|
|
|
|
* {@link #NOT_A_TOUCH_COORDINATE}.
|
|
|
|
* @param y y-coordinate pixel of touched event. If {@link #onCodeInput} is not called by
|
|
|
|
* {@link PointerTracker#onTouchEvent} or so, the value should be
|
|
|
|
* {@link #NOT_A_TOUCH_COORDINATE}.
|
2010-12-02 09:46:21 +00:00
|
|
|
*/
|
2010-12-30 16:35:24 +00:00
|
|
|
public void onCodeInput(int primaryCode, int[] keyCodes, int x, int y);
|
|
|
|
|
|
|
|
public static final int NOT_A_TOUCH_COORDINATE = -1;
|
2010-12-02 09:46:21 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sends a sequence of characters to the listener.
|
|
|
|
*
|
2010-12-30 16:35:24 +00:00
|
|
|
* @param text the sequence of characters to be displayed.
|
2010-12-02 09:46:21 +00:00
|
|
|
*/
|
2010-12-30 16:35:24 +00:00
|
|
|
public void onTextInput(CharSequence text);
|
2010-12-02 09:46:21 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Called when user released a finger outside any key.
|
|
|
|
*/
|
2010-12-30 16:35:24 +00:00
|
|
|
public void onCancelInput();
|
2011-08-06 01:45:19 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Send a non-"code input" custom request to the listener.
|
|
|
|
* @return true if the request has been consumed, false otherwise.
|
|
|
|
*/
|
|
|
|
public boolean onCustomRequest(int requestCode);
|
2010-12-02 09:46:21 +00:00
|
|
|
}
|