offapi/com/sun/star/chart/ChartLegendPosition.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: ChartLegendPosition.idl,v $
  10  * $Revision: 1.10 $
  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_ChartLegendPosition_idl__
  31 #define __com_sun_star_chart_ChartLegendPosition_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module chart {
  37
  38 //=============================================================================
  39
  40 /** specifies one of the default positions of the legend in relation
  41     to the diagram.
  42  */
  43 published enum ChartLegendPosition
  44 {
  45     //-------------------------------------------------------------------------
  46
  47     /** no chart legend is displayed.
  48
  49         <p>To disable the legend you should set the property
  50         <member>ChartDocument::HasLegend</member> to <FALSE/> instead
  51         of setting this value.</p>
  52      */
  53     NONE,
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** displays the chart legend on the left side of the diagram.
  58
  59         <p>The second entry in the legend is placed below the first
  60         one.</p>
  61      */
  62     LEFT,
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** displays the chart legend above the diagram.
  67
  68         <p>The second entry in the legend is placed an the right hand
  69         side of the first one.</p>
  70      */
  71     TOP,
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** displays the chart legend on the right side of the diagram.
  76
  77         <p>The second entry in the legend is placed below the first
  78         one.</p>
  79      */
  80     RIGHT,
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** displays the chart legend beneath the diagram.
  85
  86         <p>The second entry in the legend is placed an the right hand
  87         side of the first one.</p>
  88      */
  89     BOTTOM
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif