xref: /trunk/main/offapi/com/sun/star/chart2/Legend.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef com_sun_star_chart2_Legend_idl
24cdf0e10cSrcweir#define com_sun_star_chart2_Legend_idl
25cdf0e10cSrcweir
26cdf0e10cSrcweir#include <com/sun/star/chart2/XLegend.idl>
27cdf0e10cSrcweir#include <com/sun/star/chart2/LegendPosition.idl>
28cdf0e10cSrcweir#include <com/sun/star/chart/ChartLegendExpansion.idl>
29cdf0e10cSrcweir
30cdf0e10cSrcweir#include <com/sun/star/beans/PropertySet.idl>
31cdf0e10cSrcweir#include <com/sun/star/drawing/LineProperties.idl>
32cdf0e10cSrcweir#include <com/sun/star/drawing/FillProperties.idl>
33cdf0e10cSrcweir
34cdf0e10cSrcweirmodule com
35cdf0e10cSrcweir{
36cdf0e10cSrcweirmodule sun
37cdf0e10cSrcweir{
38cdf0e10cSrcweirmodule star
39cdf0e10cSrcweir{
40cdf0e10cSrcweirmodule chart2
41cdf0e10cSrcweir{
42cdf0e10cSrcweir
43cdf0e10cSrcweir/** Describes a legend for a <type>Diagram</type>.
44cdf0e10cSrcweir */
45cdf0e10cSrcweirservice Legend
46cdf0e10cSrcweir{
47cdf0e10cSrcweir    service                ::com::sun::star::drawing::FillProperties;
48cdf0e10cSrcweir    service                ::com::sun::star::drawing::LineProperties;
49cdf0e10cSrcweir    service                ::com::sun::star::beans::PropertySet;
50cdf0e10cSrcweir
51cdf0e10cSrcweir    /** The interface for registering and removing legend entries.
52cdf0e10cSrcweir     */
53cdf0e10cSrcweir    interface ::com::sun::star::chart2::XLegend;
54cdf0e10cSrcweir
55cdf0e10cSrcweir    /** Provides an automated position
56cdf0e10cSrcweir     */
57cdf0e10cSrcweir    [property] LegendPosition AnchorPosition;
58cdf0e10cSrcweir
59cdf0e10cSrcweir    /** Determines how the aspect ratio of the legend should roughly
60cdf0e10cSrcweir        be.
61cdf0e10cSrcweir
62cdf0e10cSrcweir        <p>Set the Expansion to <member>::com::sun::star::chart::ChartLegendExpansion::HIGH</member>
63cdf0e10cSrcweir        for a legend that is positioned on the right or left hand
64cdf0e10cSrcweir        side.  Use <member>LegendExpansion::WIDE</member> for a legend
65cdf0e10cSrcweir        that is positioned on top or the bottom.</p>
66cdf0e10cSrcweir     */
67cdf0e10cSrcweir    [property] ::com::sun::star::chart::ChartLegendExpansion Expansion;
68cdf0e10cSrcweir
69cdf0e10cSrcweir    /** Determines, whether the legend should be redered by the view.
70cdf0e10cSrcweir     */
71cdf0e10cSrcweir    [property] boolean Show;
72cdf0e10cSrcweir
73cdf0e10cSrcweir    /** contains the size of the page at the time when properties were
74cdf0e10cSrcweir        set (e.g. the CharHeight).
75cdf0e10cSrcweir
76cdf0e10cSrcweir        <p>This way it is possible to resize objects (like text) in
77cdf0e10cSrcweir        the view without modifying the model.</p>
78cdf0e10cSrcweir     */
79cdf0e10cSrcweir    [property, maybevoid]  com::sun::star::awt::Size   ReferencePageSize;
80cdf0e10cSrcweir
81cdf0e10cSrcweir    /** The position is as a relative position on the page.
82cdf0e10cSrcweir
83cdf0e10cSrcweir        <p>If a relative position is given the legend is not automatically placed,
84cdf0e10cSrcweir        but instead is placed relative on the page.</p>
85cdf0e10cSrcweir
86cdf0e10cSrcweir        <p>If <void/>, the legend position is solely determined by the
87cdf0e10cSrcweir        <member>AnchorPosition</member>.</p>
88cdf0e10cSrcweir     */
89cdf0e10cSrcweir    [property, maybevoid] ::com::sun::star::chart2::RelativePosition RelativePosition;
90cdf0e10cSrcweir};
91cdf0e10cSrcweir
92cdf0e10cSrcweir} ; // chart2
93cdf0e10cSrcweir} ; // com
94cdf0e10cSrcweir} ; // sun
95cdf0e10cSrcweir} ; // star
96cdf0e10cSrcweir
97cdf0e10cSrcweir#endif
98