offapi/com/sun/star/chart/XAxisYSupplier.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_chart_XAxisYSupplier_idl__
  20 #define __com_sun_star_chart_XAxisYSupplier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/drawing/XShape.idl>
  25
  26 #include <com/sun/star/beans/XPropertySet.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module chart {
  31
  32
  33 /** gives access to the <i>y</i>-axis of a chart.
  34
  35     <p>Note that not all diagrams are capable of displaying a
  36     <i>y</i>-axis, e.g., the PieDiagram.</p>
  37
  38     @see XDiagram
  39  */
  40 published interface XAxisYSupplier: com::sun::star::uno::XInterface
  41 {
  42
  43     /** @returns
  44             the <i>y</i>-axis title shape.
  45
  46         @see ChartTitle
  47      */
  48     com::sun::star::drawing::XShape getYAxisTitle();
  49
  50
  51     /** @returns
  52             the properties of the <i>y</i>-axis of the diagram.
  53
  54         <p>The returned property set contains scaling properties as
  55         well as formatting properties.</p>
  56
  57         @see ChartAxis
  58      */
  59     com::sun::star::beans::XPropertySet getYAxis();
  60
  61
  62     /** @returns
  63             the properties of the help grid (minor grid) of the
  64             <i>y</i>-axis of the diagram.
  65
  66         @see ChartGrid
  67      */
  68     com::sun::star::beans::XPropertySet getYHelpGrid();
  69
  70
  71     /** @returns
  72             the properties of the main grid (major grid) of the
  73             <i>y</i>-axis of the diagram.
  74
  75         @see ChartGrid
  76      */
  77     com::sun::star::beans::XPropertySet getYMainGrid();
  78
  79 };
  80
  81
  82 }; }; }; };
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */