blob: 154dcd4ad3737435c3b8e64d0befd67e3b4cbc4b [file] [log] [blame]
<html>
<head>
<title>Interface XGradient</title>
<style>h3 { font-size:13pt; font-weight:bold; margin-top:3pt; margin-bottom:1pt; }
p, dt, dd, pre { font-size:11pt; margin-top:3pt; margin-bottom:1pt; }
table.lightbg { background-color:#eeeeff; }
table.subtitle { margin-top:6pt; margin-bottom:6pt; }
td { font-size:11pt; }
td.title { font-family: Arial; font-size:19pt; font-weight:bold; text-align:center; background-color:#ccccff; line-height:30pt; }
td.subtitle { font-family: Arial; font-size:13pt; background-color:#ccccff; line-height:20pt; }
td.imdetail { width:100%; background-color:#eeeeff; }
a.membertitle { font-size:12pt; font-weight:bold; line-height:18pt; }
td.imsum_left { width:30%; }
td.imsum_right { width:70%; }
td.navimain, a.navimain { text-align:center; font-family: Arial; font-size:12pt; font-weight:bold; }
td.navimainself { text-align:center; font-family: Arial; font-size:12pt; font-weight:bold; color:#ffffff; background-color:#2222ad; }
td.navimainnone { text-align:center; font-family: Arial; font-size:12pt; }
td.attrtitle { font-weight:bold; background-color:#eeeeff; }
td.navisub, a.navisub, td.attrtitle, td.attrvalue { text-align:center; font-family: Arial; font-size:9pt; font-variant:small-caps; }
td.navimain, td.navisub { padding-left:7pt; padding-right:7pt; }
p.raise { font-size:11pt; margin-top:0pt; text-align:right; padding-right:5pt; }
a.navimain, a.navisub { color:#000000; }
.dt { font-weight:bold; }
.namechain { font-size:13pt; font-weight:bold; margin-top:3pt; margin-bottom:6pt; }
.tpl { font-size:13pt; margin-top:3pt; margin-bottom:6pt; }
</style>
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff">
<a name="_top_"> </a>
<table border="0" cellpadding="3" class="lightbg">
<tr>
<td class="navimain"><a href="com/sun/star/module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XGradient-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="module-ix.html" class="namechain">::</a> </p>
</td>
</tr>
<tr>
<td class="title">interface XGradient</td>
</tr>
<tr>
<td/></tr>
<tr>
<td/></tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getOutline">getOutline</a></td>
<td class="imsum_right"> Query the gradient outline at the specified value. The
returned outline must be clipped to the [0,1]x[0,1]
rectangle.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getColor">getColor</a></td>
<td class="imsum_right"> Query the color value for the gradient area at the specified
parameter value.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPointColor">getPointColor</a></td>
<td class="imsum_right"> Query the color for a dedicated point in the plane.
</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getOutline" class="membertitle">getOutline</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top"><a href="XPolyPolygon2D.html">XPolyPolygon2D</a><br>
<b>getOutline</b>(</td>
<td valign="top">&nbsp;<br>
[in] double</td>
<td valign="top">&nbsp;<br>
t );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Query the gradient outline at the specified value. The
returned outline must be clipped to the [0,1]x[0,1]
rectangle.
</dd>
<dt><b>Parameter t</b></dt>
<dd>
Parameter value in the range [0,1]. During painting, this
range is sweeped through starting from 0, therefore the area
covered by the returned XPolyPolygon2D should be monotonically
decreasing with t (unless singularities in the resulting
gradient are desired).
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getColor" class="membertitle">getColor</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">sequence&lt; double &gt;<br>
<b>getColor</b>(</td>
<td valign="top">&nbsp;<br>
[in] double</td>
<td valign="top">&nbsp;<br>
t );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Query the color value for the gradient area at the specified
parameter value.
</dd>
<dt><b>Parameter t</b></dt>
<dd>
Parameter value in the range [0,1]. During painting, this
range is sweeped through starting from 0.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPointColor" class="membertitle">getPointColor</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">sequence&lt; double &gt;<br>
<b>getPointColor</b>(</td>
<td valign="top">&nbsp;<br>
[in] <a href="Point2D.html">Point2D</a></td>
<td valign="top">&nbsp;<br>
point );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Query the color for a dedicated point in the plane.
</dd>
<dt><b>Parameter point</b></dt>
<dd>
The permissible parameter range for point is [0,1]x[0,1]
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2003 Sun Microsystems, Inc.</p>
</body>
</html>