This file is indexed.

/usr/share/qt5/doc/qtgraphicaleffects/qml-qtgraphicaleffects-lineargradient.html is in qtgraphicaleffects5-doc-html 5.5.1-1ubuntu1.

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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- LinearGradient.qml -->
  <title>LinearGradient QML Type | Qt Graphical Effects 5.5</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
    <div class="main">
    <div class="main-rounded">
        <div class="navigationbar">
        <ul>
<li>Qt 5.5</li>
<li><a href="qtgraphicaleffects-index.html">Qt Graphical Effects</a></li>
<li><a href="graphicaleffects.html">QML Types</a></li>
<li>LinearGradient QML Type</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
    </ul>
    </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>
<li class="level2"><a href="#example">Example</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">LinearGradient QML Type</h1>
<span class="subtitle"></span>
<!-- $$$LinearGradient-brief -->
<p>Draws a linear gradient. <a href="#details">More...</a></p>
<!-- @@@LinearGradient -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtGraphicalEffects 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  QtGraphicalEffects 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="../qtquick/qml-qtquick-item.html">Item</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtgraphicaleffects-lineargradient-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-qtgraphicaleffects-lineargradient.html#cached-prop">cached</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a></b></b> : variant</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-lineargradient.html#gradient-prop">gradient</a></b></b> : Gradient</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-lineargradient.html#source-prop">source</a></b></b> : variant</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a></b></b> : variant</li>
</ul>
<!-- $$$LinearGradient-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>A gradient is defined by two or more colors, which are blended seamlessly. The colors start from the given start point and end to the given end point.</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Effect applied</th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/LinearGradient.png" alt="" /></p></td></tr>
</table></div>
<a name="example"></a>
<h2 id="example">Example</h2>
<p>The following example shows how to apply the effect.</p>
<pre class="qml">import QtQuick 2.0
import QtGraphicalEffects 1.0

