Expand description
Flutter counterpart: packages/flutter/lib/src/services.
Only the application exit of ServicesBinding, the hardware keyboard, haptic feedback, the mouse cursor, the mouse tracking
annotation, state restoration, the application switcher description, the system overlay
style, TextInput / TextInputConnection / TextInputClient / TextSelectionDelegate,
text layout metric statics, the clipboard, text input formatters, SelectionChangedCause,
autofill (AutofillHints / AutofillClient / AutofillScope), keyboard-inserted
content, spell check, live text, process text, UndoManager / UndoManagerClient,
SystemContextMenuController, and re-exports of the text-input value types are here. Platform channels, the raw
keyboard, and the rest of system chrome wait.
Structs§
- AnyAutofill
Client - Erased
AutofillClient: one identity and a static vtable. - AnyText
Input Client - Erased
TextInputClient: one identity and a static vtable. - AnyText
Selection Delegate - Erased
TextSelectionDelegate: one identity and a static vtable. - AnyUndo
Manager Client - Erased
UndoManagerClient: one identity and a static vtable. - Autofill
Configuration - A collection of autofill related information that represents an
AutofillClient. - Autofill
Hints - A collection of commonly used autofill hint strings on different platforms.
- Character
Boundary - A
TextBoundarysubclass for retrieving the range of the grapheme the givenpositionis in. - Clipboard
- Utility methods for interacting with the system’s clipboard.
- Clipboard
Data - Data stored on the system clipboard.
- Default
Process Text Service - The service used by default for the text processing feature.
- Default
Spell Check Service - The service used by default to fetch spell check results for text input.
- Deferring
Mouse Cursor - The cursor behind
MouseCursor.defer. Every instance is equal. - Document
Boundary - A text boundary that uses the entire document as logical boundary.
- Filtering
Text Input Formatter - A
TextInputFormatterthat prevents the insertion of characters matching (or not matching) a particular pattern, by replacing the characters with the givenreplacement_string. - Haptic
Feedback - Allows access to the haptic feedback interface on the device.
- Hardware
Keyboard - Manages key events from hardware keyboards.
- KeyDown
Event - An event indicating that the user has pressed a key down on the keyboard.
- KeyEvent
Manager - A singleton class that processes key messages from the platform and dispatches converted messages accordingly.
- KeyRepeat
Event - An event indicating that the user has been holding a key on the keyboard and causing repeated events.
- KeyUp
Event - An event indicating that the user has released a key on the keyboard.
- Keyboard
Inserted Content - A class representing rich content (such as a PNG image) inserted via the system input method.
- Length
Limiting Text Input Formatter - A
TextInputFormatterthat prevents the insertion of more characters than allowed. - Live
Text - Utility methods for interacting with the system’s Live Text.
- Logical
Keyboard Key - A type with constants that describe the keys that are returned from
RawKeyEvent.logicalKey. - Mouse
Cursor Manager - Maintains the state of mouse cursors and manages how cursors are searched for.
- Mouse
Tracker Annotation - The annotation object used to annotate regions that are interested in mouse movements.
- Noop
Mouse Cursor - The cursor behind
MouseCursor.uncontrolled. Every instance is equal. - Paragraph
Boundary - A text boundary that uses paragraphs as logical boundaries.
- Physical
Keyboard Key - A type with constants that describe the keys that are returned from
RawKeyEvent.physicalKey. - Process
Text Action - A data structure describing text processing actions.
- RawFloating
Cursor Point - The current state and position of the floating cursor.
- Restoration
Bucket - A
RestorationBucketholds pieces of the restoration data that a part of the application needs to restore its state. - Restoration
Manager - Manages the restoration data in the framework and synchronizes it with the host.
- Restoration
Update - What the host answers when the framework asks for the restoration data it stored.
- Selection
Rect - Represents a selection rect for a character and it’s position in the text.
- Services
Binding - Hands the host’s lifecycle messages to the scheduler and the layers above, answers the host’s requests to exit the application, and asks the host to exit it.
- Spell
Check Results - A data structure grouping together the
SuggestionSpans and related text of results returned by a spell checker. - Suggestion
Span - A data structure representing a range of misspelled text and the suggested replacements for this range.
- System
Chrome - Controls specific aspects of the operating system’s graphical interface and how it interacts with the application.
- System
Context Menu Controller - Allows access to the system context menu.
- System
Mouse Cursor - A mouse cursor that is natively supported on the platform that the application is running on.
- System
Mouse Cursors - A collection of system
MouseCursors. - Text
Editing Value - The current text, selection, and composing state for editing a run of text.
- Text
Input - An low-level interface to the system’s text input control.
- Text
Input Configuration - Controls the visual appearance of the text input control.
- Text
Input Connection - An interface for interacting with a text input control.
- Text
Input Formatter Ref - A shared
TextInputFormatter. - Text
Input Style - Text styling information for the current input client.
- Text
Input Type - The type of information for which to optimize the text input control.
- Text
Layout Metrics - Static classifiers from Flutter’s
TextLayoutMetrics. - Text
Selection - A range of text that represents a selection.
- Undo
Manager - A low-level interface to the system’s undo manager.
Enums§
- Filter
Pattern - A pattern
FilteringTextInputFormattermatches against incoming text. - Floating
Cursor Drag State - The state of a “floating cursor” drag on an iOS soft keyboard.
- IOSSystem
Context Menu Item Data - Describes a context menu button that will be rendered in the system context menu.
- KeyEvent
- Defines the interface for keyboard key events.
- Keyboard
Lock Mode - Represents a lock mode of a keyboard, such as
KeyboardLockMode::CapsLock. - MaxLength
Enforcement - Mechanisms for enforcing maximum length limits.
- Restoration
Data - One value in the restoration data, of the kinds
StandardMessageCodeccan carry. - Selection
Changed Cause - Indicates what triggered the change in selected text (including changes to the cursor location).
- Smart
Dashes Type - Indicates how to handle the intelligent replacement of dashes in text input.
- Smart
Quotes Type - Indicates how to handle the intelligent replacement of quotes in text input.
- System
UiOverlay - Specifies a set of mutually exclusive system UI overlays.
- Text
Capitalization - Configures how the platform keyboard will select an uppercase or lowercase keyboard.
- Text
Input Action - An action the user has requested the text input control to perform.
- Undo
Direction - The direction in which an undo action should be performed, whether undo or redo.
Traits§
- Autofill
Client - An object that represents an autofillable input field in the autofill workflow.
- Autofill
Scope - An ordered group within which
AutofillClients are logically connected. - Autofill
Scope Mixin - A partial implementation of
AutofillScope. - Keyboard
Key - A base class for all keyboard key types.
- Mouse
Cursor - An interface for mouse cursor definitions.
- Mouse
Cursor Session - Manages the duration that a pointing device should display a specific mouse cursor.
- Process
Text Service - Determines how to interact with the text processing feature.
- Services
Binding Overrides - What the binding above this one overrides; kept erased.
- Services
Binding Overrides Object - The object side of Flutter’s
WidgetsBindingoverride ofServicesBinding.handleRequestAppExit, which asks the widget layer’s observers. Implement it on the binding above and registerRc::new(handle)withServicesBinding::set_overrides;Handle<T>is thenServicesBindingOverrides. - Spell
Check Service - Determines how spell check results are received for text input.
- Text
Boundary - An interface for retrieving the logical text boundary (as opposed to the visual boundary) at a given code unit offset in a document.
- Text
Input Client - An interface to receive information from
TextInput. - Text
Input Formatter - A
TextInputFormattercan be optionally injected into anEditableTextto provide as-you-type validation and formatting of the text being edited. - Text
Selection Delegate - An interface for manipulating the selection, to be used by the implementor of the toolbar widget.
- Undo
Manager Client - An interface to receive events from a native UndoManager.
Type Aliases§
- KeyEvent
Callback - The signature for
HardwareKeyboard::add_handler, a callback to decide whether the entire framework handles a key event. - Mouse
Cursor Ref - A shared reference to an immutable
MouseCursor(a Dart object reference). - Restoration
Map - Flutter’s
Map<Object?, Object?>of restoration data: insertion-ordered, keyed by value. - Text
Input Format Function - Function signature expected for creating custom
TextInputFormattershorthands viaTextInputFormatterRef::with_function. - Until
Predicate - Signature for a predicate that takes an offset into a UTF-16 string, and a boolean that indicates the search direction.