diff options
author | Ingrid Halama <iha@openoffice.org> | 2010-02-05 13:06:08 +0100 |
---|---|---|
committer | Ingrid Halama <iha@openoffice.org> | 2010-02-05 13:06:08 +0100 |
commit | 7e448279faf0a89eaf72cdb2dc94c1752baf1f34 (patch) | |
tree | 3cf48d7781d1ad989fe7798357170a399a53ae65 | |
parent | 4d25f2a41929080258462cb53b843c52d084d0c9 (diff) |
chartmultiline: #i108759# enhance API documentation for data access and #i82971#
-rw-r--r-- | offapi/com/sun/star/chart/XChartDataArray.idl | 2 | ||||
-rw-r--r-- | offapi/com/sun/star/chart/XChartDocument.idl | 28 | ||||
-rwxr-xr-x | offapi/com/sun/star/chart/XComplexDescriptionAccess.idl | 9 |
3 files changed, 32 insertions, 7 deletions
diff --git a/offapi/com/sun/star/chart/XChartDataArray.idl b/offapi/com/sun/star/chart/XChartDataArray.idl index 59e8c0a1a8ea..2f76456f6acb 100644 --- a/offapi/com/sun/star/chart/XChartDataArray.idl +++ b/offapi/com/sun/star/chart/XChartDataArray.idl @@ -42,6 +42,8 @@ /** gives access to data represented as an array of rows. + <p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p> + <p>If used for an <type>XYDiagram</type>, the row number 0 represents the <i>x</i>-values.</p> */ diff --git a/offapi/com/sun/star/chart/XChartDocument.idl b/offapi/com/sun/star/chart/XChartDocument.idl index ecaf8da04875..313373652a69 100644 --- a/offapi/com/sun/star/chart/XChartDocument.idl +++ b/offapi/com/sun/star/chart/XChartDocument.idl @@ -139,20 +139,38 @@ published interface XChartDocument: com::sun::star::frame::XModel //------------------------------------------------------------------------- /** @returns - the data source of the chart. + the data of the chart. - @see ChartData + <p>The returned object supports interface <type>XChartDataArray</type> + which can be used to access the concrete data.</p> + + <p>Since OOo 3.3 the returned object also supports interface <type>XComplexDescriptionAccess</type> + which can be used to access complex hierarchical axis descriptions.</p> + + @see XChartData + @see XChartDataArray + @see XComplexDescriptionAccess */ com::sun::star::chart::XChartData getData(); //------------------------------------------------------------------------- - /** attaches an external data source to the chart. + /** attaches data to the chart. + + <p>The given object needs to support interface <type>XChartDataArray</type>.</p> + + <p>Since OOo 3.3 if the given object might support interface <type>XComplexDescriptionAccess</type> + which allows to set complex hierarchical axis descriptions.</p> + + <p>The given data is copied before it is applied to the chart. + So changing xData after this call will have no effect on the chart.</p> - @see ChartData + @see XChartData + @see XChartDataArray + @see XComplexDescriptionAccess @param xData - the component that provides the new data. + the object that provides the new data. */ void attachData( [in] com::sun::star::chart::XChartData xData ); diff --git a/offapi/com/sun/star/chart/XComplexDescriptionAccess.idl b/offapi/com/sun/star/chart/XComplexDescriptionAccess.idl index f7efc0934751..51b625aa62d6 100755 --- a/offapi/com/sun/star/chart/XComplexDescriptionAccess.idl +++ b/offapi/com/sun/star/chart/XComplexDescriptionAccess.idl @@ -40,8 +40,13 @@ //============================================================================= -/** gives access to complex column and row descriptions. - */ +/** Offers access to complex column and row descriptions. + +<p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p> + +@since OOo 3.3 +*/ + published interface XComplexDescriptionAccess : XChartDataArray { //------------------------------------------------------------------------- |