offapi/com/sun/star/chart2/XCoordinateSystem.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef com_sun_star_chart2_XCoordinateSystem_idl
  20 #define com_sun_star_chart2_XCoordinateSystem_idl
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  24 #include <com/sun/star/chart2/XAxis.idl>
  25
  26 module com
  27 {
  28 module sun
  29 {
  30 module star
  31 {
  32 module chart2
  33 {
  34
  35 interface XCoordinateSystem : ::com::sun::star::uno::XInterface
  36 {
  37     /** the dimension of the coordinate-system.
  38      */
  39     long getDimension();
  40
  41     /** identifies the type of coordinate system (e.g. Cartesian, polar ...)
  42     */
  43     string getCoordinateSystemType();
  44
  45     /** return a service name from which the view component for this coordinate system can be created
  46     */
  47     string getViewServiceName();
  48
  49     /** The dimension says whether it is a x, y or z axis.
  50         The index says whether it is a primary or a secondary axis.
  51         Use nIndex == 0 for a primary axis.
  52      */
  53     void setAxisByDimension( [in] long nDimension,
  54                               [in] XAxis xAxis,
  55                               [in] long nIndex )
  56         raises( com::sun::star::lang::IndexOutOfBoundsException );
  57
  58     /** The dimension says whether it is a x, y or z axis.
  59         The index indicates whether it is a primary or a secondary axis or maybe more in future.
  60         Use nIndex == 0 for a primary axis.
  61         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.
  62         An IndexOutOfBoundsException will be thrown if nDimension is lower than 0 or greater than the value returned by getDimension()
  63         and/or if nIndex is lower 0 or greater than the value returned by getMaxAxisIndexByDimension(nDimension).
  64      */
  65     XAxis getAxisByDimension( [in] long nDimension, [in] long nIndex )
  66         raises( com::sun::star::lang::IndexOutOfBoundsException );
  67
  68     /** In one dimension there could be several axes to enable main and secondary axis and maybe more in future.
  69         This method returns the maximum index at which an axis exists for the given dimension.
  70         It is allowed that some indexes in between do not have an axis.
  71     */
  72     long getMaximumAxisIndexByDimension( [in] long nDimension )
  73         raises( com::sun::star::lang::IndexOutOfBoundsException );
  74 };
  75
  76 } ; // chart2
  77 } ; // com
  78 } ; // sun
  79 } ; // star
  80
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */