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_chart2_CandleStickChartType_idl 24#define com_sun_star_chart2_CandleStickChartType_idl 25 26#include <com/sun/star/chart2/ChartType.idl> 27#include <com/sun/star/beans/PropertySet.idl> 28 29module com 30{ 31module sun 32{ 33module star 34{ 35module chart2 36{ 37 38/** chart type service for candlestick charts. 39 */ 40service CandleStickChartType 41{ 42 /** The base service describing generic chart types. 43 */ 44 service ChartType; 45 46 /** If this property is <TRUE/>, the candlesticks are shown as 47 japanese candlesticks. This implies that the property 48 <member>ShowFirst</member> is also <TRUE/>. 49 50 <p>Japanese candlesticks show the first and last value as 51 boxes. A rising course (i.e. if the last value is greater 52 than the first one) is shown by a white box. A falling course 53 is shown by a black box.</p> 54 55 <p>Default is <FALSE/>.</p> 56 57 @see WhiteDay 58 @see BlackDay 59 */ 60 [maybedefault, property] boolean Japanese; 61 62 /** If the candlestick chart shows japanese candlesticks, that is 63 the property <member>Japanese</member> is <TRUE/>, the 64 property set given here contains the formatting attributes of 65 the white boxes, i.e. the boxes shown for rising values.</p> 66 67 <p>The <type scope="com::sun::star::beans">XPropertySet</type> 68 given here must support the services 69 <type scope="com::sun::star::drawing">FillProperties</type> 70 and 71 <type scope="com::sun::star::drawing">LineProperties</type>.</p> 72 */ 73 [maybevoid, property] com::sun::star::beans::XPropertySet WhiteDay; 74 75 /** If the candlestick chart shows japanese candlesticks, that is 76 the property <member>Japanese</member> is <TRUE/>, the 77 property set given here contains the formatting attributes of 78 the black boxes, i.e. the boxes shown for falling values.</p> 79 80 <p>The <type scope="com::sun::star::beans">XPropertySet</type> 81 given here must support the services 82 <type scope="com::sun::star::drawing">FillProperties</type> 83 and 84 <type scope="com::sun::star::drawing">LineProperties</type>.</p> 85 */ 86 [maybevoid, property] com::sun::star::beans::XPropertySet BlackDay; 87 88 /** If this property is <TRUE/>, the first value (which would be 89 the opening course in a stock chart) is shown in the chart. 90 This also makes the role "values-first" mandatory. 91 92 <p>This property is only evaluated for non-japanese 93 candlestick charts, as japanese candlesticks always require to 94 show the first value.</p> 95 96 <p>Default is <FALSE/>.</p> 97 */ 98 [maybedefault, property] boolean ShowFirst; 99 100 /** If this property is <TRUE/>, the low and high values are shown 101 in the chart. This also makes the roles "values-min" and 102 "values-max" mandatory. 103 104 <p>Default is <TRUE/>.</p> 105 */ 106 [maybedefault, property] boolean ShowHighLow; 107}; 108 109} ; // chart2 110} ; // star 111} ; // sun 112} ; // com 113 114 115#endif 116