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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef com_sun_star_chart2_XColorScheme_idl
  28 #define com_sun_star_chart2_XColorScheme_idl
  29
  30 #include <com/sun/star/uno/XInterface.idl>
  31 #include <com/sun/star/util/Color.idl>
  32
  33 module com
  34 {
  35 module sun
  36 {
  37 module star
  38 {
  39 module chart2
  40 {
  41
  42 interface XColorScheme : ::com::sun::star::uno::XInterface
  43 {
  44     /** returns the default color for the nth data series.
  45
  46         <p>This may be a system wide color or a color coming from a
  47         color scheme.</p>
  48
  49         <p>Usually there exist a fixed number of default colors.  This
  50         method should always return a valid Color.  If the index (i)
  51         is higher than the number of default colors (n), the method
  52         should return the modulus (i mod n), i.e., the colors should
  53         repeat in a cyclic way.</p>
  54
  55         @param nIndex
  56             The index of the series.  This is used to obtain the
  57             correct default color.
  58      */
  59     ::com::sun::star::util::Color  getColorByIndex( [in] long nIndex );
  60 };
  61
  62 } ; // chart2
  63 } ; // com
  64 } ; // sun
  65 } ; // star
  66
  67 #endif