offapi/com/sun/star/chart/XDiagram.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_chart_XDiagram_idl__
  20 #define __com_sun_star_chart_XDiagram_idl__
  21
  22 #include <com/sun/star/drawing/XShape.idl>
  23
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25
  26 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  27
  28
  29  module com {  module sun {  module star {  module chart {
  30
  31
  32 /** manages the diagram of the chart document.
  33
  34     @see XChartDocument
  35  */
  36 published interface XDiagram: com::sun::star::drawing::XShape
  37 {
  38
  39     /** @returns
  40             a string representing the diagram type. This string
  41             contains the fully qualified name of the corresponding
  42             service.
  43      */
  44     string getDiagramType();
  45
  46
  47     /** @returns
  48             the properties of the specified data row (series).
  49
  50         @param nRow
  51             the index of the series (0-based)
  52
  53         @see ChartDataRowProperties
  54      */
  55     com::sun::star::beans::XPropertySet getDataRowProperties( [in] long nRow )
  56         raises( com::sun::star::lang::IndexOutOfBoundsException );
  57
  58
  59     /** @returns
  60             the properties of the specified data point.
  61
  62         @param nCol
  63             the index of the data point of a series (0-based).
  64         @param nRow
  65             the index of a series (0-based).
  66
  67         @see ChartDataPointProperties
  68      */
  69     com::sun::star::beans::XPropertySet getDataPointProperties( [in] long nCol,
  70                                                                 [in] long nRow )
  71         raises( com::sun::star::lang::IndexOutOfBoundsException );
  72
  73 };
  74
  75
  76 }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */