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