Struct TextInputConfiguration 

pub struct TextInputConfiguration {

    pub view_id: Option<i32>,
    pub input_type: TextInputType,
    pub read_only: bool,
    pub obscure_text: bool,
    pub autocorrect: bool,
    pub smart_dashes_type: SmartDashesType,
    pub smart_quotes_type: SmartQuotesType,
    pub enable_suggestions: bool,
    pub enable_interactive_selection: bool,
    pub action_label: Option<String>,
    pub input_action: TextInputAction,
    pub text_capitalization: TextCapitalization,
    pub keyboard_appearance: Brightness,
    pub autofill_configuration: AutofillConfiguration,
    pub enable_ime_personalized_learning: bool,
    pub allowed_mime_types: Vec<String>,
    pub enable_delta_model: bool,
    pub hint_locales: Vec<Locale>,
    pub enable_inline_prediction: Option<bool>,
}

Controls the visual appearance of the text input control.

Many TextInputActions are common between Android and iOS. However, if an input_action is provided that is not supported by the current platform in debug mode, an error will be thrown when the corresponding text input is attached. For example, providing iOS’s “emergencyCall” action when running on an Android device will result in an error when in debug mode. In release mode, incompatible TextInputActions are replaced either with “unspecified” on Android, or “default” on iOS. Appropriate input_actions can be chosen by checking the current platform and then selecting the appropriate action.

See also:

• TextInput.attach
• TextInputAction

Fields

view_id: Option<i32>

The ID of the view that the text input belongs to.

input_type: TextInputType

The type of information for which to optimize the text input control.

read_only: bool

Whether the text field can be edited or not.

Defaults to false.

obscure_text: bool

Whether to hide the text being edited (e.g., for passwords).

Defaults to false.

autocorrect: bool

Whether to enable autocorrection.

Defaults to true.

smart_dashes_type: SmartDashesType

Whether to allow the platform to automatically format dashes.

smart_quotes_type: SmartQuotesType

Whether to allow the platform to automatically format quotes.

enable_suggestions: bool

Whether to show input suggestions as the user types.

Defaults to true.

enable_interactive_selection: bool

Whether a user can change its selection.

Defaults to true.

action_label: Option<String>

What text to display in the text input control’s action button.

input_action: TextInputAction

What kind of action to request for the action button on the IME.

text_capitalization: TextCapitalization

Specifies how platforms may automatically capitalize text entered by the user.

Defaults to TextCapitalization::None.

keyboard_appearance: Brightness

The appearance of the keyboard.

This setting is only honored on iOS devices.

Defaults to Brightness::Light.

autofill_configuration: AutofillConfiguration

The configuration to use for autofill.

enable_ime_personalized_learning: bool

Whether to enable that the IME update personalized data such as typing history and user dictionary data.

Defaults to true.

allowed_mime_types: Vec<String>

MIME types the field accepts for content insertion.

enable_delta_model: bool

Whether to enable that the engine sends text input updates to the framework as TextEditingDeltas or as one TextEditingValue.

Defaults to false.

hint_locales: Vec<Locale>

List of the languages that the user is expected to use.

Pass an empty list to express the intention that a specific hint should not be set.

enable_inline_prediction: Option<bool>

Whether to enable inline predictive text.

This feature is specific to iOS 17 and later. None leaves the platform default.

Implementations

impl TextInputConfiguration

pub fn new() -> TextInputConfiguration

Creates configuration information for a text input control.

pub fn view_id(self, view_id: i32) -> TextInputConfiguration

Dart TextInputConfiguration(viewId:).

pub fn input_type(self, input_type: TextInputType) -> TextInputConfiguration

Dart TextInputConfiguration(inputType:).

pub fn read_only(self, read_only: bool) -> TextInputConfiguration

Dart TextInputConfiguration(readOnly:).

pub fn obscure_text(self, obscure_text: bool) -> TextInputConfiguration

Dart TextInputConfiguration(obscureText:).

pub fn autocorrect(self, autocorrect: bool) -> TextInputConfiguration

Dart TextInputConfiguration(autocorrect:).

pub fn smart_dashes_type( self, smart_dashes_type: SmartDashesType, ) -> TextInputConfiguration

Dart TextInputConfiguration(smartDashesType:).

pub fn smart_quotes_type( self, smart_quotes_type: SmartQuotesType, ) -> TextInputConfiguration

Dart TextInputConfiguration(smartQuotesType:).

pub fn enable_suggestions( self, enable_suggestions: bool, ) -> TextInputConfiguration

Dart TextInputConfiguration(enableSuggestions:).

pub fn enable_interactive_selection( self, enable_interactive_selection: bool, ) -> TextInputConfiguration

Dart TextInputConfiguration(enableInteractiveSelection:).

pub fn action_label( self, action_label: impl Into<String>, ) -> TextInputConfiguration

Dart TextInputConfiguration(actionLabel:).

pub fn input_action( self, input_action: TextInputAction, ) -> TextInputConfiguration

Dart TextInputConfiguration(inputAction:).

pub fn keyboard_appearance( self, keyboard_appearance: Brightness, ) -> TextInputConfiguration

Dart TextInputConfiguration(keyboardAppearance:).

pub fn text_capitalization( self, text_capitalization: TextCapitalization, ) -> TextInputConfiguration

Dart TextInputConfiguration(textCapitalization:).

pub fn autofill_configuration( self, autofill_configuration: AutofillConfiguration, ) -> TextInputConfiguration

Dart TextInputConfiguration(autofillConfiguration:).

pub fn enable_ime_personalized_learning( self, enable_ime_personalized_learning: bool, ) -> TextInputConfiguration

Dart TextInputConfiguration(enableIMEPersonalizedLearning:).

pub fn allowed_mime_types( self, allowed_mime_types: Vec<String>, ) -> TextInputConfiguration

Dart TextInputConfiguration(allowedMimeTypes:).

pub fn enable_delta_model( self, enable_delta_model: bool, ) -> TextInputConfiguration

Dart TextInputConfiguration(enableDeltaModel:).

pub fn hint_locales(self, hint_locales: Vec<Locale>) -> TextInputConfiguration

Dart TextInputConfiguration(hintLocales:).

pub fn enable_inline_prediction( self, enable_inline_prediction: bool, ) -> TextInputConfiguration

Dart TextInputConfiguration(enableInlinePrediction:).

pub fn copy_with(&self) -> TextInputConfiguration

Creates a copy of this TextInputConfiguration with the given fields replaced with new values.

Trait Implementations

impl Clone for TextInputConfiguration

fn clone(&self) -> TextInputConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextInputConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TextInputConfiguration

fn default() -> TextInputConfiguration

Returns the “default value” for a type.

impl Display for TextInputConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TextInputConfiguration

fn eq(&self, other: &TextInputConfiguration) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TextInputConfiguration