offapi/com/sun/star/chart2/data/XDataSource.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: XDataSource.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_XDataSource_idl
  31 #define com_sun_star_chart2_data_XDataSource_idl
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34
  35 #include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
  36
  37 module com
  38 {
  39 module sun
  40 {
  41 module star
  42 {
  43 module chart2
  44 {
  45 module data
  46 {
  47
  48
  49 /** provides access to sequences of data.  With this interface data
  50     can only be read from.
  51
  52     <p>If the data stored consists only of floating point numbers (double
  53     values), the returned instances should also support the service
  54     <type>NumericalDataSequence</type>.</p>
  55
  56     <p>If the data stored consists only of strings, the returned
  57     instances should also support the service
  58     <type>TextualDataSequence</type>.</p>
  59   */
  60 interface XDataSource  : ::com::sun::star::uno::XInterface
  61 // : ::com::sun::star::container::XIndexAccess
  62 {
  63     /** returns data sequences.
  64
  65         @return a sequence of objects that support at least the
  66                 service <type>DataSequence</type>.
  67
  68         <p>If the data stored consist only of floating point numbers
  69         (double values), the returned instances should also support
  70         the service <type>NumericalDataSequence</type>.</p>
  71
  72         <p>If the data stored consist only of strings, the returned
  73         instances should also support the service
  74         <type>TextualDataSequence</type>.</p>
  75      */
  76     sequence< XLabeledDataSequence >  getDataSequences();
  77 };
  78
  79 } ; // data
  80 } ; // chart2
  81 } ; // com
  82 } ; // sun
  83 } ; // star
  84
  85
  86 #endif