firka/flutter
firka/flutter
4
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

IME private command docs improvement (#68630)

Browse Source 
Just a docs-only improvement in EditableText and text input.
This commit is contained in:
Justin McCandless 2020-10-27 09:22:47 -07:00 committed by GitHub
parent 3300a1bd68
commit c12d9b9c19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
packages/flutter/lib/src/services/text_input.dart
View File

@ -824,7 +824,19 @@ abstract class TextInputClient {
/// Requests that this client perform the given action. /// Requests that this client perform the given action.
void performAction(TextInputAction action); void performAction(TextInputAction action);
/// Requests that this client perform the private command. /// Request from the input method that this client perform the given private
/// command.
///
/// This can be used to provide domain-specific features that are only known
/// between certain input methods and their clients.
///
/// See also:
/// * [https://developer.android.com/reference/android/view/inputmethod/InputConnection#performPrivateCommand(java.lang.String,%20android.os.Bundle)],
/// which is the Android documentation for performPrivateCommand, used to
/// send a command from the input method.
/// * [https://developer.android.com/reference/android/view/inputmethod/InputMethodManager#sendAppPrivateCommand],
/// which is the Android documentation for sendAppPrivateCommand, used to
/// send a command to the input method.
void performPrivateCommand(String action, Map<String, dynamic> data); void performPrivateCommand(String action, Map<String, dynamic> data);
/// Updates the floating cursor position and state. /// Updates the floating cursor position and state.

16
packages/flutter/lib/src/widgets/editable_text.dart
View File

@ -1081,7 +1081,21 @@ class EditableText extends StatefulWidget {
final ValueChanged<String>? onSubmitted; final ValueChanged<String>? onSubmitted;
/// {@template flutter.widgets.editableText.onAppPrivateCommand} /// {@template flutter.widgets.editableText.onAppPrivateCommand}
/// Called when the result of an app private command is received. /// This is used to receive a private command from the input method.
///
/// Called when the result of [TextInputClient.performPrivateCommand] is
/// received.
///
/// This can be used to provide domain-specific features that are only known
/// between certain input methods and their clients.
///
/// See also:
/// * [https://developer.android.com/reference/android/view/inputmethod/InputConnection#performPrivateCommand(java.lang.String,%20android.os.Bundle)],
/// which is the Android documentation for performPrivateCommand, used to
/// send a command from the input method.
/// * [https://developer.android.com/reference/android/view/inputmethod/InputMethodManager#sendAppPrivateCommand],
/// which is the Android documentation for sendAppPrivateCommand, used to
/// send a command to the input method.
/// {@endtemplate} /// {@endtemplate}
final AppPrivateCommandCallback? onAppPrivateCommand; final AppPrivateCommandCallback? onAppPrivateCommand;