This file is indexed.

/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-textarea.html is in qtquickcontrols2-5-doc-html 5.9.5-0ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquicktextarea.cpp -->
  <title>TextArea QML Type | Qt Quick Controls 2 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtquickcontrols2-index.html">Qt Quick Controls 2</a></td><td ><a href="qtquick-controls2-qmlmodule.html">QML Types</a></td><td >TextArea QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#attached-properties">Attached Properties</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#scrollable-textarea">Scrollable TextArea</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">TextArea QML Type</h1>
<span class="subtitle"></span>
<!-- $$$TextArea-brief -->
<p>Multi-line text input area. <a href="#details">More...</a></p>
<!-- @@@TextArea -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls 2.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="../qtquick/qml-qtquick-textedit.html">TextEdit</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-textarea-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls2-textarea.html#background-prop">background</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-textarea.html#focusReason-prop">focusReason</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-textarea.html#hoverEnabled-prop">hoverEnabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-textarea.html#hovered-prop">hovered</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-textarea.html#placeholderText-prop">placeholderText</a></b></b> : string</li>
</ul>
<a name="attached-properties"></a>
<h2 id="attached-properties">Attached Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls2-textarea.html#flickable-attached-prop">flickable</a></b></b> : TextArea</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-textarea.html#pressAndHold-signal">pressAndHold</a></b></b>(MouseEvent <i>event</i>)</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-textarea.html#pressed-signal">pressed</a></b></b>(MouseEvent <i>event</i>)</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-textarea.html#released-signal">released</a></b></b>(MouseEvent <i>event</i>)</li>
</ul>
<!-- $$$TextArea-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtquick-controls2-textarea.html">TextArea</a> is a multi-line text editor. <a href="qml-qtquick-controls2-textarea.html">TextArea</a> extends <a href="../qtquick/qml-qtquick-textedit.html">TextEdit</a> with a <a href="qml-qtquick-controls2-textarea.html#placeholderText-prop">placeholder text</a> functionality, and adds decoration.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-textarea.png" alt="" /></p><pre class="cpp">

  TextArea {
      placeholderText: qsTr(<span class="string">&quot;Enter description&quot;</span>)
  }

</pre>
<p><a href="qml-qtquick-controls2-textarea.html">TextArea</a> 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 <a href="qml-qtquick-controls2-textarea.html">TextArea</a> might behave better than nested scrollable controls. Notice, however, that in such a scenario, the background decoration of the <a href="qml-qtquick-controls2-textarea.html">TextArea</a> scrolls together with the rest of the scrollable content.</p>
<a name="scrollable-textarea"></a>
<h3 >Scrollable TextArea</h3>
<p>If you want to make a <a href="qml-qtquick-controls2-textarea.html">TextArea</a> scrollable, for example, when it covers an entire application page, it can be placed inside a <a href="qml-qtquick-controls2-scrollview.html">ScrollView</a>.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-textarea-scrollable.png" alt="" /></p><pre class="qml">

  <span class="type"><a href="qml-qtquick-controls2-scrollview.html">ScrollView</a></span> {
      <span class="name">id</span>: <span class="name">view</span>
      <span class="name">anchors</span>.fill: <span class="name">parent</span>

      <span class="type"><a href="qml-qtquick-controls2-textarea.html">TextArea</a></span> {
          <span class="name">text</span>: <span class="string">&quot;TextArea\n...\n...\n...\n...\n...\n...\n&quot;</span>
      }
  }

