offapi/com/sun/star/table/XTableCharts.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: XTableCharts.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
  31 #ifndef __com_sun_star_table_XTableCharts_idl__
  32 #define __com_sun_star_table_XTableCharts_idl__
  33
  34 #ifndef __com_sun_star_container_XNameAccess_idl__
  35 #include <com/sun/star/container/XNameAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_awt_Rectangle_idl__
  39 #include <com/sun/star/awt/Rectangle.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  43 #include <com/sun/star/table/CellRangeAddress.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module table {
  49
  50 //=============================================================================
  51
  52 /** provides methods to access charts via name and to insert and remove
  53     charts.
  54
  55     @see com::sun::star::table::TableCharts
  56  */
  57 published interface XTableCharts: com::sun::star::container::XNameAccess
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** creates a chart and adds it to the collection.
  62
  63         @param aName
  64             is the name of the chart. This name is used to reference the
  65             chart in the collection.
  66
  67         @param aRect
  68             contains the rectangular location of the chart within the table
  69             (in 1/100th mm).
  70
  71         @param aRanges
  72             all cell ranges containing the source data of the chart.
  73
  74         @param bColumnHeaders
  75             if set to <TRUE/>, the topmost row of the source data will be
  76             used to set labels for the category axis or the legend.
  77
  78         @param bRowHeaders
  79             if set to <TRUE/>, the leftmost column of the source data will
  80             be used to set labels for the category axis or the legend.
  81      */
  82     void addNewByName(
  83             [in] string aName,
  84             [in] com::sun::star::awt::Rectangle aRect,
  85             [in] sequence<com::sun::star::table::CellRangeAddress> aRanges,
  86             [in] boolean bColumnHeaders,
  87             [in] boolean bRowHeaders );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** removes a chart from the collection.
  92
  93         @param aName
  94             is the name of the chart to remove.
  95      */
  96     void removeByName( [in] string aName );
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif
 105