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

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