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
  20 module com
  21 {
  22 module sun
  23 {
  24 module star
  25 {
  26 module chart2
  27 {
  28
  29 interface XColorScheme : ::com::sun::star::uno::XInterface
  30 {
  31     /** returns the default color for the nth data series.
  32
  33         <p>This may be a system wide color or a color coming from a
  34         color scheme.</p>
  35
  36         <p>Usually there exist a fixed number of default colors.  This
  37         method should always return a valid Color.  If the index (i)
  38         is higher than the number of default colors (n), the method
  39         should return the modulus (i mod n), i.e., the colors should
  40         repeat in a cyclic way.</p>
  41
  42         @param nIndex
  43             The index of the series.  This is used to obtain the
  44             correct default color.
  45      */
  46     ::com::sun::star::util::Color  getColorByIndex( [in] long nIndex );
  47 };
  48
  49 } ; // chart2
  50 } ; // com
  51 } ; // sun
  52 } ; // star
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */