AOO410/main/offapi/com/sun/star/chart2/XColorScheme.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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