1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_chart_StockDiagram_idl__
24#define __com_sun_star_chart_StockDiagram_idl__
25
26#ifndef __com_sun_star_chart_XStatisticDisplay_idl__
27#include <com/sun/star/chart/XStatisticDisplay.idl>
28#endif
29
30#ifndef __com_sun_star_chart_ChartStatistics_idl__
31#include <com/sun/star/chart/ChartStatistics.idl>
32#endif
33
34#ifndef __com_sun_star_chart_Diagram_idl__
35#include <com/sun/star/chart/Diagram.idl>
36#endif
37
38#ifndef __com_sun_star_chart_ChartAxisXSupplier_idl__
39#include <com/sun/star/chart/ChartAxisXSupplier.idl>
40#endif
41
42#ifndef __com_sun_star_chart_ChartTwoAxisYSupplier_idl__
43#include <com/sun/star/chart/ChartTwoAxisYSupplier.idl>
44#endif
45
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module chart {
50
51//=============================================================================
52
53/** specifies a diagram which can be used for presenting stock quotes.
54
55	<p>Note that the data must have a specific structure for stock
56	diagrams.  Let us assume that data is interpreted, such that
57	series are taken from columns (see property
58	<member>Diagram::DataRowSource</member>).  Then you need tables of
59	the following structures for different types:</p>
60
61    <p><strong>
62     <member>StockDiagram::Volume</member> is <FALSE/><br>
63     <member>StockDiagram::UpDown</member> is <FALSE/>
64    </strong>
65    <table border>
66     <tr><td>Low</td><td>High</td><td>Close</td></tr>
67     <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
68    </table></p>
69
70    <p><strong>
71     <member>StockDiagram::Volume</member> is <TRUE/><br>
72     <member>StockDiagram::UpDown</member> is <FALSE/>
73    </strong>
74    <table border>
75     <tr><td><strong>Volume</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
76     <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
77    </table></p>
78
79    <p><strong>
80     <member>StockDiagram::Volume</member> is <FALSE/><br>
81     <member>StockDiagram::UpDown</member> is <TRUE/>
82    </strong>
83    <table border>
84     <tr><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
85     <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
86    </table></p>
87
88    <p><strong>
89     <member>StockDiagram::Volume</member> is <TRUE/><br>
90     <member>StockDiagram::UpDown</member> is <TRUE/>
91    </strong>
92    <table border>
93     <tr><td><strong>Volume</strong></td><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
94     <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
95    </table></p>
96*/
97published service StockDiagram
98{
99	interface com::sun::star::chart::XStatisticDisplay;
100	service com::sun::star::chart::ChartStatistics;
101	service com::sun::star::chart::Diagram;
102	service com::sun::star::chart::ChartAxisXSupplier;
103	service com::sun::star::chart::ChartTwoAxisYSupplier;
104
105	//-------------------------------------------------------------------------
106
107	/** indicates if a stock chart contains data representing the
108        volume of stocks.
109
110		<p>The values of the volume are represented as columns like
111		those of a <type>BarDiagram</type>.</p>
112
113        <p>If this property is set to <TRUE/>, the values of the first
114        series of the chart data are interpreted as volume.</p>
115	 */
116	[property] boolean Volume;
117
118	//-------------------------------------------------------------------------
119
120	/** indicates if a stock chart contains data representing the
121        value of stocks on the opening and closing date.
122
123		<p>The difference will be indicated by bars.  The color
124		of the bar will be significant for positive or negative
125		differences between open and closed data.</p>
126
127        <p>If this property is <FALSE/>, the values of the first
128        series (or second if <member>StockDiagram::Volume</member> is
129        <TRUE/>) of the chart data are interpreted as the day's lowest
130        value.  The next series is interpreted as the day's highest
131        value, and the last series is interpreted as the closing
132        value.</p>
133
134        <p>If this property is set to <TRUE/>, one additional series
135        is needed with the opening value of the stocks.  It is assumed
136        as the series before the series with the day's lowest
137        value.</p>
138	 */
139	[property] boolean UpDown;
140
141};
142
143//=============================================================================
144
145}; }; }; };
146
147#endif
148