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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef com_sun_star_chart2_data_XDataReceiver_idl
  20 #define com_sun_star_chart2_data_XDataReceiver_idl
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/chart2/data/XDataProvider.idl>
  25 #include <com/sun/star/chart2/data/XRangeHighlighter.idl>
  26 #include <com/sun/star/beans/PropertyValue.idl>
  27 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  28
  29 module com
  30 {
  31 module sun
  32 {
  33 module star
  34 {
  35 module chart2
  36 {
  37 module data
  38 {
  39
  40 interface XDataReceiver : ::com::sun::star::uno::XInterface
  41 {
  42     /** attaches a component that provides data for the document.
  43
  44         <p>The previously set data provider will be released.</p>
  45
  46         @param xProvider
  47               The new DataProvider.  If it is an empty reference, the
  48               ChartDocument will have no data.
  49      */
  50     void attachDataProvider( [in] XDataProvider xProvider );
  51
  52     void setArguments( [in] sequence< com::sun::star::beans::PropertyValue > aArguments )
  53         raises( com::sun::star::lang::IllegalArgumentException );
  54
  55     /** returns a list of all range strings for which data has been
  56         requested by the most recently attached data provider, and
  57         which is still used.
  58
  59         <p>This list may be used by the data provider to swap charts
  60         out of memory, but still get informed by changes of ranges
  61         while the chart is not loaded.</p>
  62         @return a list of used range strings.
  63      */
  64     sequence< string > getUsedRangeRepresentations();
  65
  66     /** Returns the data requested by the most recently attached data
  67         provider, that is still used.
  68      */
  69     XDataSource getUsedData();
  70
  71     /** attaches an XNumberFormatsSupplier to this
  72         XDataReceiver.
  73
  74         <p>The given number formats will be used for display purposes.</p>
  75      */
  76     void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
  77
  78     /** Returns a component at which a view representing the data of
  79         the attached data provider may listen for highlighting the
  80         data ranges used by the currently selected objects in the data
  81         receiver component.
  82
  83         <p>This is typically used by a spreadsheet to highlight the
  84         ranges used by the currently selected object in a chart.</p>
  85
  86         <p>The range highlighter is optional, i.e., this method may
  87         return an empty object.</p>
  88      */
  89     XRangeHighlighter getRangeHighlighter();
  90 };
  91
  92 } ; // data
  93 } ; // chart2
  94 } ; // com
  95 } ; // sun
  96 } ; // star
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */