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