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
  20
  21
  22  module com {  module sun {  module star {  module chart {
  23
  24
  25 /** specifies one of the default positions of the legend in relation
  26     to the diagram.
  27  */
  28 published enum ChartLegendPosition
  29 {
  30
  31     /** no chart legend is displayed.
  32
  33         <p>To disable the legend you should set the property
  34         ChartDocument::HasLegend to `FALSE` instead
  35         of setting this value.</p>
  36      */
  37     NONE,
  38
  39
  40     /** displays the chart legend on the left side of the diagram.
  41
  42         <p>The second entry in the legend is placed below the first
  43         one.</p>
  44      */
  45     LEFT,
  46
  47
  48     /** displays the chart legend above the diagram.
  49
  50         <p>The second entry in the legend is placed on the right hand
  51         side of the first one.</p>
  52      */
  53     TOP,
  54
  55
  56     /** displays the chart legend on the right side of the diagram.
  57
  58         <p>The second entry in the legend is placed below the first
  59         one.</p>
  60      */
  61     RIGHT,
  62
  63
  64     /** displays the chart legend beneath the diagram.
  65
  66         <p>The second entry in the legend is placed on the right hand
  67         side of the first one.</p>
  68      */
  69     BOTTOM
  70 };
  71
  72
  73 }; }; }; };
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */