Struct TextInputOptions 

pub struct TextInputOptions {
    pub content_type: TextInputContentType,
    pub return_key_type: TextInputReturnKeyType,
    pub multiline: bool,
    pub lowercase: bool,
    pub uppercase: bool,
    pub auto_capitalization: bool,
    pub is_sensitive: bool,
    pub show_suggestions: Option<bool>,
    pub locale_hints: Option<Rc<[String]>>,
}

Describes how a text input wants the input method of the platform to behave: the properties are attached to a text editing control (they are inherited) and gathered into a TextInputOptions value for the input method.

Fields

content_type: TextInputContentType

The content type (mostly for determining the shape of the virtual keyboard).

return_key_type: TextInputReturnKeyType

Determines what the Return key says and how it behaves.

multiline: bool

Text is multiline.

lowercase: bool

Text is in lower case.

uppercase: bool

Text is in upper case.

auto_capitalization: bool

Automatically capitalize letters at the start of the sentence.

is_sensitive: bool

Text contains sensitive data like card numbers and should not be stored.

show_suggestions: Option<bool>

Determines whether text suggestions are shown; None leaves the decision to the platform.

locale_hints: Option<Rc<[String]>>

Hints about the locales (BCP 47 language tags) the user is expected to type in.

Implementations

impl TextInputOptions

pub const TYPE: &'static TypeInfo = <TextInputOptions as crate::StaticType>::TYPE

The runtime type of this type.

impl TextInputOptions

pub fn from_styled_element(ferro_object: &StyledElement) -> TextInputOptions

Creates the options from the values of the attached properties of a control.

pub fn default_options() -> TextInputOptions

The default options.

pub fn content_type_property() -> &'static AttachedProperty<TextInputContentType>

Defines the ContentType attached property.

pub fn set_content_type( ferro_object: &StyledElement, value: TextInputContentType, )

Sets the value of the attached ContentType property on a control.

pub fn get_content_type(ferro_object: &StyledElement) -> TextInputContentType

Gets the value of the attached ContentType property of a control.

pub fn return_key_type_property() -> &'static AttachedProperty<TextInputReturnKeyType>

Defines the ReturnKeyType attached property.

pub fn set_return_key_type( ferro_object: &StyledElement, value: TextInputReturnKeyType, )

Sets the value of the attached ReturnKeyType property on a control.

pub fn get_return_key_type( ferro_object: &StyledElement, ) -> TextInputReturnKeyType

Gets the value of the attached ReturnKeyType property of a control.

pub fn multiline_property() -> &'static AttachedProperty<bool>

Defines the Multiline attached property.

pub fn set_multiline(ferro_object: &StyledElement, value: bool)

Sets the value of the attached Multiline property on a control.

pub fn get_multiline(ferro_object: &StyledElement) -> bool

Gets the value of the attached Multiline property of a control.

pub fn lowercase_property() -> &'static AttachedProperty<bool>

Defines the Lowercase attached property.

pub fn set_lowercase(ferro_object: &StyledElement, value: bool)

Sets the value of the attached Lowercase property on a control.

pub fn get_lowercase(ferro_object: &StyledElement) -> bool

Gets the value of the attached Lowercase property of a control.

pub fn uppercase_property() -> &'static AttachedProperty<bool>

Defines the Uppercase attached property.

pub fn set_uppercase(ferro_object: &StyledElement, value: bool)

Sets the value of the attached Uppercase property on a control.

pub fn get_uppercase(ferro_object: &StyledElement) -> bool

Gets the value of the attached Uppercase property of a control.

pub fn auto_capitalization_property() -> &'static AttachedProperty<bool>

Defines the AutoCapitalization attached property.

pub fn set_auto_capitalization(ferro_object: &StyledElement, value: bool)

Sets the value of the attached AutoCapitalization property on a control.

pub fn get_auto_capitalization(ferro_object: &StyledElement) -> bool

Gets the value of the attached AutoCapitalization property of a control.

pub fn is_sensitive_property() -> &'static AttachedProperty<bool>

Defines the IsSensitive attached property.

pub fn set_is_sensitive(ferro_object: &StyledElement, value: bool)

Sets the value of the attached IsSensitive property on a control.

pub fn get_is_sensitive(ferro_object: &StyledElement) -> bool

Gets the value of the attached IsSensitive property of a control.

pub fn show_suggestions_property() -> &'static AttachedProperty<Option<bool>>

Defines the ShowSuggestions attached property.

pub fn set_show_suggestions(ferro_object: &StyledElement, value: Option<bool>)

Sets the value of the attached ShowSuggestions property on a control.

pub fn get_show_suggestions(ferro_object: &StyledElement) -> Option<bool>

Gets the value of the attached ShowSuggestions property of a control.

pub fn locale_hints_property() -> &'static AttachedProperty<Option<Rc<[String]>>>

Defines the LocaleHints attached property.

pub fn set_locale_hints( ferro_object: &StyledElement, value: Option<Rc<[String]>>, )

Sets the value of the attached LocaleHints property on a control.

pub fn get_locale_hints(ferro_object: &StyledElement) -> Option<Rc<[String]>>

Gets the value of the attached LocaleHints property of a control.

Trait Implementations

impl Clone for TextInputOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextInputOptions

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

Formats the value using the given formatter.

impl Default for TextInputOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for TextInputOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StaticType for TextInputOptions

const TYPE: &'static TypeInfo

The runtime type.

impl StructuralPartialEq for TextInputOptions