office-gobmx/offapi/com/sun/star/chart/ChartTableAddressSupplier.idl

/*************************************************************************
 *
 * 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_chart_ChartTableAddressSupplier_idl__
#define __com_sun_star_chart_ChartTableAddressSupplier_idl__

#ifndef __com_sun_star_chart_ChartSeriesAddress_idl__
#include <com/sun/star/chart/ChartSeriesAddress.idl>
#endif

//=============================================================================

module com { module sun { module star { module chart {

//=============================================================================
/** This is a helper service for access to table Address to
    cell ranges of the container document of a chart.

    The cell addresses are in the format of the application that
    contains this chart.
*/
published service ChartTableAddressSupplier
{
    //-------------------------------------------------------------------------
    /** contains the address to the cells containing
        the names of the categories.

        Note: Each value of a data series belongs exactly to one category.
    */
    [property] string CategoriesRangeAddress;

    //-------------------------------------------------------------------------
    /** contains the addresses to the elements of a series.
        This sequence should contain one element for each series in the chart.

        @see ChartSeriesAddress
    */
    [property] sequence< com::sun::star::chart::ChartSeriesAddress > SeriesAddresses;

    //-------------------------------------------------------------------------
    /** contains the address to the main title.
    */
    [optional, property] string MainTitleAddress;

    //-------------------------------------------------------------------------
    /** contains the address to the sub title.

    <!-- Dennis: Does "Address" have a capital "A" or lowercase? -->
    <!-- JRH: changed to lowercase, consistent with the others -->*/
    [optional, property] string SubTitleAddress;
};

//=============================================================================

}; }; }; };

#endif