offapi/com/sun/star/chart/StockDiagram.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: StockDiagram.idl,v $
  10  * $Revision: 1.10 $
  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_StockDiagram_idl__
  31 #define __com_sun_star_chart_StockDiagram_idl__
  32
  33 #ifndef __com_sun_star_chart_XStatisticDisplay_idl__
  34 #include <com/sun/star/chart/XStatisticDisplay.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_chart_ChartStatistics_idl__
  38 #include <com/sun/star/chart/ChartStatistics.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_chart_Diagram_idl__
  42 #include <com/sun/star/chart/Diagram.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_chart_ChartAxisXSupplier_idl__
  46 #include <com/sun/star/chart/ChartAxisXSupplier.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_chart_ChartTwoAxisYSupplier_idl__
  50 #include <com/sun/star/chart/ChartTwoAxisYSupplier.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module chart {
  57
  58 //=============================================================================
  59
  60 /** specifies a diagram which can be used for presenting stock quotes.
  61
  62     <p>Note that the data must have a specific structure for stock
  63     diagrams.  Let us assume that data is interpreted, such that
  64     series are taken from columns (see property
  65     <member>Diagram::DataRowSource</member>).  Then you need tables of
  66     the following structures for different types:</p>
  67
  68     <p><strong>
  69      <member>StockDiagram::Volume</member> is <FALSE/><br>
  70      <member>StockDiagram::UpDown</member> is <FALSE/>
  71     </strong>
  72     <table border>
  73      <tr><td>Low</td><td>High</td><td>Close</td></tr>
  74      <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
  75     </table></p>
  76
  77     <p><strong>
  78      <member>StockDiagram::Volume</member> is <TRUE/><br>
  79      <member>StockDiagram::UpDown</member> is <FALSE/>
  80     </strong>
  81     <table border>
  82      <tr><td><strong>Volume</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
  83      <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
  84     </table></p>
  85
  86     <p><strong>
  87      <member>StockDiagram::Volume</member> is <FALSE/><br>
  88      <member>StockDiagram::UpDown</member> is <TRUE/>
  89     </strong>
  90     <table border>
  91      <tr><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
  92      <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
  93     </table></p>
  94
  95     <p><strong>
  96      <member>StockDiagram::Volume</member> is <TRUE/><br>
  97      <member>StockDiagram::UpDown</member> is <TRUE/>
  98     </strong>
  99     <table border>
 100      <tr><td><strong>Volume</strong></td><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
 101      <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
 102     </table></p>
 103 */
 104 published service StockDiagram
 105 {
 106     interface com::sun::star::chart::XStatisticDisplay;
 107     service com::sun::star::chart::ChartStatistics;
 108     service com::sun::star::chart::Diagram;
 109     service com::sun::star::chart::ChartAxisXSupplier;
 110     service com::sun::star::chart::ChartTwoAxisYSupplier;
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** indicates if a stock chart contains data representing the
 115         volume of stocks.
 116
 117         <p>The values of the volume are represented as columns like
 118         those of a <type>BarDiagram</type>.</p>
 119
 120         <p>If this property is set to <TRUE/>, the values of the first
 121         series of the chart data are interpreted as volume.</p>
 122      */
 123     [property] boolean Volume;
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** indicates if a stock chart contains data representing the
 128         value of stocks on the opening and closing date.
 129
 130         <p>The difference will be indicated by bars.  The color
 131         of the bar will be significant for positive or negative
 132         differences between open and closed data.</p>
 133
 134         <p>If this property is <FALSE/>, the values of the first
 135         series (or second if <member>StockDiagram::Volume</member> is
 136         <TRUE/>) of the chart data are interpreted as the day's lowest
 137         value.  The next series is interpreted as the day's highest
 138         value, and the last series is interpreted as the closing
 139         value.</p>
 140
 141         <p>If this property is set to <TRUE/>, one additional series
 142         is needed with the opening value of the stocks.  It is assumed
 143         as the series before the series with the day's lowest
 144         value.</p>
 145      */
 146     [property] boolean UpDown;
 147
 148 };
 149
 150 //=============================================================================
 151
 152 }; }; }; };
 153
 154 #endif