offapi/com/sun/star/chart2/LegendSymbolStyle.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: LegendSymbolStyle.idl,v $
  10  * $Revision: 1.3 $
  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_chart_LegendSymbolStyle_idl
  31 #define com_sun_star_chart_LegendSymbolStyle_idl
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34
  35 #include <com/sun/star/chart2/XTitle.idl>
  36
  37 module com
  38 {
  39 module sun
  40 {
  41 module star
  42 {
  43 module chart2
  44 {
  45
  46 /**
  47  */
  48 enum LegendSymbolStyle
  49 {
  50     /** A square box with border.
  51      */
  52     BOX,
  53
  54     /** A rectangle that is wider than high with border.
  55      */
  56     BAR,
  57
  58     /** A square box with border, that may change its aspect ratio if
  59         the layout of the legend requires this.
  60      */
  61     RECTANGLE,
  62
  63     /** A filled rectangle with no border that uses all the space
  64         available for the legend entry's symbol, leaving no padding
  65         space.  This is especially useful for legends representing a
  66         color-scale.
  67      */
  68     STRETCHED_RECTANGLE,
  69
  70     /** A line extending from the left edge to the right edge
  71      */
  72     HORIZONTAL_LINE,
  73
  74     /** A line extending from the top edge to the bottom edge
  75      */
  76     VERTICAL_LINE,
  77
  78     /** A line spanning the diagonal of the box you would get with
  79         <member>BOX</member>.
  80      */
  81     DIAGONAL_LINE,
  82
  83     /** A line like with <member>LINE</member>, but with a small
  84         bordered square box in the middle.
  85      */
  86     LINE_WITH_BOX,
  87
  88     /** A line like with <member>LINE</member>, but with the symbol
  89         that is returned by <member>XLegendEntry::getSymbol</member>
  90         (see also <member>USER_DEFINED</member>).
  91      */
  92     LINE_WITH_SYMBOL,
  93
  94     /** A bordered circle which has the same bounding-box as the
  95         <member>BOX</member>.
  96      */
  97     CIRCLE,
  98
  99     /** Use the symbol that is returned by
 100         <member>XLegendEntry::getSymbol</member>.
 101     */
 102     USER_DEFINED
 103 };
 104
 105 } ; // chart2
 106 } ; // com
 107 } ; // sun
 108 } ; // star
 109
 110 #endif