offapi/com/sun/star/chart/ChartTableAddressSupplier.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: ChartTableAddressSupplier.idl,v $
  10  * $Revision: 1.8 $
  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_ChartTableAddressSupplier_idl__
  31 #define __com_sun_star_chart_ChartTableAddressSupplier_idl__
  32
  33 #ifndef __com_sun_star_chart_ChartSeriesAddress_idl__
  34 #include <com/sun/star/chart/ChartSeriesAddress.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module chart {
  40
  41 //=============================================================================
  42 /** This is a helper service for access to table Address to
  43     cell ranges of the container document of a chart.
  44
  45     The cell addresses are in the format of the application that
  46     contains this chart.
  47 */
  48 published service ChartTableAddressSupplier
  49 {
  50     //-------------------------------------------------------------------------
  51     /** contains the address to the cells containing
  52         the names of the categories.
  53
  54         Note: Each value of a data series belongs exactly to one category.
  55     */
  56     [property] string CategoriesRangeAddress;
  57
  58     //-------------------------------------------------------------------------
  59     /** contains the addresses to the elements of a series.
  60         This sequence should contain one element for each series in the chart.
  61
  62         @see ChartSeriesAddress
  63     */
  64     [property] sequence< com::sun::star::chart::ChartSeriesAddress > SeriesAddresses;
  65
  66     //-------------------------------------------------------------------------
  67     /** contains the address to the main title.
  68     */
  69     [optional, property] string MainTitleAddress;
  70
  71     //-------------------------------------------------------------------------
  72     /** contains the address to the sub title.
  73
  74     <!-- Dennis: Does "Address" have a capital "A" or lowercase? -->
  75     <!-- JRH: changed to lowercase, consistent with the others -->*/
  76     [optional, property] string SubTitleAddress;
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif