Added in API level 24

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

KeyboardShortcutInfo

Kotlin |Java

public final class KeyboardShortcutInfo
extends Object implements Parcelable

java.lang.Object
↳	android.view.KeyboardShortcutInfo

Information about a Keyboard Shortcut.

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<KeyboardShortcutInfo>`	`CREATOR`

Public constructors
`KeyboardShortcutInfo(CharSequence label, int keycode, int modifiers)`
`KeyboardShortcutInfo(CharSequence label, char baseCharacter, int modifiers)`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`char`	`getBaseCharacter()` Returns the base character that, combined with the modifiers, triggers this shortcut.
`int`	`getKeycode()` Returns the base keycode that, combined with the modifiers, triggers this shortcut.
`CharSequence`	`getLabel()` Returns the label to be used to describe this shortcut.
`int`	`getModifiers()` Returns the set of modifiers that, combined with the key, trigger this shortcut.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 24

public static final Creator<KeyboardShortcutInfo> CREATOR

Public constructors

KeyboardShortcutInfo

Added in API level 24

public KeyboardShortcutInfo (CharSequence label, 
                int keycode, 
                int modifiers)

Parameters
`label`	`CharSequence`: The label that identifies the action performed by this shortcut.
`keycode`	`int`: The keycode that triggers the shortcut. This should be a valid constant defined in `KeyEvent`.
`modifiers`	`int`: The set of modifiers that, combined with the key, trigger the shortcut. These should be a combination of `KeyEvent#META_CTRL_ON`, `KeyEvent#META_SHIFT_ON`, `KeyEvent#META_META_ON`, `KeyEvent#META_ALT_ON`, `KeyEvent#META_FUNCTION_ON` and `KeyEvent#META_SYM_ON`.

KeyboardShortcutInfo

Added in API level 24

public KeyboardShortcutInfo (CharSequence label, 
                char baseCharacter, 
                int modifiers)

Parameters
`label`	`CharSequence`: The label that identifies the action performed by this shortcut.
`baseCharacter`	`char`: The character that triggers the shortcut.
`modifiers`	`int`: The set of modifiers that, combined with the key, trigger the shortcut. These should be a combination of `KeyEvent#META_CTRL_ON`, `KeyEvent#META_SHIFT_ON`, `KeyEvent#META_META_ON`, `KeyEvent#META_ALT_ON`, `KeyEvent#META_FUNCTION_ON` and `KeyEvent#META_SYM_ON`.

Public methods

describeContents

Added in API level 24

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getBaseCharacter

Added in API level 24

public char getBaseCharacter ()

Returns the base character that, combined with the modifiers, triggers this shortcut. If the keycode was set instead, returns Character#MIN_VALUE.

Returns
`char`

getKeycode

Added in API level 24

public int getKeycode ()

Returns the base keycode that, combined with the modifiers, triggers this shortcut. If the base character was set instead, returns KeyEvent#KEYCODE_UNKNOWN. Valid keycodes are defined as constants in KeyEvent.

Returns
`int`

getLabel

Added in API level 24

public CharSequence getLabel ()

Returns the label to be used to describe this shortcut.

Returns
`CharSequence`	This value may be `null`.

getModifiers

Added in API level 24

public int getModifiers ()

Returns the set of modifiers that, combined with the key, trigger this shortcut. These can be a combination of KeyEvent#META_CTRL_ON, KeyEvent#META_SHIFT_ON, KeyEvent#META_META_ON, KeyEvent#META_ALT_ON, KeyEvent#META_FUNCTION_ON and KeyEvent#META_SYM_ON.

Returns
`int`

writeToParcel

Added in API level 24

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES