<!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::Gradient 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_1Gradient.html">Gradient</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>Cairo::Gradient Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Cairo::Gradient" --><!-- doxytag: inherits="Cairo::Pattern" --><div class="dynheader">
Inheritance diagram for Cairo::Gradient:</div>
<div class="dyncontent">
<div class="center"><img src="classCairo_1_1Gradient__inherit__graph.png" border="0" usemap="#Cairo_1_1Gradient_inherit__map" alt="Inheritance graph"/></div>
<map name="Cairo_1_1Gradient_inherit__map" id="Cairo_1_1Gradient_inherit__map">
<area shape="rect" id="node5" href="classCairo_1_1LinearGradient.html" title="Cairo::LinearGradient" alt="" coords="5,166,149,197"/><area shape="rect" id="node7" href="classCairo_1_1RadialGradient.html" title="Cairo::RadialGradient" alt="" coords="173,166,317,197"/><area shape="rect" id="node2" href="classCairo_1_1Pattern.html" title="This is a reference-counted object that should be used via Cairo::RefPtr." alt="" coords="111,6,212,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCairo_1_1Gradient-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_1Gradient.html#a85f7dabff18993648a3e920eb7a8eb04">Gradient</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="#a85f7dabff18993648a3e920eb7a8eb04"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Gradient.html#ab14387f9054c5c8222452743d72d616b">~Gradient</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Gradient.html#afe5e5167dd48fc684c7e88ea07340a6c">add_color_stop_rgb</a> (double offset, double red, double green, double blue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an opaque color stop to a gradient pattern. <a href="#afe5e5167dd48fc684c7e88ea07340a6c"></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_1Gradient.html#a688da07943fa37f8ccbe33c379544d9f">add_color_stop_rgba</a> (double offset, double red, double green, double blue, double alpha)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a translucent color stop to a gradient pattern. <a href="#a688da07943fa37f8ccbe33c379544d9f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00738.html">std::vector</a>< <a class="el" href="structCairo_1_1ColorStop.html">ColorStop</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1Gradient.html#abce464810b8a65c5804146fb5474c5cd">get_color_stops</a> () const </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_1Gradient.html#ae50ccbfd16c1a03cd26b574ac4cd7533">Gradient</a> ()</td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a85f7dabff18993648a3e920eb7a8eb04"></a><!-- doxytag: member="Cairo::Gradient::Gradient" ref="a85f7dabff18993648a3e920eb7a8eb04" args="(cairo_pattern_t *cobject, bool has_reference=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cairo::Gradient::Gradient </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="ab14387f9054c5c8222452743d72d616b"></a><!-- doxytag: member="Cairo::Gradient::~Gradient" ref="ab14387f9054c5c8222452743d72d616b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Cairo::Gradient::~Gradient </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae50ccbfd16c1a03cd26b574ac4cd7533"></a><!-- doxytag: member="Cairo::Gradient::Gradient" ref="ae50ccbfd16c1a03cd26b574ac4cd7533" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cairo::Gradient::Gradient </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afe5e5167dd48fc684c7e88ea07340a6c"></a><!-- doxytag: member="Cairo::Gradient::add_color_stop_rgb" ref="afe5e5167dd48fc684c7e88ea07340a6c" args="(double offset, double red, double green, double blue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::Gradient::add_color_stop_rgb </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>red</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>green</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>blue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an opaque color stop to a gradient pattern. </p>
<p>The offset specifies the location along the gradient's control vector. For example, a linear gradient's control vector is from (x0,y0) to (x1,y1) while a radial gradient's control vector is from any point on the start circle to the corresponding point on the end circle.</p>
<p>The color is specified in the same way as in <a class="el" href="classCairo_1_1Context.html#aff3f3fc62bdf862646bb8cc568c30b2a" title="Sets the source pattern within the Context to an opaque color.">Context::set_source_rgb()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>an offset in the range [0.0 .. 1.0] </td></tr>
<tr><td class="paramname">red</td><td>red component of color </td></tr>
<tr><td class="paramname">green</td><td>green component of color </td></tr>
<tr><td class="paramname">blue</td><td>blue component of color </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a688da07943fa37f8ccbe33c379544d9f"></a><!-- doxytag: member="Cairo::Gradient::add_color_stop_rgba" ref="a688da07943fa37f8ccbe33c379544d9f" args="(double offset, double red, double green, double blue, double alpha)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::Gradient::add_color_stop_rgba </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>red</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>green</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>blue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>alpha</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a translucent color stop to a gradient pattern. </p>
<p>The offset specifies the location along the gradient's control vector. For example, a linear gradient's control vector is from (x0,y0) to (x1,y1) while a radial gradient's control vector is from any point on the start circle to the corresponding point on the end circle.</p>
<p>The color is specified in the same way as in <a class="el" href="classCairo_1_1Context.html#af9267aed8eb866701178dcada6c7e51a" title="Sets the source pattern within the Context to a translucent color.">Context::set_source_rgba()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>an offset in the range [0.0 .. 1.0] </td></tr>
<tr><td class="paramname">red</td><td>red component of color </td></tr>
<tr><td class="paramname">green</td><td>green component of color </td></tr>
<tr><td class="paramname">blue</td><td>blue component of color </td></tr>
<tr><td class="paramname">alpha</td><td>alpha component of color </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abce464810b8a65c5804146fb5474c5cd"></a><!-- doxytag: member="Cairo::Gradient::get_color_stops" ref="abce464810b8a65c5804146fb5474c5cd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00738.html">std::vector</a><<a class="el" href="structCairo_1_1ColorStop.html">ColorStop</a>> Cairo::Gradient::get_color_stops </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</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>
