xref: /trunk/main/offapi/com/sun/star/chart/ChartTableAddressSupplier.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_chart_ChartTableAddressSupplier_idl__
28#define __com_sun_star_chart_ChartTableAddressSupplier_idl__
29
30#ifndef __com_sun_star_chart_ChartSeriesAddress_idl__
31#include <com/sun/star/chart/ChartSeriesAddress.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module chart {
37
38//=============================================================================
39/** This is a helper service for access to table Address to
40    cell ranges of the container document of a chart.
41
42    The cell addresses are in the format of the application that
43    contains this chart.
44*/
45published service ChartTableAddressSupplier
46{
47    //-------------------------------------------------------------------------
48    /** contains the address to the cells containing
49        the names of the categories.
50
51        Note: Each value of a data series belongs exactly to one category.
52    */
53    [property] string CategoriesRangeAddress;
54
55    //-------------------------------------------------------------------------
56    /** contains the addresses to the elements of a series.
57        This sequence should contain one element for each series in the chart.
58
59        @see ChartSeriesAddress
60    */
61    [property] sequence< com::sun::star::chart::ChartSeriesAddress > SeriesAddresses;
62
63    //-------------------------------------------------------------------------
64    /** contains the address to the main title.
65    */
66    [optional, property] string MainTitleAddress;
67
68    //-------------------------------------------------------------------------
69    /** contains the address to the sub title.
70
71    <!-- Dennis: Does "Address" have a capital "A" or lowercase? -->
72    <!-- JRH: changed to lowercase, consistent with the others -->*/
73    [optional, property] string SubTitleAddress;
74};
75
76//=============================================================================
77
78}; }; }; };
79
80#endif
81