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

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