offapi/com/sun/star/chart/ChartTableAddressSupplier.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
  20
  21 module com { module sun { module star { module chart {
  22
  23 /** This is a helper service for access to table Address to
  24     cell ranges of the container document of a chart.
  25
  26     The cell addresses are in the format of the application that
  27     contains this chart.
  28 */
  29 published service ChartTableAddressSupplier
  30 {
  31     /** contains the address to the cells containing
  32         the names of the categories.
  33
  34         Note: Each value of a data series belongs exactly to one category.
  35     */
  36     [property] string CategoriesRangeAddress;
  37
  38     /** contains the addresses to the elements of a series.
  39         This sequence should contain one element for each series in the chart.
  40
  41         @see ChartSeriesAddress
  42     */
  43     [property] sequence< com::sun::star::chart::ChartSeriesAddress > SeriesAddresses;
  44
  45     /** contains the address to the main title.
  46     */
  47     [optional, property] string MainTitleAddress;
  48
  49     /** contains the address to the sub title.
  50
  51     <!-- Dennis: Does "Address" have a capital "A" or lowercase? -->
  52     <!-- JRH: changed to lowercase, consistent with the others -->*/
  53     [optional, property] string SubTitleAddress;
  54 };
  55
  56
  57 }; }; }; };
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */