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

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