offapi/com/sun/star/chart/XAxisYSupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XAxisYSupplier.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_chart_XAxisYSupplier_idl__
  31 #define __com_sun_star_chart_XAxisYSupplier_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_XShape_idl__
  38 #include <com/sun/star/drawing/XShape.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XPropertySet_idl__
  42 #include <com/sun/star/beans/XPropertySet.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module chart {
  49
  50 //=============================================================================
  51
  52 /** gives access to the <i>y</i>-axis of a chart.
  53
  54     <p>Note that not all diagrams are capable of displaying a
  55     <i>y</i>-axis, e.g., the <type>PieDiagram</type>.</p>
  56
  57     @see XDiagram
  58  */
  59 published interface XAxisYSupplier: com::sun::star::uno::XInterface
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /** @returns
  64             the <i>y</i>-axis title shape.
  65
  66         @see ChartTitle
  67      */
  68     com::sun::star::drawing::XShape getYAxisTitle();
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** @returns
  73             the properties of the <i>y</i>-axis of the diagram.
  74
  75         <p>The returned property set contains scaling properties as
  76         well as formatting properties.</p>
  77
  78         @see ChartAxis
  79      */
  80     com::sun::star::beans::XPropertySet getYAxis();
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** @returns
  85             the properties of the help grid (minor grid) of the
  86             <i>y</i>-axis of the diagram.
  87
  88         @see ChartGrid
  89      */
  90     com::sun::star::beans::XPropertySet getYHelpGrid();
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** @returns
  95             the properties of the main grid (major grid) of the
  96             <i>y</i>-axis of the diagram.
  97
  98         @see ChartGrid
  99      */
 100     com::sun::star::beans::XPropertySet getYMainGrid();
 101
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif