Skip to content

Commit f3e3fb0

Browse files
committed
Add documentation for TextArea
Signed-off-by: Ed Beroset <beroset@ieee.org>
1 parent f2cbad0 commit f3e3fb0

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

src/controls/qml/TextArea.qml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,46 @@
3030
import QtQuick 2.9
3131
import QtQuick.VirtualKeyboard 2.15
3232

33+
/*!
34+
\qmltype TextArea
35+
\inqmlmodule AsteroidControls
36+
37+
\brief Editable multi-line text field.
38+
39+
The TextArea provides an editable multiline area which
40+
can use a virtual keyboard to accept text. The default
41+
virtual keyboard for AsteroidOS is the \l HandWritingKeyboard
42+
which is used in this example. In this example, a simple
43+
\l TextArea is created in the upper left corner of the screen.
44+
45+
\qml
46+
import QtQuick 2.9
47+
import org.asteroid.controls 1.0
48+
49+
Item {
50+
HandWritingKeyboard {
51+
anchors.fill: parent
52+
}
53+
TextArea {
54+
width: parent.width * 0.8
55+
height: parent.height * 0.8
56+
anchors.top: parent.top
57+
}
58+
}
59+
\endqml
60+
*/
3361
TextBase {
3462
id: textArea
3563

64+
/*! Text color */
3665
property alias color: textEdit.color
66+
/*! The input text */
3767
property alias text: textEdit.text
68+
/*! The input text width */
3869
property alias textWidth: textEdit.width
70+
/*! Whether to make the field read-only */
3971
property alias readOnly: textEdit.readOnly
72+
/*! See TextInput::inputMethodHints */
4073
property alias inputMethodHints: textEdit.inputMethodHints
4174

4275
editor: textEdit

0 commit comments

Comments
 (0)