offapi/com/sun/star/chart2/Legend.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 module com
  21 {
  22 module sun
  23 {
  24 module star
  25 {
  26 module chart2
  27 {
  28
  29 /** Describes a legend for a Diagram.
  30  */
  31 service Legend
  32 {
  33     service                ::com::sun::star::drawing::FillProperties;
  34     service                ::com::sun::star::drawing::LineProperties;
  35     service                ::com::sun::star::beans::PropertySet;
  36
  37     /** The interface for registering and removing legend entries.
  38      */
  39     interface ::com::sun::star::chart2::XLegend;
  40
  41     /** Provides an automated position
  42      */
  43     [property] LegendPosition AnchorPosition;
  44
  45     /** Determines how the aspect ratio of the legend should roughly
  46         be.
  47
  48         <p>Set the Expansion to
  49         ::com::sun::star::chart#HIGH
  50         for a legend that is positioned on the right or left hand
  51         side.  Use ::com::sun::star::chart::WIDE for a legend
  52         that is positioned on top or the bottom.</p>
  53      */
  54     [property] ::com::sun::star::chart::ChartLegendExpansion Expansion;
  55
  56     /** Determines, whether the legend should be rendered by the view.
  57      */
  58     [property] boolean Show;
  59
  60     /** Determines, whether the legend should overlay the chart.
  61
  62         @since LibreOffice 7.0
  63      */
  64     [property] boolean Overlay;
  65
  66     /** contains the size of the page at the time when properties were
  67         set (e.g. the CharHeight).
  68
  69         <p>This way it is possible to resize objects (like text) in
  70         the view without modifying the model.</p>
  71      */
  72     [property, maybevoid]  com::sun::star::awt::Size   ReferencePageSize;
  73
  74     /** The position is as a relative position on the page.
  75
  76         <p>If a relative position is given the legend is not automatically placed,
  77         but instead is placed relative on the page.</p>
  78
  79         <p>If `VOID`, the legend position is solely determined by the
  80         #AnchorPosition.</p>
  81      */
  82     [property, maybevoid] ::com::sun::star::chart2::RelativePosition RelativePosition;
  83 };
  84
  85 } ; // chart2
  86 } ; // com
  87 } ; // sun
  88 } ; // star
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */