offapi/com/sun/star/chart/ChartLegendPosition.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_chart_ChartLegendPosition_idl__
  20 #define __com_sun_star_chart_ChartLegendPosition_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module chart {
  25
  26
  27 /** specifies one of the default positions of the legend in relation
  28     to the diagram.
  29  */
  30 published enum ChartLegendPosition
  31 {
  32
  33     /** no chart legend is displayed.
  34
  35         <p>To disable the legend you should set the property
  36         ChartDocument::HasLegend to `FALSE` instead
  37         of setting this value.</p>
  38      */
  39     NONE,
  40
  41
  42     /** displays the chart legend on the left side of the diagram.
  43
  44         <p>The second entry in the legend is placed below the first
  45         one.</p>
  46      */
  47     LEFT,
  48
  49
  50     /** displays the chart legend above the diagram.
  51
  52         <p>The second entry in the legend is placed on the right hand
  53         side of the first one.</p>
  54      */
  55     TOP,
  56
  57
  58     /** displays the chart legend on the right side of the diagram.
  59
  60         <p>The second entry in the legend is placed below the first
  61         one.</p>
  62      */
  63     RIGHT,
  64
  65
  66     /** displays the chart legend beneath the diagram.
  67
  68         <p>The second entry in the legend is placed on the right hand
  69         side of the first one.</p>
  70      */
  71     BOTTOM
  72 };
  73
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */