Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 1802

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XCoordinateSystem</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../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="XCoordinateSystem-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 class="navisub" 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" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">chart2</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XCoordinateSystem</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="#getDimension">getDimension</a></td>
<td class="imsum_right">the dimension of the coordinate-system.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getCoordinateSystemType">getCoordinateSystemType</a></td>
<td class="imsum_right">identifies the type of coordinate system (e.g. cartesian, polar ...)
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getViewServiceName">getViewServiceName</a></td>
<td class="imsum_right">return a service name from which the view component for this coordinate system can be created
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setAxisByDimension">setAxisByDimension</a></td>
<td class="imsum_right">The dimension says wether it is a x, y or z axis.
 The index says wether it is a primary or a secondary axis.
 Use nIndex == 0 for a primary axis.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getAxisByDimension">getAxisByDimension</a></td>
<td class="imsum_right">The dimension says wether it is a x, y or z axis.
 The index indicates wether it is a primary or a secondary axis or maybe more in future.
 Use nIndex == 0 for a primary axis.
 An empty Reference will be returned if the given nDimension and nIndex are in the valid range but no axis is set for those values.
 An IndexOutOfBoundsException will be thrown if nDimension is lower than 0 or greater than the value returned by getDimension()
 and/or if nIndex is lower 0 or greater than the value returned by getMaxAxisIndexByDimension(nDimension).
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getMaximumAxisIndexByDimension">getMaximumAxisIndexByDimension</a></td>
<td class="imsum_right">In one dimension there could be several axes to enable main and secondary axis and maybe more in future.
 This method returns the maximum index at which an axis exists for the given dimension.
 It is allowed that some indexes inbetween do not have an axis.
 /&nbsp;</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="getDimension" class="membertitle">getDimension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getDimension</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the dimension of the coordinate-system.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getCoordinateSystemType" class="membertitle">getCoordinateSystemType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getCoordinateSystemType</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>identifies the type of coordinate system (e.g. cartesian, polar ...)
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getViewServiceName" class="membertitle">getViewServiceName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getViewServiceName</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>return a service name from which the view component for this coordinate system can be created
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setAxisByDimension" class="membertitle">setAxisByDimension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setAxisByDimension</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nDimension,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XAxis.html">XAxis</a></td>
<td valign="bottom">&nbsp;xAxis,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The dimension says wether it is a x, y or z axis.
 The index says wether it is a primary or a secondary axis.
 Use nIndex == 0 for a primary axis.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAxisByDimension" class="membertitle">getAxisByDimension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="XAxis.html">XAxis</a></td>
</tr>
<tr>
<td valign="top"><b>getAxisByDimension</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nDimension,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The dimension says wether it is a x, y or z axis.
 The index indicates wether it is a primary or a secondary axis or maybe more in future.
 Use nIndex == 0 for a primary axis.
 An empty Reference will be returned if the given nDimension and nIndex are in the valid range but no axis is set for those values.
 An IndexOutOfBoundsException will be thrown if nDimension is lower than 0 or greater than the value returned by getDimension()
 and/or if nIndex is lower 0 or greater than the value returned by getMaxAxisIndexByDimension(nDimension).
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getMaximumAxisIndexByDimension" class="membertitle">getMaximumAxisIndexByDimension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getMaximumAxisIndexByDimension</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nDimension )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>In one dimension there could be several axes to enable main and secondary axis and maybe more in future.
 This method returns the maximum index at which an axis exists for the given dimension.
 It is allowed that some indexes inbetween do not have an axis.
 /</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; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>