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