TextInput QML Type

  • Import Statement: import QtQuick 2.13

  • Inherited By:: TextField

  • Inherits: Item

  • Group: TextInput is part of qtquick-visual, qtquick-input

Detailed Description

The TextInput type displays a single line of editable plain text.

TextInput is used to accept a line of text input. Input constraints can be placed on a TextInput item (for example, through a validator or inputMask), and setting echoMode to an appropriate value enables TextInput to be used for a password input field.

On macOS, the Up/Down key bindings for Home/End are explicitly disabled. If you want such bindings (on any platform), you will need to construct them in QML.

See Also

See also TextEdit, Text

Property Documentation

 

effectiveHorizontalAlignment : enumeration

horizontalAlignment : enumeration

verticalAlignment : enumeration

Sets the horizontal alignment of the text within the TextInput item's width and height. By default, the text alignment follows the natural alignment of the text, for example text that is read from left to right will be aligned to the left.

TextInput does not have vertical alignment, as the natural height is exactly the height of the single line of text. If you set the height manually to something larger, TextInput will always be top aligned vertically. You can use anchors to align it however you want within another item.

The valid values for horizontalAlignment are TextInput.AlignLeft, TextInput.AlignRight and TextInput.AlignHCenter.

Valid values for verticalAlignment are TextInput.AlignTop (default), TextInput.AlignBottom TextInput.AlignVCenter.

When using the attached property LayoutMirroring::enabled to mirror application layouts, the horizontal alignment of text will also be mirrored. However, the property horizontalAlignment will remain unchanged. To query the effective horizontal alignment of TextInput, use the read-only property effectiveHorizontalAlignment.

[since 5.6] bottomPadding : real

[since 5.6] leftPadding : real

[since 5.6] padding : real

[since 5.6] rightPadding : real

[since 5.6] topPadding : real

These properties hold the padding around the content. This space is reserved in addition to the contentWidth and contentHeight.

This QML property was introduced in Qt 5.6.

acceptableInput : bool

This property is always true unless a validator or input mask has been set. If a validator or input mask has been set, this property will only be true if the current text is acceptable to the validator or input mask as a final string (not as an intermediate string).

activeFocusOnPress : bool

Whether the TextInput should gain active focus on a mouse press. By default this is set to true.

autoScroll : bool

Whether the TextInput should scroll when the text is longer than the width. By default this is set to true.

See Also

See also ensureVisible()

canPaste : bool

Returns true if the TextInput is writable and the content of the clipboard is suitable for pasting into the TextInput.

canRedo : bool

Returns true if the TextInput is writable and there are undone operations that can be redone.

canUndo : bool

Returns true if the TextInput is writable and there are previous operations that can be undone.

color : color

The text color.

contentHeight : real

Returns the height of the text, including the height past the height that is covered if the text does not fit within the set height.

contentWidth : real

Returns the width of the text, including the width past the width which is covered due to insufficient wrapping if wrapMode is set.

cursorDelegate : Component

The delegate for the cursor in the TextInput.

If you set a cursorDelegate for a TextInput, this delegate will be used for drawing the cursor instead of the standard cursor. An instance of the delegate will be created and managed by the TextInput when a cursor is needed, and the x property of the delegate instance will be set so as to be one pixel before the top left of the current character.

Note that the root item of the delegate component must be a QQuickItem or QQuickItem derived item.

cursorPosition : int

The position of the cursor in the TextInput.

cursorRectangle : rectangle

The rectangle where the standard text cursor is rendered within the text input. Read only.

The position and height of a custom cursorDelegate are updated to follow the cursorRectangle automatically when it changes. The width of the delegate is unaffected by changes in the cursor rectangle.

cursorVisible : bool

Set to true when the TextInput shows a cursor.

This property is set and unset when the TextInput gets active focus, so that other properties can be bound to whether the cursor is currently showing. As it gets set and unset automatically, when you set the value yourself you must keep in mind that your value may be overwritten.

It can be set directly in script, for example if a KeyProxy might forward keys to it and you desire it to look active when this happens (but without actually giving it active focus).

It should not be set directly on the item, like in the below QML, as the specified value will be overridden and lost on focus changes.

 
Sélectionnez
TextInput {
    text: "Text"
    cursorVisible: false
}

