summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/XChartDataArray.idl
diff options
context:
space:
mode:
authorMichael Hönnig <mi@openoffice.org>2002-10-03 12:11:20 +0000
committerMichael Hönnig <mi@openoffice.org>2002-10-03 12:11:20 +0000
commitcb23f6a62077022736a40d6315ee92a218f489e0 (patch)
tree713895d0de4930fd1a37b2fb7bb6ded971a2acdf /offapi/com/sun/star/chart/XChartDataArray.idl
parent625aff4ec7a47d618a9da160e962fc6fb5c834c5 (diff)
#94968# IDL reviews merged
Diffstat (limited to 'offapi/com/sun/star/chart/XChartDataArray.idl')
-rw-r--r--offapi/com/sun/star/chart/XChartDataArray.idl74
1 files changed, 46 insertions, 28 deletions
diff --git a/offapi/com/sun/star/chart/XChartDataArray.idl b/offapi/com/sun/star/chart/XChartDataArray.idl
index ccea70ae05b7..eee5c83af78b 100644
--- a/offapi/com/sun/star/chart/XChartDataArray.idl
+++ b/offapi/com/sun/star/chart/XChartDataArray.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XChartDataArray.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:02:26 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,60 +71,72 @@
//=============================================================================
-// DocMerge from xml: interface com::sun::star::chart::XChartDataArray
/** gives access to data represented as an array of rows.
-
-
- <p>If used for xy-diagrams the row number 0 represents the x-values.</p>
+ <p>If used for an <type>XYDiagram</type>, the row number 0
+ represents the <i>x</i>-values.</p>
*/
interface XChartDataArray: XChartData
{
//-------------------------------------------------------------------------
- // DocMerge from idl: method com::sun::star::chart::XChartDataArray::getData
- /** retrieves the numerical data as a sequence of rows. Each row is
- represented as a sequence of double values.
- */
+ /** retrieves the numerical data as a nested sequence of values.
+
+ @returns
+ the values as a sequence of sequences. The inner sequence
+ represents rows.
+ */
sequence< sequence< double > > getData();
//-------------------------------------------------------------------------
- // DocMerge from xml: method com::sun::star::chart::XChartDataArray::setData
- /** sets the chart data as a sequence of sequences of double values.
+ /** sets the chart data as an array of numbers.
+
+ @param aData
+ the values as a sequence of sequences. The inner sequence
+ represents rows.
*/
void setData( [in] sequence< sequence< double > > aData );
//-------------------------------------------------------------------------
- // DocMerge from idl: method com::sun::star::chart::XChartDataArray::getRowDescriptions
- /** retrieves the description texts of all rows as a sequence of strings.
+ /** retrieves the description texts for all rows.
+
+ @returns
+ a sequence of strings, each representing the description
+ of a row.
*/
- sequence<string> getRowDescriptions();
+ sequence< string > getRowDescriptions();
//-------------------------------------------------------------------------
- // DocMerge from xml: method com::sun::star::chart::XChartDataArray::setRowDescriptions
- /** sets the description texts of all rows according to the sequence of
- strings given.
- */
- void setRowDescriptions( [in] sequence<string> aRowDescriptions );
+ /** sets the description texts for all rows.
+
+ @param aRowDescriptions
+ a sequence of strings which represent a description for
+ each row.
+ */
+ void setRowDescriptions( [in] sequence< string > aRowDescriptions );
//-------------------------------------------------------------------------
- // DocMerge from idl: method com::sun::star::chart::XChartDataArray::getColumnDescriptions
- /** retrieves the description texts of all columns as a sequence of strings.
+ /** retrieves the description texts for all columns.
+
+ @returns
+ a sequence of strings, each representing the description
+ of a column.
*/
- sequence<string> getColumnDescriptions();
+ sequence< string > getColumnDescriptions();
//-------------------------------------------------------------------------
- // DocMerge from xml: method com::sun::star::chart::XChartDataArray::setColumnDescriptions
- /** sets the description texts of all columns according to the sequence of
- strings given.
- */
- void setColumnDescriptions( [in] sequence<string> aColumnDescriptions );
+ /** sets the description texts for all columns.
+ @param aColumnDescriptions
+ a sequence of strings which represent a description for
+ each column.
+ */
+ void setColumnDescriptions( [in] sequence< string > aColumnDescriptions );
};
//=============================================================================
@@ -134,6 +146,12 @@ interface XChartDataArray: XChartData
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5.2.1 2002/01/28 17:02:24 bm
+ #96984# IDL Review
+
+ Revision 1.5 2001/10/24 14:54:57 mi
+ proofreading and corrections by Richard Holt
+
Revision 1.4 2001/03/16 16:41:16 jsc
remove interfaceheader with uik and remove [const] in method definitions