File: qlineargradient.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (153 lines) | stat: -rw-r--r-- 12,236 bytes parent folder | download 
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
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qbrush.cpp -->
  <title>Qt 4.8: QLinearGradient Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QLinearGradient</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QLinearGradient Class Reference</h1>
<!-- $$$QLinearGradient-brief -->
<p>The QLinearGradient class is used in combination with <a href="qbrush.html">QBrush</a> to specify a linear gradient brush. <a href="#details">More...</a></p>
<!-- @@@QLinearGradient -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QLinearGradient&gt;</span></pre><p><b>Inherits: </b><a href="qgradient.html">QGradient</a>.</p>
<ul>
<li><a href="qlineargradient-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#QLinearGradient">QLinearGradient</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#QLinearGradient-2">QLinearGradient</a></b> ( const QPointF &amp; <i>start</i>, const QPointF &amp; <i>finalStop</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#QLinearGradient-3">QLinearGradient</a></b> ( qreal <i>x1</i>, qreal <i>y1</i>, qreal <i>x2</i>, qreal <i>y2</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#finalStop">finalStop</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#setFinalStop">setFinalStop</a></b> ( const QPointF &amp; <i>stop</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#setFinalStop-2">setFinalStop</a></b> ( qreal <i>x</i>, qreal <i>y</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#setStart">setStart</a></b> ( const QPointF &amp; <i>start</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#setStart-2">setStart</a></b> ( qreal <i>x</i>, qreal <i>y</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#start">start</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">10 public functions inherited from <a href="qgradient.html#public-functions">QGradient</a></li>
</ul>
<a name="details"></a>
<!-- $$$QLinearGradient-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QLinearGradient class is used in combination with <a href="qbrush.html">QBrush</a> to specify a linear gradient brush.</p>
<p>Linear gradients interpolate colors between start and end points. Outside these points the gradient is either padded, reflected or repeated depending on the currently set <a href="qgradient.html#Spread-enum">spread</a> method:</p>
<table class="generic">
<tr valign="top" class="odd"><td ><img src="images/qlineargradient-pad.png" alt="" /></td><td ><img src="images/qlineargradient-reflect.png" alt="" /></td><td ><img src="images/qlineargradient-repeat.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><a href="qgradient.html#Spread-enum">PadSpread</a> (default)</td><td ><a href="qgradient.html#Spread-enum">ReflectSpread</a></td><td ><a href="qgradient.html#Spread-enum">RepeatSpread</a></td></tr>
</table>
<p>The colors in a gradient is defined using stop points of the <a href="qgradient.html#QGradientStop-typedef">QGradientStop</a> type, i.e&#x2e; a position and a color. Use the <a href="qgradient.html#setColorAt">QGradient::setColorAt</a>() or the <a href="qgradient.html#setStops">QGradient::setStops</a>() function to define the stop points. It is the gradient's complete set of stop points that describes how the gradient area should be filled. If no stop points have been specified, a gradient of black at 0 to white at 1 is used.</p>
<p>In addition to the functions inherited from <a href="qgradient.html">QGradient</a>, the QLinearGradient class provides the <a href="qlineargradient.html#finalStop">finalStop</a>() function which returns the final stop point of the gradient, and the <a href="qlineargradient.html#start">start</a>() function returning the start point of the gradient.</p>
</div>
<p><b>See also </b><a href="qradialgradient.html">QRadialGradient</a>, <a href="qconicalgradient.html">QConicalGradient</a>, and <a href="demos-gradients.html">The Gradients Demo</a>.</p>
<!-- @@@QLinearGradient -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLinearGradient[overload1]$$$QLinearGradient -->
<h3 class="fn"><a name="QLinearGradient"></a>QLinearGradient::<span class="name">QLinearGradient</span> ()</h3>
<p>Constructs a default linear gradient with interpolation area between (0, 0) and (1, 1).</p>
<p><b>See also </b><a href="qgradient.html#setColorAt">QGradient::setColorAt</a>(), <a href="qlineargradient.html#setStart">setStart</a>(), and <a href="qlineargradient.html#setFinalStop">setFinalStop</a>().</p>
<!-- @@@QLinearGradient -->
<!-- $$$QLinearGradient$$$QLinearGradientconstQPointF&constQPointF& -->
<h3 class="fn"><a name="QLinearGradient-2"></a>QLinearGradient::<span class="name">QLinearGradient</span> ( const <span class="type"><a href="qpointf.html">QPointF</a></span> &amp; <i>start</i>, const <span class="type"><a href="qpointf.html">QPointF</a></span> &amp; <i>finalStop</i> )</h3>
<p>Constructs a linear gradient with interpolation area between the given <i>start</i> point and <i>finalStop</i>.</p>
<p><b>Note:</b> The expected parameter values are in pixels.</p>
<p><b>See also </b><a href="qgradient.html#setColorAt">QGradient::setColorAt</a>() and <a href="qgradient.html#setStops">QGradient::setStops</a>().</p>
<!-- @@@QLinearGradient -->
<!-- $$$QLinearGradient$$$QLinearGradientqrealqrealqrealqreal -->
<h3 class="fn"><a name="QLinearGradient-3"></a>QLinearGradient::<span class="name">QLinearGradient</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>x1</i>, <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>y1</i>, <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>x2</i>, <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>y2</i> )</h3>
<p>Constructs a linear gradient with interpolation area between (<i>x1</i>, <i>y1</i>) and (<i>x2</i>, <i>y2</i>).</p>
<p><b>Note:</b> The expected parameter values are in pixels.</p>
<p><b>See also </b><a href="qgradient.html#setColorAt">QGradient::setColorAt</a>() and <a href="qgradient.html#setStops">QGradient::setStops</a>().</p>
<!-- @@@QLinearGradient -->
<!-- $$$finalStop[overload1]$$$finalStop -->
<h3 class="fn"><a name="finalStop"></a><span class="type"><a href="qpointf.html">QPointF</a></span> QLinearGradient::<span class="name">finalStop</span> () const</h3>
<p>Returns the final stop point of this linear gradient in logical coordinates.</p>
<p><b>See also </b><a href="qlineargradient.html#setFinalStop">setFinalStop</a>() and <a href="qgradient.html#stops">QGradient::stops</a>().</p>
<!-- @@@finalStop -->
<!-- $$$setFinalStop[overload1]$$$setFinalStopconstQPointF& -->
<h3 class="fn"><a name="setFinalStop"></a><span class="type">void</span> QLinearGradient::<span class="name">setFinalStop</span> ( const <span class="type"><a href="qpointf.html">QPointF</a></span> &amp; <i>stop</i> )</h3>
<p>Sets the final stop point of this linear gradient in logical coordinates to <i>stop</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qlineargradient.html#finalStop">finalStop</a>().</p>
<!-- @@@setFinalStop -->
<!-- $$$setFinalStop$$$setFinalStopqrealqreal -->
<h3 class="fn"><a name="setFinalStop-2"></a><span class="type">void</span> QLinearGradient::<span class="name">setFinalStop</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>x</i>, <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>y</i> )</h3>
<p>This is an overloaded function.</p>
<p>Sets the final stop point of this linear gradient in logical coordinates to <i>x</i>, <i>y</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qlineargradient.html#start">start</a>().</p>
<!-- @@@setFinalStop -->
<!-- $$$setStart[overload1]$$$setStartconstQPointF& -->
<h3 class="fn"><a name="setStart"></a><span class="type">void</span> QLinearGradient::<span class="name">setStart</span> ( const <span class="type"><a href="qpointf.html">QPointF</a></span> &amp; <i>start</i> )</h3>
<p>Sets the start point of this linear gradient in logical coordinates to <i>start</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qlineargradient.html#start">start</a>().</p>
<!-- @@@setStart -->
<!-- $$$setStart$$$setStartqrealqreal -->
<h3 class="fn"><a name="setStart-2"></a><span class="type">void</span> QLinearGradient::<span class="name">setStart</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>x</i>, <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>y</i> )</h3>
<p>This is an overloaded function.</p>
<p>Sets the start point of this linear gradient in logical coordinates to <i>x</i>, <i>y</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qlineargradient.html#start">start</a>().</p>
<!-- @@@setStart -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn"><a name="start"></a><span class="type"><a href="qpointf.html">QPointF</a></span> QLinearGradient::<span class="name">start</span> () const</h3>
<p>Returns the start point of this linear gradient in logical coordinates.</p>
<p><b>See also </b><a href="qlineargradient.html#setStart">setStart</a>() and <a href="qgradient.html#stops">QGradient::stops</a>().</p>
<!-- @@@start -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      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.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>