This file is indexed.

/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-drawer.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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickdrawer.cpp -->
  <title>Drawer 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 >Drawer 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Drawer QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Drawer-brief -->
<p>Side panel that can be opened and closed using a swipe gesture. <a href="#details">More...</a></p>
<!-- @@@Drawer -->
<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></table></div><ul>
<li><a href="qml-qtquick-controls2-drawer-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-drawer.html#dragMargin-prop">dragMargin</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-drawer.html#edge-prop">edge</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-drawer.html#interactive-prop">interactive</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-drawer.html#position-prop">position</a></b></b> : real</li>
</ul>
<!-- $$$Drawer-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Drawer provides a swipe-based side panel, similar to those often used in touch interfaces to provide a central location for navigation.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-drawer.gif" alt="" /></p><p>Drawer can be positioned at any of the four edges of the content item. The drawer above is positioned against the left edge of the window. The drawer is then opened by <i>&quot;dragging&quot;</i> it out from the left edge of the window.</p>
<pre class="cpp">

  import <span class="type"><a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a></span> <span class="number">2.7</span>
  import <span class="type"><a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a></span><span class="operator">.</span>Controls <span class="number">2.0</span>

  ApplicationWindow {
      id: window
      visible: <span class="keyword">true</span>

      Drawer {
          id: drawer
          width: <span class="number">0.66</span> <span class="operator">*</span> window<span class="operator">.</span>width
          height: window<span class="operator">.</span>height

          Label {
              text: <span class="string">&quot;Content goes here!&quot;</span>
              anchors<span class="operator">.</span>centerIn: parent
          }
      }
  }

</pre>
<p>Drawer is a special type of popup that resides at one of the window <a href="qml-qtquick-controls2-drawer.html#edge-prop">edges</a>. By default, Drawer re-parents itself to the window <a href="qml-qtquick-controls2-applicationwindow.html#overlay-attached-prop">overlay</a>, and therefore operates on window coordinates. It is also possible to manually set the <a href="qml-qtquick-controls2-popup.html#parent-prop">parent</a> to something else to make the drawer operate in a specific coordinate space.</p>
<p>Drawer can be configured to cover only part of its window edge. The following example illustrates how Drawer can be positioned to appear below a window header:</p>
<pre class="cpp">

  import <span class="type"><a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a></span> <span class="number">2.7</span>
  import <span class="type"><a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a></span><span class="operator">.</span>Controls <span class="number">2.0</span>

  ApplicationWindow {
      id: window
      visible: <span class="keyword">true</span>

      header: ToolBar { }

      Drawer {
          y: header<span class="operator">.</span>height
          width: window<span class="operator">.</span>width <span class="operator">*</span> <span class="number">0.6</span>
          height: window<span class="operator">.</span>height <span class="operator">-</span> header<span class="operator">.</span>height
      }
  }

</pre>
<p>The <a href="qml-qtquick-controls2-drawer.html#position-prop">position</a> property determines how much of the drawer is visible, as a value between <code>0.0</code> and <code>1.0</code>. It is not possible to set the x-coordinate (or horizontal margins) of a drawer at the left or right window edge, or the y-coordinate (or vertical margins) of a drawer at the top or bottom window edge.</p>
<p>In the image above, the application's contents are <i>&quot;pushed&quot;</i> across the screen. This is achieved by applying a translation to the contents:</p>
<pre class="cpp">

  import <span class="type"><a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a></span> <span class="number">2.7</span>
  import <span class="type"><a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a></span><span class="operator">.</span>Controls <span class="number">2.1</span>

  ApplicationWindow {
      id: window
      width: <span class="number">200</span>
      height: <span class="number">228</span>
      visible: <span class="keyword">true</span>

      Drawer {
          id: drawer
          width: <span class="number">0.66</span> <span class="operator">*</span> window<span class="operator">.</span>width
          height: window<span class="operator">.</span>height
      }

      Label {
          id: content

          text: <span class="string">&quot;Aa&quot;</span>
          font<span class="operator">.</span>pixelSize: <span class="number">96</span>
          anchors<span class="operator">.</span>fill: parent
          verticalAlignment: Label<span class="operator">.</span>AlignVCenter
          horizontalAlignment: Label<span class="operator">.</span>AlignHCenter

          transform: Translate {
              x: drawer<span class="operator">.</span>position <span class="operator">*</span> content<span class="operator">.</span>width <span class="operator">*</span> <span class="number">0.33</span>
          }
      }
  }

</pre>
<p>If you would like the application's contents to stay where they are when the drawer is opened, don't apply a translation.</p>
<p>Drawer can be configured as a non-closable persistent side panel by making the Drawer <a href="qml-qtquick-controls2-popup.html#modal-prop">non-modal</a> and <a href="qml-qtquick-controls2-drawer.html#interactive-prop">non-interactive</a>. See the <a href="qtquickcontrols2-sidepanel-example.html">Side Panel</a> example for more details.</p>
<p><b>Note: </b>On some platforms, certain edges may be reserved for system gestures and therefore cannot be used with Drawer. For example, the top and bottom edges may be reserved for system notifications and control centers on Android and iOS.</p><p><b>See also </b><a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>, <a href="qtquickcontrols2-customize.html#customizing-drawer">Customizing Drawer</a>, <a href="qtquickcontrols2-navigation.html">Navigation Controls</a>, and <a href="qtquickcontrols2-popups.html">Popup Controls</a>.</p>
<!-- @@@Drawer -->
<h2>Property Documentation</h2>
<!-- $$$dragMargin -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="dragMargin-prop">
<td class="tblQmlPropNode"><p>
<a name="dragMargin-prop"></a><span class="name">dragMargin</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the distance from the screen edge within which drag actions will open the drawer. Setting the value to <code>0</code> or less prevents opening the drawer by dragging.</p>
<p>The default value is <code>Qt.styleHints.startDragDistance</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-drawer.html#interactive-prop">interactive</a>.</p>
</div></div><!-- @@@dragMargin -->
<br/>
<!-- $$$edge -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="edge-prop">
<td class="tblQmlPropNode"><p>
<a name="edge-prop"></a><span class="name">edge</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the edge of the window at which the drawer will open from. The acceptable values are:</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.TopEdge</code></td><td class="topAlign">The top edge of the window.</td></tr>
<tr><td class="topAlign"><code>Qt.LeftEdge</code></td><td class="topAlign">The left edge of the window (default).</td></tr>
<tr><td class="topAlign"><code>Qt.RightEdge</code></td><td class="topAlign">The right edge of the window.</td></tr>
<tr><td class="topAlign"><code>Qt.BottomEdge</code></td><td class="topAlign">The bottom edge of the window.</td></tr>
</table></div>
</div></div><!-- @@@edge -->
<br/>
<!-- $$$interactive -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="interactive-prop">
<td class="tblQmlPropNode"><p>
<a name="interactive-prop"></a><span class="name">interactive</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the drawer is interactive. A non-interactive drawer does not react to swipes.</p>
<p>The default value is <code>true</code>.</p>
<p>This QML property was introduced in  QtQuick.Controls 2.2 (Qt 5.9).</p>
<p><b>See also </b><a href="qml-qtquick-controls2-drawer.html#dragMargin-prop">dragMargin</a>.</p>
</div></div><!-- @@@interactive -->
<br/>
<!-- $$$position -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="position-prop">
<td class="tblQmlPropNode"><p>
<a name="position-prop"></a><span class="name">position</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the position of the drawer relative to its final destination. That is, the position will be <code>0.0</code> when the drawer is fully closed, and <code>1.0</code> when fully open.</p>
</div></div><!-- @@@position -->
<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>