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