xref: /AOO41X/main/offapi/com/sun/star/chart/XAxisYSupplier.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_chart_XAxisYSupplier_idl__
28#define __com_sun_star_chart_XAxisYSupplier_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_XShape_idl__
35#include <com/sun/star/drawing/XShape.idl>
36#endif
37
38#ifndef __com_sun_star_beans_XPropertySet_idl__
39#include <com/sun/star/beans/XPropertySet.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module chart {
46
47//=============================================================================
48
49/** gives access to the <i>y</i>-axis of a chart.
50
51    <p>Note that not all diagrams are capable of displaying a
52    <i>y</i>-axis, e.g., the <type>PieDiagram</type>.</p>
53
54    @see XDiagram
55 */
56published interface XAxisYSupplier: com::sun::star::uno::XInterface
57{
58    //-------------------------------------------------------------------------
59
60    /** @returns
61            the <i>y</i>-axis title shape.
62
63        @see ChartTitle
64     */
65    com::sun::star::drawing::XShape getYAxisTitle();
66
67    //-------------------------------------------------------------------------
68
69    /** @returns
70            the properties of the <i>y</i>-axis of the diagram.
71
72        <p>The returned property set contains scaling properties as
73        well as formatting properties.</p>
74
75        @see ChartAxis
76     */
77    com::sun::star::beans::XPropertySet getYAxis();
78
79    //-------------------------------------------------------------------------
80
81    /** @returns
82            the properties of the help grid (minor grid) of the
83            <i>y</i>-axis of the diagram.
84
85        @see ChartGrid
86     */
87    com::sun::star::beans::XPropertySet getYHelpGrid();
88
89    //-------------------------------------------------------------------------
90
91    /** @returns
92            the properties of the main grid (major grid) of the
93            <i>y</i>-axis of the diagram.
94
95        @see ChartGrid
96     */
97    com::sun::star::beans::XPropertySet getYMainGrid();
98
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106