offapi/com/sun/star/chart/XChartData.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XChartData.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_chart_XChartData_idl__
  31 #define __com_sun_star_chart_XChartData_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_chart_XChartDataChangeEventListener_idl__
  38 #include <com/sun/star/chart/XChartDataChangeEventListener.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module chart {
  45
  46 //=============================================================================
  47
  48 /** manages the data of the chart.
  49
  50     @see XChartDocument
  51  */
  52 published interface XChartData: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** allows a component supporting the
  57         <type>XChartDataChangeEventListener</type> interface to
  58         register as listener.  The component will be notified with a
  59         <type>ChartDataChangeEvent</type> every time the chart's data
  60         changes.</p>
  61
  62         @param aListener
  63             the component that is to be added as listener
  64
  65         @see XChartDataChangeEventListener
  66         @see ChartDataChangeEvent
  67      */
  68     void addChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** removes a previously registered listener.
  73
  74         @param aListener
  75             the component that is to be removed
  76      */
  77     void removeChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener );
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** @returns
  82             the value which is to be used as an indicator for a
  83             missing value in the data.
  84
  85         <p>In IEEE arithmetic format it is one of the NaN values, so
  86         there are no conflicts with existing numeric values.</p>
  87      */
  88     double getNotANumber();
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** checks whether the value given is equal to the indicator value
  93         for a missing value.
  94
  95         <p>In IEEE arithmetic format it is one of the NaN values, so
  96         there are no conflicts with existing numeric values.</p>
  97
  98         <p>Always use this method to check, if a value is <em>not a
  99         number</em>.  If you compare the value returned by
 100         <member>XChartData::getNotANumber</member> to another double
 101         value using the = operator, you may not get the desired
 102         result!</p>
 103
 104         @returns
 105             <TRUE/> if the number given is interpreted by the chart as
 106             a missing value.
 107
 108         @param nNumber
 109             the number that you want to check for validity.
 110      */
 111     boolean isNotANumber( [in] double nNumber );
 112
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 #endif