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