diff options
Diffstat (limited to 'offapi/com/sun/star/chart2/CandleStickChartType.idl')
-rw-r--r-- | offapi/com/sun/star/chart2/CandleStickChartType.idl | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/offapi/com/sun/star/chart2/CandleStickChartType.idl b/offapi/com/sun/star/chart2/CandleStickChartType.idl new file mode 100644 index 000000000000..747531409fd3 --- /dev/null +++ b/offapi/com/sun/star/chart2/CandleStickChartType.idl @@ -0,0 +1,119 @@ +/************************************************************************* + * + * 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_chart2_CandleStickChartType_idl +#define com_sun_star_chart2_CandleStickChartType_idl + +#include <com/sun/star/chart2/ChartType.idl> +#include <com/sun/star/beans/PropertySet.idl> + +module com +{ +module sun +{ +module star +{ +module chart2 +{ + +/** chart type service for candlestick charts. + */ +service CandleStickChartType +{ + /** The base service describing generic chart types. + */ + service ChartType; + + /** If this property is <TRUE/>, the candlesticks are shown as + japanese candlesticks. This implies that the property + <member>ShowFirst</member> is also <TRUE/>. + + <p>Japanese candlesticks show the first and last value as + boxes. A rising course (i.e. if the last value is greater + than the first one) is shown by a white box. A falling course + is shown by a black box.</p> + + <p>Default is <FALSE/>.</p> + + @see WhiteDay + @see BlackDay + */ + [maybedefault, property] boolean Japanese; + + /** If the candlestick chart shows japanese candlesticks, that is + the property <member>Japanese</member> is <TRUE/>, the + property set given here contains the formatting attributes of + the white boxes, i.e. the boxes shown for rising values.</p> + + <p>The <type scope="com::sun::star::beans">XPropertySet</type> + given here must support the services + <type scope="com::sun::star::drawing">FillProperties</type> + and + <type scope="com::sun::star::drawing">LineProperties</type>.</p> + */ + [maybevoid, property] com::sun::star::beans::XPropertySet WhiteDay; + + /** If the candlestick chart shows japanese candlesticks, that is + the property <member>Japanese</member> is <TRUE/>, the + property set given here contains the formatting attributes of + the black boxes, i.e. the boxes shown for falling values.</p> + + <p>The <type scope="com::sun::star::beans">XPropertySet</type> + given here must support the services + <type scope="com::sun::star::drawing">FillProperties</type> + and + <type scope="com::sun::star::drawing">LineProperties</type>.</p> + */ + [maybevoid, property] com::sun::star::beans::XPropertySet BlackDay; + + /** If this property is <TRUE/>, the first value (which would be + the opening course in a stock chart) is shown in the chart. + This also makes the role "values-first" mandatory. + + <p>This property is only evaluated for non-japanese + candlestick charts, as japanese candlesticks always require to + show the first value.</p> + + <p>Default is <FALSE/>.</p> + */ + [maybedefault, property] boolean ShowFirst; + + /** If this property is <TRUE/>, the low and high values are shown + in the chart. This also makes the roles "values-min" and + "values-max" mandatory. + + <p>Default is <TRUE/>.</p> + */ + [maybedefault, property] boolean ShowHighLow; +}; + +} ; // chart2 +} ; // star +} ; // sun +} ; // com + + +#endif |