TextArea QML Type
Multi-line text input area. More...
Import Statement: | import QtQuick.Controls 2.5 |
Since: | Qt 5.7 |
Inherits: |
Properties
- background : Item
- bottomInset : real
- focusReason : enumeration
- hoverEnabled : bool
- hovered : bool
- implicitBackgroundHeight : real
- implicitBackgroundWidth : real
- leftInset : real
- palette : palette
- placeholderText : string
- placeholderTextColor : color
- rightInset : real
- topInset : real
Attached Properties
- flickable : TextArea
Signals
- pressAndHold(MouseEvent event)
- pressed(MouseEvent event)
- released(MouseEvent event)
Detailed Description
TextArea is a multi-line text editor. TextArea extends TextEdit with a placeholder text functionality, and adds decoration.
TextArea {
placeholderText: qsTr("Enter description")
}
TextArea is not scrollable by itself. Especially on screen-size constrained platforms, it is often preferable to make entire application pages scrollable. On such a scrollable page, a non-scrollable TextArea might behave better than nested scrollable controls. Notice, however, that in such a scenario, the background decoration of the TextArea scrolls together with the rest of the scrollable content.
Scrollable TextArea
If you want to make a TextArea scrollable, for example, when it covers an entire application page, it can be placed inside a ScrollView.
ScrollView { id: view anchors.fill: parent TextArea { text: "TextArea\n...\n...\n...\n...\n...\n...\n" } }
A TextArea that is placed inside a ScrollView does the following:
- Sets the content size automatically
- Ensures that the background decoration stays in place
- Clips the content
Tab Focus
By default, pressing the tab key while TextArea has active focus results in a tab character being input into the control itself. To make tab pass active focus onto another item, use the attached KeyNavigation properties:
TextField { id: textField } TextArea { KeyNavigation.priority: KeyNavigation.BeforeItem KeyNavigation.tab: textField }
See also TextField, Customizing TextArea, and Input Controls.
Property Documentation
background : Item |
This property holds the background item.
Note: If the background item has no explicit size specified, it automatically follows the control's size. In most cases, there is no need to specify width or height for a background item.
Note: Most controls use the implicit size of the background item to calculate the implicit size of the control itself. If you replace the background item with a custom one, you should also consider providing a sensible implicit size for it (unless it is an item like Image which has its own implicit size).
See also Customizing TextArea.
bottomInset : real |
This property holds the bottom inset for the background.
This property was introduced in QtQuick.Controls 2.5 (Qt 5.12).
See also Control Layout and topInset.
focusReason : enumeration |
This property holds the reason of the last focus change.
Note: This property does not indicate whether the control has active focus, but the reason why the control either gained or lost focus.
Constant | Description |
---|---|
Qt.MouseFocusReason | A mouse action occurred. |
Qt.TabFocusReason | The Tab key was pressed. |
Qt.BacktabFocusReason | A Backtab occurred. The input for this may include the Shift or Control keys; e.g. Shift+Tab. |
Qt.ActiveWindowFocusReason | The window system made this window either active or inactive. |
Qt.PopupFocusReason | The application opened/closed a pop-up that grabbed/released the keyboard focus. |
Qt.ShortcutFocusReason | The user typed a label's buddy shortcut |
Qt.MenuBarFocusReason | The menu bar took focus. |
Qt.OtherFocusReason | Another reason, usually application-specific. |
See also Item::activeFocus.
hoverEnabled : bool |
This property determines whether the text area accepts hover events. The default value is true
.
This property was introduced in QtQuick.Controls 2.1 (Qt 5.8).
See also hovered.
[read-only] hovered : bool |
This property holds whether the text area is hovered.
This property was introduced in QtQuick.Controls 2.1 (Qt 5.8).
See also hoverEnabled.
[read-only] implicitBackgroundHeight : real |
This property holds the implicit background height.
The value is equal to background ? background.implicitHeight : 0
.
This property was introduced in QtQuick.Controls 2.5 (Qt 5.12).
See also implicitBackgroundWidth.
[read-only] implicitBackgroundWidth : real |
This property holds the implicit background width.
The value is equal to background ? background.implicitWidth : 0
.
This property was introduced in QtQuick.Controls 2.5 (Qt 5.12).
See also implicitBackgroundHeight.
leftInset : real |
This property holds the left inset for the background.
This property was introduced in QtQuick.Controls 2.5 (Qt 5.12).
See also Control Layout and rightInset.
palette : palette |
This property holds the palette currently set for the text area.
This property was introduced in QtQuick.Controls 2.3 (Qt 5.10).
See also Control::palette.
placeholderText : string |
This property holds the short hint that is displayed in the text area before the user enters a value.
placeholderTextColor : color |
This property holds the color of placeholderText.
This property was introduced in QtQuick.Controls 2.5 (Qt 5.12).
See also placeholderText.
rightInset : real |
This property holds the right inset for the background.
This property was introduced in QtQuick.Controls 2.5 (Qt 5.12).
See also Control Layout and leftInset.
topInset : real |
This property holds the top inset for the background.
This property was introduced in QtQuick.Controls 2.5 (Qt 5.12).
See also Control Layout and bottomInset.
Attached Property Documentation
TextArea.flickable : TextArea |
This property attaches a text area to a Flickable.
See also ScrollBar, ScrollIndicator, and Scrollable TextArea.
Signal Documentation
pressAndHold(MouseEvent event) |
pressed(MouseEvent event) |
This signal is emitted when the text area is pressed by the user. The event parameter provides information about the press, including the x and y position of the press, and which button is pressed.
This signal was introduced in QtQuick.Controls 2.1 (Qt 5.8).
See also released and pressAndHold.
released(MouseEvent event) |
This signal is emitted when the text area is released by the user. The event parameter provides information about the release, including the x and y position of the press, and which button is pressed.
This signal was introduced in QtQuick.Controls 2.1 (Qt 5.8).
See also pressed and pressAndHold.
© 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.