In the above snippet the cursor will still become visible when the TextInput gains active focus.

[read-only] displayText : string

This is the text displayed in the TextInput.

If echoMode is set to TextInput::Normal, this holds the same value as the TextInput::text property. Otherwise, this property holds the text visible to the user, while the text property holds the actual entered text.

Unlike the TextInput::text property, this contains partial text input from an input method.

See Also

See also preeditText

echoMode : enumeration

Specifies how the text should be displayed in the TextInput.

  • TextInput.Normal - Displays the text as it is. (Default)

  • TextInput.Password - Displays platform-dependent password mask characters instead of the actual characters.

  • TextInput.NoEcho - Displays nothing.

  • TextInput.PasswordEchoOnEdit - Displays characters as they are entered while editing, otherwise identical to TextInput.Password.

font.bold : bool

Sets whether the font weight is bold.

font.capitalization : enumeration

Sets the capitalization for the text.

  • Font.MixedCase - This is the normal text rendering option where no capitalization change is applied.

  • Font.AllUppercase - This alters the text to be rendered in all uppercase type.

  • Font.AllLowercase - This alters the text to be rendered in all lowercase type.

  • Font.SmallCaps - This alters the text to be rendered in small-caps type.

  • Font.Capitalize - This alters the text to be rendered with the first character of each word as an uppercase character.

 
Sélectionnez
TextInput { text: "Hello"; font.capitalization: Font.AllLowercase }

font.family : string

Sets the family name of the font.

The family name is case insensitive and may optionally include a foundry name, e.g. "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm.

[since 5.8] font.hintingPreference : enumeration

Sets the preferred hinting on the text. This is a hint to the underlying text rendering system to use a certain level of hinting, and has varying support across platforms. See the table in the documentation for QFont::HintingPreference for more details.

This property only has an effect when used together with render type TextInput.NativeRendering.

Font.PreferDefaultHinting - Use the default hinting level for the target platform.

Font.PreferNoHinting - If possible, render text without hinting the outlines of the glyphs. The text layout will be typographically accurate, using the same metrics as are used e.g. when printing.

Font.PreferVerticalHinting - If possible, render text with no horizontal hinting, but align glyphs to the pixel grid in the vertical direction. The text will appear crisper on displays where the density is too low to give an accurate rendering of the glyphs. But since the horizontal metrics of the glyphs are unhinted, the text's layout will be scalable to higher density devices (such as printers) without impacting details such as line breaks.

Font.PreferFullHinting - If possible, render text with hinting in both horizontal and vertical directions. The text will be altered to optimize legibility on the target device, but since the metrics will depend on the target size of the text, the positions of glyphs, line breaks, and other typographical detail will not scale, meaning that a text layout may look different on devices with different pixel densities.

 
Sélectionnez
TextInput { text: "Hello"; renderType: TextInput.NativeRendering; font.hintingPreference: Font.PreferVerticalHinting }

This property was introduced in Qt 5.8.

font.italic : bool

Sets whether the font has an italic style.

[since 5.10] font.kerning : bool

Enables or disables the kerning OpenType feature when shaping the text. Disabling this may improve performance when creating or changing the text, at the expense of some cosmetic features. The default value is true.

 
Sélectionnez
TextInput { text: "OATS FLAVOUR WAY"; font.kerning: false }

This property was introduced in Qt 5.10.

font.letterSpacing : real

Sets the letter spacing for the font.

Letter spacing changes the default spacing between individual letters in the font. A positive value increases the letter spacing by the corresponding pixels; a negative value decreases the spacing.

font.pixelSize : int

Sets the font size in pixels.

Using this function makes the font device dependent. Use pointSize to set the size of the font in a device independent manner.

font.pointSize : real

Sets the font size in points. The point size must be greater than zero.

[since 5.10] font.preferShaping : bool

Sometimes, a font will apply complex rules to a set of characters in order to display them correctly. In some writing systems, such as Brahmic scripts, this is required in order for the text to be legible, but in e.g. Latin script, it is merely a cosmetic feature. Setting the preferShaping property to false will disable all such features when they are not required, which will improve performance in most cases.

