offapi/com/sun/star/chart2/XDataSeries.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef com_sun_star_chart2_XDataSeries_idl
  20 #define com_sun_star_chart2_XDataSeries_idl
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  25
  26 module com
  27 {
  28 module sun
  29 {
  30 module star
  31 {
  32 module chart2
  33 {
  34
  35 /** A data series represents the object that has all the knowledge to
  36     be rendered as a visual data series.
  37  */
  38 interface XDataSeries : ::com::sun::star::uno::XInterface
  39 {
  40     /** @returns
  41             the element at the specified index.
  42
  43         @param nIndex
  44             specifies the index of the data point within the series. The first index is 0.
  45
  46         @throws com::sun::star::lang::IndexOutOfBoundException
  47             if the index is not valid.
  48      */
  49     ::com::sun::star::beans::XPropertySet getDataPointByIndex( [in] long nIndex )
  50         raises( ::com::sun::star::lang::IndexOutOfBoundsException );
  51
  52     /** the formatting of the specified data point is cleared
  53
  54         @param nIndex
  55             specifies the index of the data point within the series. The first index is 0.
  56      */
  57     void resetDataPoint( [in] long nIndex );
  58
  59     /** all data point formatting are cleared
  60      */
  61     void resetAllDataPoints();
  62 };
  63
  64 } ; // chart2
  65 } ; // com
  66 } ; // sun
  67 } ; // star
  68
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */