xref: /trunk/main/offapi/com/sun/star/chart/XChartData.idl (revision d1766043)
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_XChartData_idl__
24#define __com_sun_star_chart_XChartData_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_chart_XChartDataChangeEventListener_idl__
31#include <com/sun/star/chart/XChartDataChangeEventListener.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module chart {
38
39//=============================================================================
40
41/** manages the data of the chart.
42
43    @see XChartDocument
44 */
45published interface XChartData: com::sun::star::uno::XInterface
46{
47	//-------------------------------------------------------------------------
48
49	/** allows a component supporting the
50        <type>XChartDataChangeEventListener</type> interface to
51        register as listener.  The component will be notified with a
52        <type>ChartDataChangeEvent</type> every time the chart's data
53        changes.</p>
54
55        @param aListener
56        	the component that is to be added as listener
57
58        @see XChartDataChangeEventListener
59        @see ChartDataChangeEvent
60	 */
61	void addChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener );
62
63	//-------------------------------------------------------------------------
64
65	/** removes a previously registered listener.
66
67        @param aListener
68        	the component that is to be removed
69	 */
70	void removeChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener );
71
72	//-------------------------------------------------------------------------
73
74	/** @returns
75    		the value which is to be used as an indicator for a
76    		missing value in the data.
77
78		<p>In IEEE arithmetic format it is one of the NaN values, so
79		there are no conflicts with existing numeric values.</p>
80	 */
81	double getNotANumber();
82
83	//-------------------------------------------------------------------------
84
85	/** checks whether the value given is equal to the indicator value
86        for a missing value.
87
88        <p>In IEEE arithmetic format it is one of the NaN values, so
89		there are no conflicts with existing numeric values.</p>
90
91        <p>Always use this method to check, if a value is <em>not a
92        number</em>.  If you compare the value returned by
93        <member>XChartData::getNotANumber</member> to another double
94        value using the = operator, you may not get the desired
95        result!</p>
96
97		@returns
98        	<TRUE/> if the number given is interpreted by the chart as
99        	a missing value.
100
101        @param nNumber
102        	the number that you want to check for validity.
103	 */
104	boolean isNotANumber( [in] double nNumber );
105
106};
107
108//=============================================================================
109
110}; }; }; };
111
112#endif
113