offapi/com/sun/star/chart/XDiagram.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: XDiagram.idl,v $
  10  * $Revision: 1.12 $
  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_chart_XDiagram_idl__
  31 #define __com_sun_star_chart_XDiagram_idl__
  32
  33 #ifndef __com_sun_star_drawing_XShape_idl__
  34 #include <com/sun/star/drawing/XShape.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  42 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module chart {
  48
  49 //=============================================================================
  50
  51 /** manages the diagram of the chart document.
  52
  53     @see XChartDocument
  54  */
  55 published interface XDiagram: com::sun::star::drawing::XShape
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** @returns
  60             a string representing the diagram type. This string
  61             contains the fully qualified name of the corresponding
  62             service.
  63      */
  64     string getDiagramType();
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** @returns
  69             the properties of the specified data row (series).
  70
  71         @param nRow
  72             the index of the series (0-based)
  73
  74         @see ChartDataRowProperties
  75      */
  76     com::sun::star::beans::XPropertySet getDataRowProperties( [in] long nRow )
  77         raises( com::sun::star::lang::IndexOutOfBoundsException );
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** @returns
  82             the properties of the specified data point.
  83
  84         @param nCol
  85             the index of the data point of a series (0-based).
  86         @param nRow
  87             the index of a series (0-based).
  88
  89         @see ChartDataPointProperties
  90      */
  91     com::sun::star::beans::XPropertySet getDataPointProperties( [in] long nCol,
  92                                                                 [in] long nRow )
  93         raises( com::sun::star::lang::IndexOutOfBoundsException );
  94
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif