offapi/com/sun/star/chart2/Legend.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef com_sun_star_chart2_Legend_idl
  29 #define com_sun_star_chart2_Legend_idl
  30
  31 #include <com/sun/star/chart2/XLegend.idl>
  32 #include <com/sun/star/chart2/LegendPosition.idl>
  33 #include <com/sun/star/chart2/RelativePosition.idl>
  34 #include <com/sun/star/chart/ChartLegendExpansion.idl>
  35 #include <com/sun/star/beans/PropertySet.idl>
  36 #include <com/sun/star/drawing/LineProperties.idl>
  37 #include <com/sun/star/drawing/FillProperties.idl>
  38
  39 module com
  40 {
  41 module sun
  42 {
  43 module star
  44 {
  45 module chart2
  46 {
  47
  48 /** Describes a legend for a <type>Diagram</type>.
  49  */
  50 service Legend
  51 {
  52     service                ::com::sun::star::drawing::FillProperties;
  53     service                ::com::sun::star::drawing::LineProperties;
  54     service                ::com::sun::star::beans::PropertySet;
  55
  56     /** The interface for registering and removing legend entries.
  57      */
  58     interface ::com::sun::star::chart2::XLegend;
  59
  60     /** Provides an automated position
  61      */
  62     [property] LegendPosition AnchorPosition;
  63
  64     /** Determines how the aspect ratio of the legend should roughly
  65         be.
  66
  67         <p>Set the Expansion to <member>::com::sun::star::chart::ChartLegendExpansion::HIGH</member>
  68         for a legend that is positioned on the right or left hand
  69         side.  Use <member>LegendExpansion::WIDE</member> for a legend
  70         that is positioned on top or the bottom.</p>
  71      */
  72     [property] ::com::sun::star::chart::ChartLegendExpansion Expansion;
  73
  74     /** Determines, whether the legend should be rendered by the view.
  75      */
  76     [property] boolean Show;
  77
  78     /** contains the size of the page at the time when properties were
  79         set (e.g. the CharHeight).
  80
  81         <p>This way it is possible to resize objects (like text) in
  82         the view without modifying the model.</p>
  83      */
  84     [property, maybevoid]  com::sun::star::awt::Size   ReferencePageSize;
  85
  86     /** The position is as a relative position on the page.
  87
  88         <p>If a relative position is given the legend is not automatically placed,
  89         but instead is placed relative on the page.</p>
  90
  91         <p>If <void/>, the legend position is solely determined by the
  92         <member>AnchorPosition</member>.</p>
  93      */
  94     [property, maybevoid] ::com::sun::star::chart2::RelativePosition RelativePosition;
  95 };
  96
  97 } ; // chart2
  98 } ; // com
  99 } ; // sun
 100 } ; // star
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */