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