offapi/com/sun/star/table/XTableCharts.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_table_XTableCharts_idl__
  29 #define __com_sun_star_table_XTableCharts_idl__
  30
  31 #ifndef __com_sun_star_container_XNameAccess_idl__
  32 #include <com/sun/star/container/XNameAccess.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_awt_Rectangle_idl__
  36 #include <com/sun/star/awt/Rectangle.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  40 #include <com/sun/star/table/CellRangeAddress.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module table {
  46
  47 //=============================================================================
  48
  49 /** provides methods to access charts via name and to insert and remove
  50     charts.
  51
  52     @see com::sun::star::table::TableCharts
  53  */
  54 published interface XTableCharts: com::sun::star::container::XNameAccess
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** creates a chart and adds it to the collection.
  59
  60         @param aName
  61             is the name of the chart. This name is used to reference the
  62             chart in the collection.
  63
  64         @param aRect
  65             contains the rectangular location of the chart within the table
  66             (in 1/100th mm).
  67
  68         @param aRanges
  69             all cell ranges containing the source data of the chart.
  70
  71         @param bColumnHeaders
  72             if set to <TRUE/>, the topmost row of the source data will be
  73             used to set labels for the category axis or the legend.
  74
  75         @param bRowHeaders
  76             if set to <TRUE/>, the leftmost column of the source data will
  77             be used to set labels for the category axis or the legend.
  78      */
  79     void addNewByName(
  80             [in] string aName,
  81             [in] com::sun::star::awt::Rectangle aRect,
  82             [in] sequence<com::sun::star::table::CellRangeAddress> aRanges,
  83             [in] boolean bColumnHeaders,
  84             [in] boolean bRowHeaders );
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** removes a chart from the collection.
  89
  90         @param aName
  91             is the name of the chart to remove.
  92      */
  93     void removeByName( [in] string aName );
  94
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif
 102