<span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span> {
    <span class="name">width</span>: <span class="number">300</span>
    <span class="name">height</span>: <span class="number">300</span>

    <span class="type"><a href="qml-qtgraphicaleffects-lineargradient.html">LinearGradient</a></span> {
        <span class="name">anchors</span>.fill: <span class="name">parent</span>
        <span class="name">start</span>: <span class="name">Qt</span>.<span class="name">point</span>(<span class="number">0</span>, <span class="number">0</span>)
        <span class="name">end</span>: <span class="name">Qt</span>.<span class="name">point</span>(<span class="number">0</span>, <span class="number">300</span>)
        <span class="name">gradient</span>: <span class="name">Gradient</span> {
            <span class="type"><a href="../qtquick/qml-qtquick-gradientstop.html">GradientStop</a></span> { <span class="name">position</span>: <span class="number">0.0</span>; <span class="name">color</span>: <span class="string">&quot;white&quot;</span> }
            <span class="type"><a href="../qtquick/qml-qtquick-gradientstop.html">GradientStop</a></span> { <span class="name">position</span>: <span class="number">1.0</span>; <span class="name">color</span>: <span class="string">&quot;black&quot;</span> }
        }
    }
}</pre>
<!-- @@@LinearGradient -->
<h2>Property Documentation</h2>
<!-- $$$cached -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="cached-prop"><td class="tblQmlPropNode"><p><a name="cached-prop"></a><span class="name">cached</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property allows the effect output pixels to be cached in order to improve the rendering performance.</p>
<p>Every time the source or effect properties are changed, the pixels in the cache must be updated. Memory consumption is increased, because an extra buffer of memory is required for storing the effect output.</p>
<p>It is recommended to disable the cache when the source or the effect properties are animated.</p>
<p>By default, the property is set to <code>false</code>.</p>
</div></div><!-- @@@cached -->
<br/>
<!-- $$$end -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="end-prop"><td class="tblQmlPropNode"><p><a name="end-prop"></a><span class="name">end</span> : <span class="type"><a href="../qtqml/qml-variant.html">variant</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>This property defines the ending point where the color at gradient position of 1.0 is rendered. Colors at smaller position values are rendered linearly towards the start point. The point is given in pixels and the default value is Qt.point(0, height). Setting the default values for the <a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a> and end results in a full height linear gradient on the y-axis.</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different end values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/LinearGradient_end1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/LinearGradient_end2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/LinearGradient_end3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> end: Qt.point(300, 300) </b></td><td ><b> end: Qt.point(150, 150) </b></td><td ><b> end: Qt.point(300, 0) </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a>: Qt.point(0, 0)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a>: Qt.point(0, 0)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a>: Qt.point(0, 0)</td></tr>
</table></div>
</div></div><!-- @@@end -->
<br/>
<!-- $$$gradient -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="gradient-prop"><td class="tblQmlPropNode"><p><a name="gradient-prop"></a><span class="name">gradient</span> : <span class="type"><a href="../qtquick/qml-qtquick-gradient.html">Gradient</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>A gradient is defined by two or more colors, which are blended seamlessly. The colors are specified as a set of <a href="../qtquick/qml-qtquick-gradientstop.html">GradientStop</a> child items, each of which defines a position on the gradient from 0.0 to 1.0 and a color. The position of each <a href="../qtquick/qml-qtquick-gradientstop.html">GradientStop</a> is defined by the position property, and the color is definded by the color property.</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different gradient values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/LinearGradient_gradient1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/LinearGradient_gradient2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/LinearGradient_gradient3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b>gradient:</b><pre class="cpp">Gradient {
  GradientStop {
     position: <span class="number">0.000</span>
     color: <span class="type"><a href="../qtqml/qml-qtqml-qt.html">Qt</a></span><span class="operator">.</span>rgba(<span class="number">1</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">1</span>)
  }
  GradientStop {
     position: <span class="number">0.167</span>
     color: <span class="type"><a href="../qtqml/qml-qtqml-qt.html">Qt</a></span><span class="operator">.</span>rgba(<span class="number">1</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">1</span>)
  }
  GradientStop {
     position: <span class="number">0.333</span>
     color: <span class="type"><a href="../qtqml/qml-qtqml-qt.html">Qt</a></span><span class="operator">.</span>rgba(<span class="number">0</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">1</span>)
  }
  GradientStop {
     position: <span class="number">0.500</span>
     color: <span class="type"><a href="../qtqml/qml-qtqml-qt.html">Qt</a></span><span class="operator">.</span>rgba(<span class="number">0</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">1</span>)
  }
  GradientStop {
     position: <span class="number">0.667</span>
     color: <span class="type"><a href="../qtqml/qml-qtqml-qt.html">Qt</a></span><span class="operator">.</span>rgba(<span class="number">0</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">1</span>)
  }
  GradientStop {
     position: <span class="number">0.833</span>
     color: <span class="type"><a href="../qtqml/qml-qtqml-qt.html">Qt</a></span><span class="operator">.</span>rgba(<span class="number">1</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">1</span>)
  }
  GradientStop {
     position: <span class="number">1.000</span>
     color: <span class="type"><a href="../qtqml/qml-qtqml-qt.html">Qt</a></span><span class="operator">.</span>rgba(<span class="number">1</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">1</span>)
  }
}</pre>
</td><td ><b>gradient:</b><pre class="cpp">Gradient {
  GradientStop {
    position: <span class="number">0.0</span>
    color: <span class="string">&quot;#F0F0F0&quot;</span>
  }
  GradientStop {
    position: <span class="number">0.5</span>
    color: <span class="string">&quot;#000000&quot;</span>
  }
  GradientStop {
    position: <span class="number">1.0</span>
    color: <span class="string">&quot;#F0F0F0&quot;</span>
  }
}</pre>
</td><td ><b>gradient:</b><pre class="cpp">Gradient {
  GradientStop {
    position: <span class="number">0.0</span>
    color: <span class="string">&quot;#00000000&quot;</span>
  }
  GradientStop {
    position: <span class="number">1.0</span>
    color: <span class="string">&quot;#FF000000&quot;</span>
  }
}</pre>
</td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a>: Qt.point(0, 0)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a>: Qt.point(0, 0)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a>: Qt.point(0, 0)</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a>: Qt.point(300, 300)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a>: Qt.point(300, 300)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a>: Qt.point(300, 300)</td></tr>
</table></div>
</div></div><!-- @@@gradient -->
<br/>
<!-- $$$source -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="source-prop"><td class="tblQmlPropNode"><p><a name="source-prop"></a><span class="name">source</span> : <span class="type"><a href="../qtqml/qml-variant.html">variant</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>This property defines the item that is going to be filled with gradient. Source item gets rendered into an intermediate pixel buffer and the alpha values from the result are used to determine the gradient's pixels visibility in the display. The default value for source is undefined and in that case whole effect area is filled with gradient.</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different source values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/LinearGradient_maskSource1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/LinearGradient_maskSource2.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> source: undefined </b></td><td ><b> source: Image { source: images/butterfly.png } </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a>: Qt.point(0, 0)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#start-prop">start</a>: Qt.point(0, 0)</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a>: Qt.point(300, 300)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a>: Qt.point(300, 300)</td></tr>
</table></div>
<p><b>Note: </b>It is not supported to let the effect include itself, for instance by setting source to the effect's parent.</p></div></div><!-- @@@source -->
<br/>
<!-- $$$start -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="start-prop"><td class="tblQmlPropNode"><p><a name="start-prop"></a><span class="name">start</span> : <span class="type"><a href="../qtqml/qml-variant.html">variant</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>This property defines the starting point where the color at gradient position of 0.0 is rendered. Colors at larger position values are rendered linearly towards the end point. The point is given in pixels and the default value is Qt.point(0, 0). Setting the default values for the start and <a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a> results in a full height linear gradient on the y-axis.</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different start values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/LinearGradient_start1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/LinearGradient_start2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/LinearGradient_start3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> start: QPoint(0, 0) </b></td><td ><b> start: QPoint(150, 150) </b></td><td ><b> start: QPoint(300, 0) </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a>: QPoint(300, 300)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a>: QPoint(300, 300)</td><td ><a href="qml-qtgraphicaleffects-lineargradient.html#end-prop">end</a>: QPoint(300, 300)</td></tr>
</table></div>
</div></div><!-- @@@start -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2015 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>