<?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/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<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 class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></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 <QLinearGradient></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 & <i>start</i>, const QPointF & <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 & <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 & <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. 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> & <i>start</i>, const <span class="type"><a href="qpointf.html">QPointF</a></span> & <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> & <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> & <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>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
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>
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. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
