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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef com_sun_star_chart2_XColorScheme_idl
  20 #define com_sun_star_chart2_XColorScheme_idl
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/util/Color.idl>
  24
  25 module com
  26 {
  27 module sun
  28 {
  29 module star
  30 {
  31 module chart2
  32 {
  33
  34 interface XColorScheme : ::com::sun::star::uno::XInterface
  35 {
  36     /** returns the default color for the nth data series.
  37
  38         <p>This may be a system wide color or a color coming from a
  39         color scheme.</p>
  40
  41         <p>Usually there exist a fixed number of default colors.  This
  42         method should always return a valid Color.  If the index (i)
  43         is higher than the number of default colors (n), the method
  44         should return the modulus (i mod n), i.e., the colors should
  45         repeat in a cyclic way.</p>
  46
  47         @param nIndex
  48             The index of the series.  This is used to obtain the
  49             correct default color.
  50      */
  51     ::com::sun::star::util::Color  getColorByIndex( [in] long nIndex );
  52 };
  53
  54 } ; // chart2
  55 } ; // com
  56 } ; // sun
  57 } ; // star
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */