offapi/com/sun/star/chart2/data/XDataReceiver.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDataReceiver.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef com_sun_star_chart2_data_XDataReceiver_idl
  31 #define com_sun_star_chart2_data_XDataReceiver_idl
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  37 #include <com/sun/star/lang/IllegalArgumentException.idl>
  38 #endif
  39
  40 #ifndef com_sun_star_chart2_data_XDataProvider_idl
  41 #include <com/sun/star/chart2/data/XDataProvider.idl>
  42 #endif
  43
  44 #ifndef com_sun_star_chart2_data_XRangeHighlighter_idl
  45 #include <com/sun/star/chart2/data/XRangeHighlighter.idl>
  46 #endif
  47
  48 #ifndef com_sun_star_beans_PropertyValue_idl
  49 #include <com/sun/star/beans/PropertyValue.idl>
  50 #endif
  51
  52 #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
  53 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  54 #endif
  55
  56 module com
  57 {
  58 module sun
  59 {
  60 module star
  61 {
  62 module chart2
  63 {
  64 module data
  65 {
  66
  67 interface XDataReceiver : ::com::sun::star::uno::XInterface
  68 {
  69     /** attaches a component that provides data for the document.
  70
  71         <p>The previously set data provider will be released.</p>
  72
  73         @param xProvider
  74               The new DataProvider.  If it is an empty reference, the
  75               ChartDocument will have no data.
  76      */
  77     void attachDataProvider( [in] XDataProvider xProvider );
  78
  79     /** Sets the data for the chart as a whole.  When this method is
  80         called, all currently set data is removed.  It is replaced by
  81         the data that is returned by the current
  82         <type>XDataProvider</type> by using the given range
  83         representation.
  84
  85         @param aRangeRepresentation
  86             This range representation must be in a format that is
  87             understood by the currently attached
  88             <type>XDataProvider</type>.
  89
  90         @throws com::sun::star::lang::IllegalArgumentException
  91             If the range representation could not dealt with by the
  92             current data provider, or there is currently no data
  93             provider at all.
  94      */
  95 //     void setRangeRepresentation( [in] string aRangeRepresentation )
  96 //         raises( com::sun::star::lang::IllegalArgumentException );
  97     void setArguments( [in] sequence< com::sun::star::beans::PropertyValue > aArguments )
  98         raises( com::sun::star::lang::IllegalArgumentException );
  99
 100     /** returns a list of all range strings for which data has been
 101         requested by the most recently attached data provider, and
 102         which is still used.
 103
 104         <p>This list may be used by the data provider to swap charts
 105         out of memory, but still get informed by changes of ranges
 106         while the chart is not loaded.</p>
 107         @return a list of used range strings.
 108      */
 109     sequence< string > getUsedRangeRepresentations();
 110
 111     /** Returns the data requested by the most recently attached data
 112         provider, that is still used.
 113      */
 114     XDataSource getUsedData();
 115
 116     /** attaches an <type>XNumberFormatsSupplier</type> to this
 117         <type>XDataReceiver</type>.
 118
 119         <p>The given number formats will be used for display purposes.</p>
 120      */
 121     void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
 122
 123     /** Returns a component at which a view representing the data of
 124         the attached data provider may listen for highlighting the
 125         data ranges used by the currently selected objects in the data
 126         receiver component.
 127
 128         <p>This is typically used by a spreadsheet to hightlight the
 129         ranges used by the currently selected object in a chart.</p>
 130
 131         <p>The range hightlighter is optional, i.e., this method may
 132         return an empty object.</p>
 133      */
 134     XRangeHighlighter getRangeHighlighter();
 135 };
 136
 137 } ; // data
 138 } ; // chart2
 139 } ; // com
 140 } ; // sun
 141 } ; // star
 142
 143 #endif