xref: /AOO41X/main/offapi/com/sun/star/table/XTableCharts.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_table_XTableCharts_idl__
25#define __com_sun_star_table_XTableCharts_idl__
26
27#ifndef __com_sun_star_container_XNameAccess_idl__
28#include <com/sun/star/container/XNameAccess.idl>
29#endif
30
31#ifndef __com_sun_star_awt_Rectangle_idl__
32#include <com/sun/star/awt/Rectangle.idl>
33#endif
34
35#ifndef __com_sun_star_table_CellRangeAddress_idl__
36#include <com/sun/star/table/CellRangeAddress.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module table {
42
43//=============================================================================
44
45/** provides methods to access charts via name and to insert and remove
46    charts.
47
48    @see com::sun::star::table::TableCharts
49 */
50published interface XTableCharts: com::sun::star::container::XNameAccess
51{
52    //-------------------------------------------------------------------------
53
54    /** creates a chart and adds it to the collection.
55
56        @param aName
57            is the name of the chart. This name is used to reference the
58            chart in the collection.
59
60        @param aRect
61            contains the rectangular location of the chart within the table
62            (in 1/100th mm).
63
64        @param aRanges
65            all cell ranges containing the source data of the chart.
66
67        @param bColumnHeaders
68            if set to <TRUE/>, the topmost row of the source data will be
69            used to set labels for the category axis or the legend.
70
71        @param bRowHeaders
72            if set to <TRUE/>, the leftmost column of the source data will
73            be used to set labels for the category axis or the legend.
74     */
75    void addNewByName(
76            [in] string aName,
77            [in] com::sun::star::awt::Rectangle aRect,
78            [in] sequence<com::sun::star::table::CellRangeAddress> aRanges,
79            [in] boolean bColumnHeaders,
80            [in] boolean bRowHeaders );
81
82    //-------------------------------------------------------------------------
83
84    /** removes a chart from the collection.
85
86        @param aName
87            is the name of the chart to remove.
88     */
89    void removeByName( [in] string aName );
90
91};
92
93//=============================================================================
94
95}; }; }; };
96
97#endif
98
99