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_chart2_XCoordinateSystem_idl
24#define com_sun_star_chart2_XCoordinateSystem_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_lang_IndexOutOfBoundsException_idl__
31#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
32#endif
33
34#include <com/sun/star/chart2/XAxis.idl>
35
36module com
37{
38module sun
39{
40module star
41{
42module chart2
43{
44
45/**
46*/
47
48interface XCoordinateSystem : ::com::sun::star::uno::XInterface
49{
50    /** the dimension of the coordinate-system.
51     */
52	long getDimension();
53
54    /** identifies the type of coordinate system (e.g. cartesian, polar ...)
55    */
56    string getCoordinateSystemType();
57
58    /** return a service name from which the view component for this coordinate system can be created
59    */
60    string getViewServiceName();
61
62    /** The dimension says wether it is a x, y or z axis.
63        The index says wether it is a primary or a secondary axis.
64        Use nIndex == 0 for a primary axis.
65     */
66    void setAxisByDimension( [in] long nDimension,
67                              [in] XAxis xAxis,
68                              [in] long nIndex )
69        raises( com::sun::star::lang::IndexOutOfBoundsException );
70
71    /** The dimension says wether it is a x, y or z axis.
72        The index indicates wether it is a primary or a secondary axis or maybe more in future.
73        Use nIndex == 0 for a primary axis.
74        An empty Reference will be returned if the given nDimension and nIndex are in the valid range but no axis is set for those values.
75        An IndexOutOfBoundsException will be thrown if nDimension is lower than 0 or greater than the value returned by getDimension()
76        and/or if nIndex is lower 0 or greater than the value returned by getMaxAxisIndexByDimension(nDimension).
77     */
78    XAxis getAxisByDimension( [in] long nDimension, [in] long nIndex )
79        raises( com::sun::star::lang::IndexOutOfBoundsException );
80
81    /** In one dimension there could be several axes to enable main and secondary axis and maybe more in future.
82        This method returns the maximum index at which an axis exists for the given dimension.
83        It is allowed that some indexes inbetween do not have an axis.
84    /*/
85    long getMaximumAxisIndexByDimension( [in] long nDimension )
86        raises( com::sun::star::lang::IndexOutOfBoundsException );
87};
88
89} ; // chart2
90} ; // com
91} ; // sun
92} ; // star
93
94
95#endif
96