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
  20 module com
  21 {
  22 module sun
  23 {
  24 module star
  25 {
  26 module chart2
  27 {
  28 module data
  29 {
  30
  31 interface XDataReceiver : ::com::sun::star::uno::XInterface
  32 {
  33     /** attaches a component that provides data for the document.
  34
  35         <p>The previously set data provider will be released.</p>
  36
  37         @param xProvider
  38               The new DataProvider.  If it is an empty reference, the
  39               ChartDocument will have no data.
  40      */
  41     void attachDataProvider( [in] XDataProvider xProvider );
  42
  43     void setArguments( [in] sequence< com::sun::star::beans::PropertyValue > aArguments )
  44         raises( com::sun::star::lang::IllegalArgumentException );
  45
  46     /** returns a list of all range strings for which data has been
  47         requested by the most recently attached data provider, and
  48         which is still used.
  49
  50         <p>This list may be used by the data provider to swap charts
  51         out of memory, but still get informed by changes of ranges
  52         while the chart is not loaded.</p>
  53         @return a list of used range strings.
  54      */
  55     sequence< string > getUsedRangeRepresentations();
  56
  57     /** Returns the data requested by the most recently attached data
  58         provider, that is still used.
  59      */
  60     XDataSource getUsedData();
  61
  62     /** attaches an XNumberFormatsSupplier to this
  63         XDataReceiver.
  64
  65         <p>The given number formats will be used for display purposes.</p>
  66      */
  67     void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
  68
  69     /** Returns a component at which a view representing the data of
  70         the attached data provider may listen for highlighting the
  71         data ranges used by the currently selected objects in the data
  72         receiver component.
  73
  74         <p>This is typically used by a spreadsheet to highlight the
  75         ranges used by the currently selected object in a chart.</p>
  76
  77         <p>The range highlighter is optional, i.e., this method may
  78         return an empty object.</p>
  79      */
  80     XRangeHighlighter getRangeHighlighter();
  81
  82     /** A callback object to execute a foreign popup menu window.
  83
  84         @since LibreOffice 5.4
  85     */
  86     com::sun::star::awt::XRequestCallback getPopupRequest();
  87 };
  88
  89 } ; // data
  90 } ; // chart2
  91 } ; // com
  92 } ; // sun
  93 } ; // star
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */