Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Improve KeyboardShortcutInfo documentation for Modifiers" into nyc-dev

Browse Source
This commit is contained in:
Clara Bayarri
2016-04-25 09:31:04 +00:00
committed by Android (Google) Code Review
parent 7587ba8608 77b4fda89c
commit f48f390a60
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
core/java/android/view/KeyboardShortcutInfo.java
View File

@@ -62,8 +62,9 @@ public final class KeyboardShortcutInfo implements Parcelable {
* defined in {@link KeyEvent}.
* @param modifiers The set of modifiers that, combined with the key, trigger the shortcut.
* These should be a combination of {@link KeyEvent#META_CTRL_ON},
* {@link KeyEvent#META_SHIFT_ON}, {@link KeyEvent#META_META_ON} and
* {@link KeyEvent#META_ALT_ON}.
* {@link KeyEvent#META_SHIFT_ON}, {@link KeyEvent#META_META_ON},
* {@link KeyEvent#META_ALT_ON}, {@link KeyEvent#META_FUNCTION_ON} and
* {@link KeyEvent#META_SYM_ON}.
*/
public KeyboardShortcutInfo(CharSequence label, int keycode, int modifiers) {
this(label, null, keycode, modifiers);
@@ -74,8 +75,9 @@ public final class KeyboardShortcutInfo implements Parcelable {
* @param baseCharacter The character that triggers the shortcut.
* @param modifiers The set of modifiers that, combined with the key, trigger the shortcut.
* These should be a combination of {@link KeyEvent#META_CTRL_ON},
* {@link KeyEvent#META_SHIFT_ON}, {@link KeyEvent#META_META_ON} and
* {@link KeyEvent#META_ALT_ON}.
* {@link KeyEvent#META_SHIFT_ON}, {@link KeyEvent#META_META_ON},
* {@link KeyEvent#META_ALT_ON}, {@link KeyEvent#META_FUNCTION_ON} and
* {@link KeyEvent#META_SYM_ON}.
*/
public KeyboardShortcutInfo(CharSequence label, char baseCharacter, int modifiers) {
mLabel = label;
@@ -114,7 +116,8 @@ public final class KeyboardShortcutInfo implements Parcelable {
/**
* Returns the base keycode that, combined with the modifiers, triggers this shortcut. If the
* base character was set instead, returns {@link KeyEvent#KEYCODE_UNKNOWN}.
* base character was set instead, returns {@link KeyEvent#KEYCODE_UNKNOWN}. Valid keycodes are
* defined as constants in {@link KeyEvent}.
*/
public int getKeycode() {
return mKeycode;
@@ -129,7 +132,10 @@ public final class KeyboardShortcutInfo implements Parcelable {
}
/**
* Returns the set of modifiers that, combined with the key, trigger this shortcut.
* Returns the set of modifiers that, combined with the key, trigger this shortcut. These can
* be a combination of {@link KeyEvent#META_CTRL_ON}, {@link KeyEvent#META_SHIFT_ON},
* {@link KeyEvent#META_META_ON}, {@link KeyEvent#META_ALT_ON},
* {@link KeyEvent#META_FUNCTION_ON} and {@link KeyEvent#META_SYM_ON}.
*/
public int getModifiers() {
return mModifiers;