offapi/com/sun/star/chart/XStatisticDisplay.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: XStatisticDisplay.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_XStatisticDisplay_idl__
  31 #define __com_sun_star_chart_XStatisticDisplay_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_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module chart {
  45
  46 //=============================================================================
  47
  48 /** gives access to statistical elements for the chart.
  49
  50     <p>Statistical elements are used by a
  51     <type>StockDiagram</type>.</p>
  52
  53     @see XChartDocument
  54     @see StockDiagram
  55  */
  56 published interface XStatisticDisplay: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** @returns
  61             the properties of the up bars of a stock chart which has
  62             <member>StockDiagram::UpDown</member> set to <TRUE/>.
  63
  64         <p>The <em>UpBar</em> is the box that is drawn between the
  65         open and close value of a stock, when the closing value is
  66         above the opening value, i.e., the stock price rose.</p>
  67
  68         @see ChartArea
  69      */
  70     com::sun::star::beans::XPropertySet getUpBar();
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** @returns
  75             the properties of the down bars of a stock chart which has
  76             <member>StockDiagram::UpDown</member> set to <TRUE/>.
  77
  78         <p>The <em>DownBar</em> is the box that is drawn between the
  79         open and close value of a stock, when the closing value is
  80         below the opening value, i.e., the stock price fell.</p>
  81
  82         @see ChartArea
  83      */
  84     com::sun::star::beans::XPropertySet getDownBar();
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** @returns
  89             the properties of the lines that are drawn between the
  90             lowest and highest stock value during a day.
  91
  92         @see ChartLine
  93      */
  94     com::sun::star::beans::XPropertySet getMinMaxLine();
  95
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif