<html> <head> <title>Interface XDataProvider</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="XDataProvider-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> :: <a href="module-ix.html" class="namechain">data</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XDataProvider</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>An application that provides data for a chart must implement this interface. </dd> </dl> </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="#createDataSourcePossible">createDataSourcePossible</a></td> <td class="imsum_right">If <b>true</b> is returned, a call to createDataSource with the same arguments must return a valid XDataSequence object. If <b>false</b> is returned, createDataSource throws an exception. </td> </tr> <tr> <td class="imsum_left"><a href="#createDataSource">createDataSource</a></td> <td class="imsum_right">Creates a data source object that matches the given range representation string. </td> </tr> <tr> <td class="imsum_left"><a href="#detectArguments">detectArguments</a></td> <td class="imsum_right">Tries to find out with what parameters the passed <a href="DataSource.html">DataSource</a> most probably was created. </td> </tr> <tr> <td class="imsum_left"><a href="#createDataSequenceByRangeRepresentationPossible">createDataSequenceByRangeRepresentationPossible</a></td> <td class="imsum_right">If <b>true</b> is returned, a call to createDataSequenceByRangeRepresentation with the same argument must return a valid XDataSequence object. If <b>false</b> is returned, createDataSequenceByRangeRepresentation throws an exception. </td> </tr> <tr> <td class="imsum_left"><a href="#createDataSequenceByRangeRepresentation">createDataSequenceByRangeRepresentation</a></td> <td class="imsum_right">creates a single data sequence for the given data range. </td> </tr> <tr> <td class="imsum_left"><a href="#getRangeSelection">getRangeSelection</a></td> <td class="imsum_right">Returns a component that is able to change a given range representation to another one. This usually is a controller-component that uses the GUI to allow a user to select a new range. </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="createDataSourcePossible" class="membertitle">createDataSourcePossible</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">boolean</td> </tr> <tr> <td valign="top"><b>createDataSourcePossible</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> aArguments );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b> is returned, a call to createDataSource with the same arguments must return a valid XDataSequence object. If <b>false</b> is returned, createDataSource throws an exception. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createDataSource" class="membertitle">createDataSource</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>createDataSource</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> 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>Creates a data source object that matches the given range representation string. </dd> <dd><p>This can be used for creating the necessary data for a new chart out of a previously selected range of cells in a spreadsheet.</p> </dd> <dt><b>Parameter aArguments</b></dt> <dd>Arguments that tell the data provider how to slice the given range. The properties should be defined in a separate service. <p>For spreadsheets and textdocument tables there exists a service <a href="TabularDataProviderArguments.html">TabularDataProviderArguments</a> describing valid values for this list.</p> </dd> <dt><b>Returns</b></dt> <dd>a data source containing <a href="DataSequence.html">DataSequence</a>s that span the entire region given in <code>aArguments</code>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException may be raised by the <a href="XDataProvider.html">XDataProvider</a> if it is unable to interpret the arguments passed in <code>aArguments</code> appropriately. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="detectArguments" class="membertitle">detectArguments</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< ::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/PropertyValue.html">PropertyValue</a> ></td> </tr> <tr> <td valign="top"><b>detectArguments</b>(</td> <td valign="top">[in] <a href="XDataSource.html">XDataSource</a></td> <td valign="bottom"> xDataSource );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Tries to find out with what parameters the passed <a href="DataSource.html">DataSource</a> most probably was created. </dd> <dd><p>if xDataSource is a data source that was created with <a href="#createDataSource">createDataSource</a>, the arguments returned here should be the same than the ones passed to the function. Of course, this cannot be guaranteed. However, if detection is ambiguous, the returned arguments should be empty. </p> <p>This method may merge representation strings together if adjacent ranges appear successively in the range identifiers. E.g., if the first range refers to "$Sheet1.$A$1:$A$8" and the second range refers to "$Sheet1.$B$1:$B$8", those should be merged together to "$Sheet1.$A$1:$B$8".</p> </dd> <dt><b>Parameter xDataSource</b></dt> <dd>A data source containing all data used in a chart. </dd> <dt><b>Returns</b></dt> <dd>Arguments that when being passed to <a href="#createDataSource">createDataSource</a> should in an ideal case return the same data source as <code>xDataSource</code>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createDataSequenceByRangeRepresentationPossible" class="membertitle">createDataSequenceByRangeRepresentationPossible</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">boolean</td> </tr> <tr> <td valign="top"><b>createDataSequenceByRangeRepresentationPossible</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aRangeRepresentation );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>If <b>true</b> is returned, a call to createDataSequenceByRangeRepresentation with the same argument must return a valid XDataSequence object. If <b>false</b> is returned, createDataSequenceByRangeRepresentation throws an exception. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createDataSequenceByRangeRepresentation" class="membertitle">createDataSequenceByRangeRepresentation</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="XDataSequence.html">XDataSequence</a></td> </tr> <tr> <td valign="top"><b>createDataSequenceByRangeRepresentation</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aRangeRepresentation )</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>creates a single data sequence for the given data range. </dd> <dt><b>Parameter aRangeRepresentation</b></dt> <dd>is a string that can be interpreted by the component that implements this interface. The representation string is of a form that may be used in the user interface. </dd> <dt><b>See also</b></dt> <dd><a href="#createDataSource">createDataSource</a><br> @throw com::sun::star::lang::IllegalArgumentException if the given range does not contain a valid range representation for a one-dimensional range of data. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRangeSelection" class="membertitle">getRangeSelection</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">::com::sun::star::<a href="../../sheet/module-ix.html">sheet</a>::<a href="../../sheet/XRangeSelection.html">XRangeSelection</a></td> </tr> <tr> <td valign="top"><b>getRangeSelection</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns a component that is able to change a given range representation to another one. This usually is a controller-component that uses the GUI to allow a user to select a new range. </dd> <dd><p>This method may return nothing, if it does not support range selection or if there is no current controller available that offers the functionality.</p> </dd> <dt><b>Returns</b></dt> <dd>The component for selecting a new range. It must support ::XComponent, in order to inform the receiver about its lifetime.</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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
1877
