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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef com_sun_star_chart2_data_XDataReceiver_idl
  29 #define com_sun_star_chart2_data_XDataReceiver_idl
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/lang/IllegalArgumentException.idl>
  33 #include <com/sun/star/chart2/data/XDataProvider.idl>
  34 #include <com/sun/star/chart2/data/XRangeHighlighter.idl>
  35 #include <com/sun/star/beans/PropertyValue.idl>
  36 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  37
  38 module com
  39 {
  40 module sun
  41 {
  42 module star
  43 {
  44 module chart2
  45 {
  46 module data
  47 {
  48
  49 interface XDataReceiver : ::com::sun::star::uno::XInterface
  50 {
  51     /** attaches a component that provides data for the document.
  52
  53         <p>The previously set data provider will be released.</p>
  54
  55         @param xProvider
  56               The new DataProvider.  If it is an empty reference, the
  57               ChartDocument will have no data.
  58      */
  59     void attachDataProvider( [in] XDataProvider xProvider );
  60
  61     void setArguments( [in] sequence< com::sun::star::beans::PropertyValue > aArguments )
  62         raises( com::sun::star::lang::IllegalArgumentException );
  63
  64     /** returns a list of all range strings for which data has been
  65         requested by the most recently attached data provider, and
  66         which is still used.
  67
  68         <p>This list may be used by the data provider to swap charts
  69         out of memory, but still get informed by changes of ranges
  70         while the chart is not loaded.</p>
  71         @return a list of used range strings.
  72      */
  73     sequence< string > getUsedRangeRepresentations();
  74
  75     /** Returns the data requested by the most recently attached data
  76         provider, that is still used.
  77      */
  78     XDataSource getUsedData();
  79
  80     /** attaches an <type>XNumberFormatsSupplier</type> to this
  81         <type>XDataReceiver</type>.
  82
  83         <p>The given number formats will be used for display purposes.</p>
  84      */
  85     void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
  86
  87     /** Returns a component at which a view representing the data of
  88         the attached data provider may listen for highlighting the
  89         data ranges used by the currently selected objects in the data
  90         receiver component.
  91
  92         <p>This is typically used by a spreadsheet to highlight the
  93         ranges used by the currently selected object in a chart.</p>
  94
  95         <p>The range highlighter is optional, i.e., this method may
  96         return an empty object.</p>
  97      */
  98     XRangeHighlighter getRangeHighlighter();
  99 };
 100
 101 } ; // data
 102 } ; // chart2
 103 } ; // com
 104 } ; // sun
 105 } ; // star
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */