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