The default value is true.

 
Sélectionnez
TextInput { text: "Some text"; font.preferShaping: false }

This property was introduced in Qt 5.10.

font.strikeout : bool

Sets whether the font has a strikeout style.

[since 5.6] font.styleName : string

Sets the style name of the font.

The style name is case insensitive. If set, the font will be matched against style name instead of the font properties font.weight, font.bold and font.italic.

This property was introduced in Qt 5.6.

font.underline : bool

Sets whether the text is underlined.

font.weight : enumeration

Sets the font's weight.

The weight can be one of:

  • Font.Thin

  • Font.Light

  • Font.ExtraLight

  • Font.Normal - the default

  • Font.Medium

  • Font.DemiBold

  • Font.Bold

  • Font.ExtraBold

  • Font.Black

 
Sélectionnez
TextInput { text: "Hello"; font.weight: Font.DemiBold }

font.wordSpacing : real

Sets the word spacing for the font.

Word spacing changes the default spacing between individual words. A positive value increases the word spacing by a corresponding amount of pixels, while a negative value decreases the inter-word spacing accordingly.

inputMask : string

Allows you to set an input mask on the TextInput, restricting the allowable text inputs. See QLineEdit::inputMask for further details, as the exact same mask strings are used by TextInput.

See Also

inputMethodComposing : bool

This property holds whether the TextInput has partial text input from an input method.

While it is composing an input method may rely on mouse or key events from the TextInput to edit or commit the partial text. This property can be used to determine when to disable events handlers that may interfere with the correct operation of an input method.

inputMethodHints : enumeration

Provides hints to the input method about the expected content of the text input and how it should operate.

The value is a bit-wise combination of flags, or Qt.ImhNone if no hints are set.

Flags that alter behaviour are:

  • Qt.ImhHiddenText - Characters should be hidden, as is typically used when entering passwords. This is automatically set when setting echoMode to TextInput.Password.

  • Qt.ImhSensitiveData - Typed text should not be stored by the active input method in any persistent storage like predictive user dictionary.

  • Qt.ImhNoAutoUppercase - The input method should not try to automatically switch to upper case when a sentence ends.

  • Qt.ImhPreferNumbers - Numbers are preferred (but not required).

  • Qt.ImhPreferUppercase - Upper case letters are preferred (but not required).

  • Qt.ImhPreferLowercase - Lower case letters are preferred (but not required).

  • Qt.ImhNoPredictiveText - Do not use predictive text (i.e. dictionary lookup) while typing.

  • Qt.ImhDate - The text editor functions as a date field.

  • Qt.ImhTime - The text editor functions as a time field.

  • Qt.ImhMultiLine - The text editor doesn't close software input keyboard when Return or Enter key is pressed (since QtQuick 2.4).

Flags that restrict input (exclusive flags) are:

  • Qt.ImhDigitsOnly - Only digits are allowed.

  • Qt.ImhFormattedNumbersOnly - Only number input is allowed. This includes decimal point and minus sign.

  • Qt.ImhUppercaseOnly - Only upper case letter input is allowed.

  • Qt.ImhLowercaseOnly - Only lower case letter input is allowed.

  • Qt.ImhDialableCharactersOnly - Only characters suitable for phone dialing are allowed.

  • Qt.ImhEmailCharactersOnly - Only characters suitable for email addresses are allowed.

  • Qt.ImhUrlCharactersOnly - Only characters suitable for URLs are allowed.

Masks:

  • Qt.ImhExclusiveInputMask - This mask yields nonzero if any of the exclusive flags are used.

length : int

Returns the total number of characters in the TextInput item.

If the TextInput has an inputMask the length will include mask characters and may differ from the length of the string returned by the text property.

This property can be faster than querying the length the text property as it doesn't require any copying or conversion of the TextInput's internal string data.

maximumLength : int

The maximum permitted length of the text in the TextInput.

If the text is too long, it is truncated at the limit.

By default, this property contains a value of 32767.

mouseSelectionMode : enumeration

Specifies how text should be selected using a mouse.

  • TextInput.SelectCharacters - The selection is updated with individual characters. (Default)

  • TextInput.SelectWords - The selection is updated with whole words.

This property only applies when