Merge "Improve KeyboardShortcutInfo documentation for Modifiers" into nyc-dev am: f48f390
am: dea459c
* commit 'dea459c750b87b26bde8cb0ac6f843160798d943':
Improve KeyboardShortcutInfo documentation for Modifiers
Change-Id: I2bdbfc04cde9fd6d83d8e4d6f0ee2a90bb96c538
This commit is contained in:
@@ -62,8 +62,9 @@ public final class KeyboardShortcutInfo implements Parcelable {
|
|||||||
* defined in {@link KeyEvent}.
|
* defined in {@link KeyEvent}.
|
||||||
* @param modifiers The set of modifiers that, combined with the key, trigger 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},
|
* 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_SHIFT_ON}, {@link KeyEvent#META_META_ON},
|
||||||
* {@link KeyEvent#META_ALT_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) {
|
public KeyboardShortcutInfo(CharSequence label, int keycode, int modifiers) {
|
||||||
this(label, null, keycode, 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 baseCharacter The character that triggers the shortcut.
|
||||||
* @param modifiers The set of modifiers that, combined with the key, trigger 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},
|
* 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_SHIFT_ON}, {@link KeyEvent#META_META_ON},
|
||||||
* {@link KeyEvent#META_ALT_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) {
|
public KeyboardShortcutInfo(CharSequence label, char baseCharacter, int modifiers) {
|
||||||
mLabel = label;
|
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
|
* 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() {
|
public int getKeycode() {
|
||||||
return mKeycode;
|
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() {
|
public int getModifiers() {
|
||||||
return mModifiers;
|
return mModifiers;
|
||||||
|
|||||||
Reference in New Issue
Block a user