offapi/com/sun/star/chart2/XDataSeries.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: XDataSeries.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_XDataSeries_idl
  31 #define com_sun_star_chart2_XDataSeries_idl
  32
  33 // #include <com/sun/star/chart2/XCoordinateSystem.idl>
  34
  35 #ifndef __com_sun_star_beans_XPropertySet_idl__
  36 #include <com/sun/star/beans/XPropertySet.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_uno_XInterface_idl__
  40 #include <com/sun/star/uno/XInterface.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  44 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  45 #endif
  46
  47 module com
  48 {
  49 module sun
  50 {
  51 module star
  52 {
  53 module chart2
  54 {
  55
  56 /** A data series represents the object that has all the knowledge to
  57     be rendered as a visual data series.
  58  */
  59 interface XDataSeries : ::com::sun::star::uno::XInterface
  60 {
  61     /** set the coordinate system in which this series should be
  62         represented.
  63      */
  64 //     void setCoordinateSystem( [in] XCoordinateSystem aCoordSystem );
  65
  66     /** @returns
  67             the element at the specified index.
  68
  69         @param Index
  70             specifies the position in the array. The first index is 0.
  71
  72         @throws com::sun::star::lang::IndexOutOfBoundException
  73             if the index is not valid.
  74      */
  75     ::com::sun::star::beans::XPropertySet getDataPointByIndex( [in] long nIndex )
  76         raises( ::com::sun::star::lang::IndexOutOfBoundsException );
  77 };
  78
  79 } ; // chart2
  80 } ; // com
  81 } ; // sun
  82 } ; // star
  83
  84
  85 #endif