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