summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/StockDiagram.idl
blob: 9d960468b17b848c51902588b9080d8bdc9fb7e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_chart_StockDiagram_idl__
#define __com_sun_star_chart_StockDiagram_idl__

#ifndef __com_sun_star_chart_XStatisticDisplay_idl__
#include <com/sun/star/chart/XStatisticDisplay.idl>
#endif

#ifndef __com_sun_star_chart_ChartStatistics_idl__
#include <com/sun/star/chart/ChartStatistics.idl>
#endif

#ifndef __com_sun_star_chart_Diagram_idl__
#include <com/sun/star/chart/Diagram.idl>
#endif

#ifndef __com_sun_star_chart_ChartAxisXSupplier_idl__
#include <com/sun/star/chart/ChartAxisXSupplier.idl>
#endif

#ifndef __com_sun_star_chart_ChartTwoAxisYSupplier_idl__
#include <com/sun/star/chart/ChartTwoAxisYSupplier.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module chart {

//=============================================================================

/** specifies a diagram which can be used for presenting stock quotes.

    <p>Note that the data must have a specific structure for stock
    diagrams.  Let us assume that data is interpreted, such that
    series are taken from columns (see property
    <member>Diagram::DataRowSource</member>).  Then you need tables of
    the following structures for different types:</p>

    <p><strong>
     <member>StockDiagram::Volume</member> is <FALSE/><br>
     <member>StockDiagram::UpDown</member> is <FALSE/>
    </strong>
    <table border>
     <tr><td>Low</td><td>High</td><td>Close</td></tr>
     <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
    </table></p>

    <p><strong>
     <member>StockDiagram::Volume</member> is <TRUE/><br>
     <member>StockDiagram::UpDown</member> is <FALSE/>
    </strong>
    <table border>
     <tr><td><strong>Volume</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
     <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
    </table></p>

    <p><strong>
     <member>StockDiagram::Volume</member> is <FALSE/><br>
     <member>StockDiagram::UpDown</member> is <TRUE/>
    </strong>
    <table border>
     <tr><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
     <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
    </table></p>

    <p><strong>
     <member>StockDiagram::Volume</member> is <TRUE/><br>
     <member>StockDiagram::UpDown</member> is <TRUE/>
    </strong>
    <table border>
     <tr><td><strong>Volume</strong></td><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
     <tr><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td><td>&hellip;</td></tr>
    </table></p>
*/
published service StockDiagram
{
    interface com::sun::star::chart::XStatisticDisplay;
    service com::sun::star::chart::ChartStatistics;
    service com::sun::star::chart::Diagram;
    service com::sun::star::chart::ChartAxisXSupplier;
    service com::sun::star::chart::ChartTwoAxisYSupplier;

    //-------------------------------------------------------------------------

    /** indicates if a stock chart contains data representing the
        volume of stocks.

        <p>The values of the volume are represented as columns like
        those of a <type>BarDiagram</type>.</p>

        <p>If this property is set to <TRUE/>, the values of the first
        series of the chart data are interpreted as volume.</p>
     */
    [property] boolean Volume;

    //-------------------------------------------------------------------------

    /** indicates if a stock chart contains data representing the
        value of stocks on the opening and closing date.

        <p>The difference will be indicated by bars.  The color
        of the bar will be significant for positive or negative
        differences between open and closed data.</p>

        <p>If this property is <FALSE/>, the values of the first
        series (or second if <member>StockDiagram::Volume</member> is
        <TRUE/>) of the chart data are interpreted as the day's lowest
        value.  The next series is interpreted as the day's highest
        value, and the last series is interpreted as the closing
        value.</p>

        <p>If this property is set to <TRUE/>, one additional series
        is needed with the opening value of the stocks.  It is assumed
        as the series before the series with the day's lowest
        value.</p>
     */
    [property] boolean UpDown;

};

//=============================================================================

}; }; }; };

#endif