xref: /AOO41X/main/offapi/com/sun/star/chart/XAxisXSupplier.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_chart_XAxisXSupplier_idl__
24#define __com_sun_star_chart_XAxisXSupplier_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_drawing_XShape_idl__
31#include <com/sun/star/drawing/XShape.idl>
32#endif
33
34#ifndef __com_sun_star_beans_XPropertySet_idl__
35#include <com/sun/star/beans/XPropertySet.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module chart {
42
43//=============================================================================
44
45/** gives access to the <i>x</i>-axis of a chart.
46
47    <p>Note that not all diagrams are capable of displaying an
48    <i>x</i>-axis, e.g., the <type>PieDiagram</type>.</p>
49
50    @see XDiagram
51 */
52published interface XAxisXSupplier: com::sun::star::uno::XInterface
53{
54    //-------------------------------------------------------------------------
55
56    /** @returns
57            the <i>x</i>-axis title shape.
58
59        @see ChartTitle
60     */
61    com::sun::star::drawing::XShape getXAxisTitle();
62
63    //-------------------------------------------------------------------------
64
65    /** @returns
66            the properties of the <i>x</i>-axis of the diagram.
67
68        <p>The returned property set contains scaling properties as
69        well as formatting properties.</p>
70
71        @see ChartAxis
72     */
73    com::sun::star::beans::XPropertySet getXAxis();
74
75    //-------------------------------------------------------------------------
76
77    /** @returns
78            the properties of the main grid (major grid) of the
79            <i>x</i>-axis of the diagram.
80
81        @see ChartGrid
82     */
83    com::sun::star::beans::XPropertySet getXMainGrid();
84
85    //-------------------------------------------------------------------------
86
87    /** @returns
88            the properties of the help grid (minor grid) of the
89            <i>x</i>-axis of the diagram.
90
91        @see ChartGrid
92     */
93    com::sun::star::beans::XPropertySet getXHelpGrid();
94
95};
96
97//=============================================================================
98
99}; }; }; };
100
101#endif
102