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

   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_XDataSink_idl
  28 #define com_sun_star_chart2_data_XDataSink_idl
  29
  30 #include <com/sun/star/uno/XInterface.idl>
  31
  32 #include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
  33
  34 module com
  35 {
  36 module sun
  37 {
  38 module star
  39 {
  40 module chart2
  41 {
  42 module data
  43 {
  44
  45 /** is a container for sequences of data.  With this interface data
  46     can only be written to.
  47
  48     <p>If you want to be able to also read the data set here, your
  49     component must also implement <type>XDataSource</type>.</p>
  50   */
  51 interface XDataSink : ::com::sun::star::uno::XInterface
  52 {
  53     /** sets new data sequences.  The elements set here must support
  54         the service <type>DataSequence</type>.
  55
  56         <p>If the data consist only of floating point numbers (double
  57         values), the instances set here should also support the
  58         service <type>NumericalDataSequence</type>.</p>
  59
  60         <p>If the data consist only of strings, the instances set here
  61         should also support the service
  62         <type>TextualDataSequence</type>.</p>
  63
  64         <p>If one of the derived services is supported by one element
  65         of the sequence, it should be available for all elements in
  66         the sequence.</p>
  67      */
  68     void  setData( [in] sequence< XLabeledDataSequence > aData );
  69 };
  70
  71 } ; // data
  72 } ; // chart2
  73 } ; // com
  74 } ; // sun
  75 } ; // star
  76
  77
  78 #endif