1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef com_sun_star_chart2_XColorScheme_idl
24#define com_sun_star_chart2_XColorScheme_idl
25
26#include <com/sun/star/uno/XInterface.idl>
27#include <com/sun/star/util/Color.idl>
28
29module com
30{
31module sun
32{
33module star
34{
35module chart2
36{
37
38interface XColorScheme : ::com::sun::star::uno::XInterface
39{
40    /** returns the default color for the nth data series.
41
42        <p>This may be a system wide color or a color coming from a
43        color scheme.</p>
44
45        <p>Usually there exist a fixed number of default colors.  This
46        method should always return a valid Color.  If the index (i)
47        is higher than the number of default colors (n), the method
48        should return the modulus (i mod n), i.e., the colors should
49        repeat in a cyclic way.</p>
50
51        @param nIndex
52            The index of the series.  This is used to obtain the
53            correct default color.
54     */
55    ::com::sun::star::util::Color  getColorByIndex( [in] long nIndex );
56};
57
58} ; // chart2
59} ; // com
60} ; // sun
61} ; // star
62
63#endif
64