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