offapi/com/sun/star/chart2/data/HighlightedRange.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_data_HighlightedRange_idl
  20 #define com_sun_star_chart2_data_HighlightedRange_idl
  21
  22 module com
  23 {
  24 module sun
  25 {
  26 module star
  27 {
  28 module chart2
  29 {
  30 module data
  31 {
  32
  33 /**
  34  */
  35 struct HighlightedRange
  36 {
  37     /** The range representation string of the highlighted range.
  38      */
  39     string    RangeRepresentation;
  40
  41     /** Only take the cell at position Index out of the given
  42         Range. If this value is -1 take the whole sequence.
  43      */
  44     long      Index;
  45
  46     /** Use this color for marking the range.  This color may be
  47         ignored and replaced by a better fitting color, if it would be
  48         otherwise not well visible.
  49      */
  50     long      PreferredColor;
  51
  52     /** If the highlighted range is visually highlighted and this
  53         member is `TRUE`, the range given in
  54         #RangeRepresentation may be included in a
  55         merged range rectangle spanning a bigger range.
  56      */
  57     boolean   AllowMerginigWithOtherRanges;
  58 };
  59
  60 } ; // data
  61 } ; // chart2
  62 } ; // com
  63 } ; // sun
  64 } ; // star
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */