/*************************************************************************
 *
 * 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_chart2_XColorScheme_idl
#define com_sun_star_chart2_XColorScheme_idl

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/util/Color.idl>

module com
{
module sun
{
module star
{
module chart2
{

interface XColorScheme : ::com::sun::star::uno::XInterface
{
    /** returns the default color for the nth data series.

        <p>This may be a system wide color or a color coming from a
        color scheme.</p>

        <p>Usually there exist a fixed number of default colors.  This
        method should always return a valid Color.  If the index (i)
        is higher than the number of default colors (n), the method
        should return the modulus (i mod n), i.e., the colors should
        repeat in a cyclic way.</p>

        @param nIndex
            The index of the series.  This is used to obtain the
            correct default color.
     */
    ::com::sun::star::util::Color  getColorByIndex( [in] long nIndex );
};

} ; // chart2
} ; // com
} ; // sun
} ; // star

#endif
