offapi/com/sun/star/table/XTableCharts.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 table {
  22
  23
  24 /** provides methods to access charts via name and to insert and remove
  25     charts.
  26
  27     @see com::sun::star::table::TableCharts
  28  */
  29 published interface XTableCharts: com::sun::star::container::XNameAccess
  30 {
  31
  32     /** creates a chart and adds it to the collection.
  33
  34         @param aName
  35             is the name of the chart. This name is used to reference the
  36             chart in the collection.
  37
  38         @param aRect
  39             contains the rectangular location of the chart within the table
  40             (in 1/100th mm).
  41
  42         @param aRanges
  43             all cell ranges containing the source data of the chart.
  44
  45         @param bColumnHeaders
  46             if set to `TRUE`, the topmost row of the source data will be
  47             used to set labels for the category axis or the legend.
  48
  49         @param bRowHeaders
  50             if set to `TRUE`, the leftmost column of the source data will
  51             be used to set labels for the category axis or the legend.
  52      */
  53     void addNewByName(
  54             [in] string aName,
  55             [in] com::sun::star::awt::Rectangle aRect,
  56             [in] sequence<com::sun::star::table::CellRangeAddress> aRanges,
  57             [in] boolean bColumnHeaders,
  58             [in] boolean bRowHeaders );
  59
  60
  61     /** removes a chart from the collection.
  62
  63         @param aName
  64             is the name of the chart to remove.
  65      */
  66     void removeByName( [in] string aName );
  67
  68 };
  69
  70
  71 }; }; }; };
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */