office-gobmx/offapi/com/sun/star/table/XTableCharts.idl

102 lines
3.4 KiB
Text

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_table_XTableCharts_idl__
#define __com_sun_star_table_XTableCharts_idl__
#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif
#ifndef __com_sun_star_awt_Rectangle_idl__
#include <com/sun/star/awt/Rectangle.idl>
#endif
#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif
//=============================================================================
module com { module sun { module star { module table {
//=============================================================================
/** provides methods to access charts via name and to insert and remove
charts.
@see com::sun::star::table::TableCharts
*/
published interface XTableCharts: com::sun::star::container::XNameAccess
{
//-------------------------------------------------------------------------
/** creates a chart and adds it to the collection.
@param aName
is the name of the chart. This name is used to reference the
chart in the collection.
@param aRect
contains the rectangular location of the chart within the table
(in 1/100th mm).
@param aRanges
all cell ranges containing the source data of the chart.
@param bColumnHeaders
if set to <TRUE/>, the topmost row of the source data will be
used to set labels for the category axis or the legend.
@param bRowHeaders
if set to <TRUE/>, the leftmost column of the source data will
be used to set labels for the category axis or the legend.
*/
void addNewByName(
[in] string aName,
[in] com::sun::star::awt::Rectangle aRect,
[in] sequence<com::sun::star::table::CellRangeAddress> aRanges,
[in] boolean bColumnHeaders,
[in] boolean bRowHeaders );
//-------------------------------------------------------------------------
/** removes a chart from the collection.
@param aName
is the name of the chart to remove.
*/
void removeByName( [in] string aName );
};
//=============================================================================
}; }; }; };
#endif