</pre>
<p>A <a href="qml-qtquick-controls2-textarea.html">TextArea</a> that is placed inside a <a href="qml-qtquick-controls2-scrollview.html">ScrollView</a> does the following:</p>
<ul>
<li>Sets the content size automatically</li>
<li>Ensures that the background decoration stays in place</li>
<li>Clips the content</li>
</ul>
<p><b>See also </b><a href="qml-qtquick-controls2-textfield.html">TextField</a>, <a href="qtquickcontrols2-customize.html#customizing-textarea">Customizing TextArea</a>, and <a href="qtquickcontrols2-input.html">Input Controls</a>.</p>
<!-- @@@TextArea -->
<h2>Property Documentation</h2>
<!-- $$$background -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="background-prop">
<td class="tblQmlPropNode"><p>
<a name="background-prop"></a><span class="name">background</span> : <span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the background item.</p>
<p><b>Note: </b>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.</p><p><b>Note: </b>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 <a href="../qtquick/qtquick-imageelements-example.html#image">Image</a> which has its own implicit size).</p><p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-textarea">Customizing TextArea</a>.</p>
</div></div><!-- @@@background -->
<br/>
<!-- $$$focusReason -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="focusReason-prop">
<td class="tblQmlPropNode"><p>
<a name="focusReason-prop"></a><span class="name">focusReason</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the reason of the last focus change.</p>
<p><b>Note: </b>This property does not indicate whether the control has <a href="../qtquick/qml-qtquick-item.html#activeFocus-prop">active focus</a>, but the reason why the control either gained or lost focus.</p><div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Qt.MouseFocusReason</code></td><td class="topAlign">A mouse action occurred.</td></tr>
<tr><td class="topAlign"><code>Qt.TabFocusReason</code></td><td class="topAlign">The Tab key was pressed.</td></tr>
<tr><td class="topAlign"><code>Qt.BacktabFocusReason</code></td><td class="topAlign">A Backtab occurred. The input for this may include the Shift or Control keys; e.g&#x2e; Shift+Tab.</td></tr>
<tr><td class="topAlign"><code>Qt.ActiveWindowFocusReason</code></td><td class="topAlign">The window system made this window either active or inactive.</td></tr>
<tr><td class="topAlign"><code>Qt.PopupFocusReason</code></td><td class="topAlign">The application opened/closed a pop-up that grabbed/released the keyboard focus.</td></tr>
<tr><td class="topAlign"><code>Qt.ShortcutFocusReason</code></td><td class="topAlign">The user typed a label's buddy shortcut</td></tr>
<tr><td class="topAlign"><code>Qt.MenuBarFocusReason</code></td><td class="topAlign">The menu bar took focus.</td></tr>
<tr><td class="topAlign"><code>Qt.OtherFocusReason</code></td><td class="topAlign">Another reason, usually application-specific.</td></tr>
</table></div>
<p><b>See also </b><a href="../qtquick/qml-qtquick-item.html#activeFocus-prop">Item::activeFocus</a>.</p>
</div></div><!-- @@@focusReason -->
<br/>
<!-- $$$hoverEnabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="hoverEnabled-prop">
<td class="tblQmlPropNode"><p>
<a name="hoverEnabled-prop"></a><span class="name">hoverEnabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property determines whether the text area accepts hover events. The default value is <code>true</code>.</p>
<p>This QML property was introduced in  QtQuick.Controls 2.1 (Qt 5.8).</p>
<p><b>See also </b><a href="qml-qtquick-controls2-textarea.html#hovered-prop">hovered</a>.</p>
</div></div><!-- @@@hoverEnabled -->
<br/>
<!-- $$$hovered -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="hovered-prop">
<td class="tblQmlPropNode"><p>
<a name="hovered-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">hovered</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the text area is hovered.</p>
<p>This QML property was introduced in  QtQuick.Controls 2.1 (Qt 5.8).</p>
<p><b>See also </b><a href="qml-qtquick-controls2-textarea.html#hoverEnabled-prop">hoverEnabled</a>.</p>
</div></div><!-- @@@hovered -->
<br/>
<!-- $$$placeholderText -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="placeholderText-prop">
<td class="tblQmlPropNode"><p>
<a name="placeholderText-prop"></a><span class="name">placeholderText</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the short hint that is displayed in the text area before the user enters a value.</p>
</div></div><!-- @@@placeholderText -->
<br/>
<h2>Attached Property Documentation</h2>
<!-- $$$flickable -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="flickable-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="flickable-attached-prop"></a><span class="name">TextArea.flickable</span> : <span class="type"><a href="qml-qtquick-controls2-textarea.html">TextArea</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property attaches a text area to a <a href="../qtquick/qml-qtquick-flickable.html">Flickable</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a>, <a href="qml-qtquick-controls2-scrollindicator.html">ScrollIndicator</a>, and <a href="qml-qtquick-controls2-textarea.html#scrollable-textarea">Scrollable TextArea</a>.</p>
</div></div><!-- @@@flickable -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$pressAndHold -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pressAndHold-signal">
<td class="tblQmlFuncNode"><p>
<a name="pressAndHold-signal"></a><span class="type">void</span> <span class="name">pressAndHold</span>(<span class="type"><a href="../qtquick/qml-qtquick-mouseevent.html">MouseEvent</a></span> <i>event</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when there is a long press (the delay depends on the platform plugin). The <a href="../qtquick/qml-qtquick-mouseevent.html">event</a> parameter provides information about the press, including the x and y position of the press, and which button is pressed.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-textarea.html#pressed-signal">pressed</a> and <a href="qml-qtquick-controls2-textarea.html#released-signal">released</a>.</p>
</div></div><!-- @@@pressAndHold -->
<br/>
<!-- $$$pressed -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pressed-signal">
<td class="tblQmlFuncNode"><p>
<a name="pressed-signal"></a><span class="type">void</span> <span class="name">pressed</span>(<span class="type"><a href="../qtquick/qml-qtquick-mouseevent.html">MouseEvent</a></span> <i>event</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the text area is pressed by the user. The <a href="../qtquick/qml-qtquick-mouseevent.html">event</a> parameter provides information about the press, including the x and y position of the press, and which button is pressed.</p>
<p>This QML signal was introduced in  QtQuick.Controls 2.1 (Qt 5.8).</p>
<p><b>See also </b><a href="qml-qtquick-controls2-textarea.html#released-signal">released</a> and <a href="qml-qtquick-controls2-textarea.html#pressAndHold-signal">pressAndHold</a>.</p>
</div></div><!-- @@@pressed -->
<br/>
<!-- $$$released -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="released-signal">
<td class="tblQmlFuncNode"><p>
<a name="released-signal"></a><span class="type">void</span> <span class="name">released</span>(<span class="type"><a href="../qtquick/qml-qtquick-mouseevent.html">MouseEvent</a></span> <i>event</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the text area is released by the user. The <a href="../qtquick/qml-qtquick-mouseevent.html">event</a> parameter provides information about the release, including the x and y position of the press, and which button is pressed.</p>
<p>This QML signal was introduced in  QtQuick.Controls 2.1 (Qt 5.8).</p>
<p><b>See also </b><a href="qml-qtquick-controls2-textarea.html#pressed-signal">pressed</a> and <a href="qml-qtquick-controls2-textarea.html#pressAndHold-signal">pressAndHold</a>.</p>
</div></div><!-- @@@released -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    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. </p>
</div>
</body>
</html>