Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 1868

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XDataReceiver</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="XDataReceiver-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">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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> :: <a href="module-ix.html" class="namechain">data</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XDataReceiver</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="#attachDataProvider">attachDataProvider</a></td>
<td class="imsum_right">attaches a component that provides data for the document.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setArguments">setArguments</a></td>
<td class="imsum_right">Sets the data for the chart as a whole. When this method is
 called, all currently set data is removed. It is replaced by
 the data that is returned by the current
 <a href="XDataProvider.html">XDataProvider</a> by using the given range
 representation.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getUsedRangeRepresentations">getUsedRangeRepresentations</a></td>
<td class="imsum_right">returns a list of all range strings for which data has been
 requested by the most recently attached data provider, and
 which is still used.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getUsedData">getUsedData</a></td>
<td class="imsum_right">Returns the data requested by the most recently attached data
 provider, that is still used.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#attachNumberFormatsSupplier">attachNumberFormatsSupplier</a></td>
<td class="imsum_right">attaches an ::XNumberFormatsSupplier to this
 <a href="XDataReceiver.html">XDataReceiver</a>.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getRangeHighlighter">getRangeHighlighter</a></td>
<td class="imsum_right">Returns a component at which a view representing the data of
 the attached data provider may listen for highlighting the
 data ranges used by the currently selected objects in the data
 receiver component.

 &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="attachDataProvider" class="membertitle">attachDataProvider</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>attachDataProvider</b>(</td>
<td valign="top">[in] <a href="XDataProvider.html">XDataProvider</a></td>
<td valign="bottom">&nbsp;xProvider );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>attaches a component that provides data for the document.

 </dd>
<dd><p>The previously set data provider will be released.</p>

 </dd>
<dt><b>Parameter xProvider</b></dt>
<dd>The new DataProvider. If it is an empty reference, the
 ChartDocument will have no data.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setArguments" class="membertitle">setArguments</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>setArguments</b>(</td>
<td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;aArguments )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Sets the data for the chart as a whole. When this method is
 called, all currently set data is removed. It is replaced by
 the data that is returned by the current
 <a href="XDataProvider.html">XDataProvider</a> by using the given range
 representation.

 </dd>
<dt><b>Parameter aRangeRepresentation</b></dt>
<dd>This range representation must be in a format that is
 understood by the currently attached
 <a href="XDataProvider.html">XDataProvider</a>.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 If the range representation could not dealt with by the
 current data provider, or there is currently no data
 provider at all.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getUsedRangeRepresentations" class="membertitle">getUsedRangeRepresentations</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">sequence&lt; string &gt;</td>
</tr>
<tr>
<td valign="top"><b>getUsedRangeRepresentations</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns a list of all range strings for which data has been
 requested by the most recently attached data provider, and
 which is still used.

 </dd>
<dd><p>This list may be used by the data provider to swap charts
 out of memory, but still get informed by changes of ranges
 while the chart is not loaded.</p>
 </dd>
<dt><b>Returns</b></dt>
<dd>a list of used range strings.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getUsedData" class="membertitle">getUsedData</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="XDataSource.html">XDataSource</a></td>
</tr>
<tr>
<td valign="top"><b>getUsedData</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the data requested by the most recently attached data
 provider, that is still used.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="attachNumberFormatsSupplier" class="membertitle">attachNumberFormatsSupplier</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>attachNumberFormatsSupplier</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XNumberFormatsSupplier.html">XNumberFormatsSupplier</a></td>
<td valign="bottom">&nbsp;xSupplier );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>attaches an ::XNumberFormatsSupplier to this
 <a href="XDataReceiver.html">XDataReceiver</a>.

 </dd>
<dd><p>The given number formats will be used for display purposes.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getRangeHighlighter" class="membertitle">getRangeHighlighter</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="XRangeHighlighter.html">XRangeHighlighter</a></td>
</tr>
<tr>
<td valign="top"><b>getRangeHighlighter</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns a component at which a view representing the data of
 the attached data provider may listen for highlighting the
 data ranges used by the currently selected objects in the data
 receiver component.

 </dd>
<dd><p>This is typically used by a spreadsheet to hightlight the
 ranges used by the currently selected object in a chart.</p>

 <p>The range hightlighter is optional, i.e., this method may
 return an empty object.</p>
 </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; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

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

</html>