xref: /AOO41X/main/offapi/com/sun/star/chart2/data/XDataReceiver.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_chart2_data_XDataReceiver_idl
28#define com_sun_star_chart2_data_XDataReceiver_idl
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
34#include <com/sun/star/lang/IllegalArgumentException.idl>
35#endif
36
37#ifndef com_sun_star_chart2_data_XDataProvider_idl
38#include <com/sun/star/chart2/data/XDataProvider.idl>
39#endif
40
41#ifndef com_sun_star_chart2_data_XRangeHighlighter_idl
42#include <com/sun/star/chart2/data/XRangeHighlighter.idl>
43#endif
44
45#ifndef com_sun_star_beans_PropertyValue_idl
46#include <com/sun/star/beans/PropertyValue.idl>
47#endif
48
49#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
50#include <com/sun/star/util/XNumberFormatsSupplier.idl>
51#endif
52
53module com
54{
55module sun
56{
57module star
58{
59module chart2
60{
61module data
62{
63
64interface XDataReceiver : ::com::sun::star::uno::XInterface
65{
66    /** attaches a component that provides data for the document.
67
68        <p>The previously set data provider will be released.</p>
69
70        @param xProvider
71              The new DataProvider.  If it is an empty reference, the
72              ChartDocument will have no data.
73     */
74    void attachDataProvider( [in] XDataProvider xProvider );
75
76    void setArguments( [in] sequence< com::sun::star::beans::PropertyValue > aArguments )
77        raises( com::sun::star::lang::IllegalArgumentException );
78
79    /** returns a list of all range strings for which data has been
80        requested by the most recently attached data provider, and
81        which is still used.
82
83        <p>This list may be used by the data provider to swap charts
84        out of memory, but still get informed by changes of ranges
85        while the chart is not loaded.</p>
86        @return a list of used range strings.
87     */
88    sequence< string > getUsedRangeRepresentations();
89
90    /** Returns the data requested by the most recently attached data
91        provider, that is still used.
92     */
93    XDataSource getUsedData();
94
95    /** attaches an <type>XNumberFormatsSupplier</type> to this
96		<type>XDataReceiver</type>.
97
98		<p>The given number formats will be used for display purposes.</p>
99	 */
100    void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
101
102    /** Returns a component at which a view representing the data of
103        the attached data provider may listen for highlighting the
104        data ranges used by the currently selected objects in the data
105        receiver component.
106
107        <p>This is typically used by a spreadsheet to hightlight the
108        ranges used by the currently selected object in a chart.</p>
109
110        <p>The range hightlighter is optional, i.e., this method may
111        return an empty object.</p>
112     */
113    XRangeHighlighter getRangeHighlighter();
114};
115
116} ; // data
117} ; // chart2
118} ; // com
119} ; // sun
120} ; // star
121
122#endif
123