<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>cairomm: Cairo::LinearGradient Class Reference</title>
<link href="cairomm.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCairo.html">Cairo</a> </li>
<li class="navelem"><a class="el" href="classCairo_1_1LinearGradient.html">LinearGradient</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>Cairo::LinearGradient Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Cairo::LinearGradient" --><!-- doxytag: inherits="Cairo::Gradient" --><div class="dynheader">
Inheritance diagram for Cairo::LinearGradient:</div>
<div class="dyncontent">
<div class="center"><img src="classCairo_1_1LinearGradient__inherit__graph.png" border="0" usemap="#Cairo_1_1LinearGradient_inherit__map" alt="Inheritance graph"/></div>
<map name="Cairo_1_1LinearGradient_inherit__map" id="Cairo_1_1LinearGradient_inherit__map">
<area shape="rect" id="node2" href="classCairo_1_1Gradient.html" title="Cairo::Gradient" alt="" coords="23,86,132,117"/><area shape="rect" id="node4" href="classCairo_1_1Pattern.html" title="This is a reference-counted object that should be used via Cairo::RefPtr." alt="" coords="27,6,128,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCairo_1_1LinearGradient-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1LinearGradient.html#a2dea1c14f7c79bac3daa271a3ddbcca6">LinearGradient</a> (cairo_pattern_t*<a class="el" href="classCairo_1_1Pattern.html#a430a261a68ae70ca1bd818c781178abc">cobject</a>, bool has_reference=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a C++ wrapper for the C instance. <a href="#a2dea1c14f7c79bac3daa271a3ddbcca6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1LinearGradient.html#af885258cb4833bec0e0a84476b52340f">get_linear_points</a> (double& x0, double& y0, double& x1, double& y1) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1LinearGradient.html#a4a31b3447c1e3370bd9ec6d72f4324be">~LinearGradient</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>< <a class="el" href="classCairo_1_1LinearGradient.html">LinearGradient</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1LinearGradient.html#ada4b398d3c60dec6f650e940b2117f71">create</a> (double x0, double y0, double x1, double y1)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1LinearGradient.html#af6b8e8e36eca93bbc6abbd85955299fe">LinearGradient</a> (double x0, double y0, double x1, double y1)</td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af6b8e8e36eca93bbc6abbd85955299fe"></a><!-- doxytag: member="Cairo::LinearGradient::LinearGradient" ref="af6b8e8e36eca93bbc6abbd85955299fe" args="(double x0, double y0, double x1, double y1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cairo::LinearGradient::LinearGradient </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y1</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2dea1c14f7c79bac3daa271a3ddbcca6"></a><!-- doxytag: member="Cairo::LinearGradient::LinearGradient" ref="a2dea1c14f7c79bac3daa271a3ddbcca6" args="(cairo_pattern_t *cobject, bool has_reference=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cairo::LinearGradient::LinearGradient </td>
<td>(</td>
<td class="paramtype">cairo_pattern_t * </td>
<td class="paramname"><em>cobject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>has_reference</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a C++ wrapper for the C instance. </p>
<p>This C++ instance should then be given to a <a class="el" href="classCairo_1_1RefPtr.html" title="RefPtr<> is a reference-counting shared smartpointer.">RefPtr</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cobject</td><td>The C instance. </td></tr>
<tr><td class="paramname">has_reference</td><td>Whether we already have a reference. Otherwise, the constructor will take an extra reference. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4a31b3447c1e3370bd9ec6d72f4324be"></a><!-- doxytag: member="Cairo::LinearGradient::~LinearGradient" ref="a4a31b3447c1e3370bd9ec6d72f4324be" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Cairo::LinearGradient::~LinearGradient </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ada4b398d3c60dec6f650e940b2117f71"></a><!-- doxytag: member="Cairo::LinearGradient::create" ref="ada4b398d3c60dec6f650e940b2117f71" args="(double x0, double y0, double x1, double y1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a><<a class="el" href="classCairo_1_1LinearGradient.html">LinearGradient</a>> Cairo::LinearGradient::create </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y1</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af885258cb4833bec0e0a84476b52340f"></a><!-- doxytag: member="Cairo::LinearGradient::get_linear_points" ref="af885258cb4833bec0e0a84476b52340f" args="(double &x0, double &y0, double &x1, double &y1) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::LinearGradient::get_linear_points </td>
<td>(</td>
<td class="paramtype">double & </td>
<td class="paramname"><em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"><em>y0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"><em>y1</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">x0</td><td>return value for the x coordinate of the first point </td></tr>
<tr><td class="paramname">y0</td><td>return value for the y coordinate of the first point </td></tr>
<tr><td class="paramname">x1</td><td>return value for the x coordinate of the second point </td></tr>
<tr><td class="paramname">y1</td><td>return value for the y coordinate of the second point</td></tr>
</table>
</dd>
</dl>
<p>Gets the gradient endpoints for a linear gradient.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>1.4 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>cairomm/pattern.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon May 9 2011 09:51:07 for cairomm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
