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