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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_chart_XChartData_idl__
  20 #define __com_sun_star_chart_XChartData_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/chart/XChartDataChangeEventListener.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module chart {
  29
  30
  31 /** manages the data of the chart.
  32
  33     @see XChartDocument
  34  */
  35 published interface XChartData: com::sun::star::uno::XInterface
  36 {
  37
  38     /** allows a component supporting the
  39         XChartDataChangeEventListener interface to
  40         register as listener.  The component will be notified with a
  41         ChartDataChangeEvent every time the chart's data
  42         changes.</p>
  43
  44         @param aListener
  45             the component that is to be added as listener
  46
  47         @see XChartDataChangeEventListener
  48         @see ChartDataChangeEvent
  49      */
  50     void addChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener );
  51
  52
  53     /** removes a previously registered listener.
  54
  55         @param aListener
  56             the component that is to be removed
  57      */
  58     void removeChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener );
  59
  60
  61     /** @returns
  62             the value which is to be used as an indicator for a
  63             missing value in the data.
  64
  65         <p>In IEEE arithmetic format it is one of the NaN values, so
  66         there are no conflicts with existing numeric values.</p>
  67      */
  68     double getNotANumber();
  69
  70
  71     /** checks whether the value given is equal to the indicator value
  72         for a missing value.
  73
  74         <p>In IEEE arithmetic format it is one of the NaN values, so
  75         there are no conflicts with existing numeric values.</p>
  76
  77         <p>Always use this method to check, if a value is <em>not a
  78         number</em>.  If you compare the value returned by
  79         XChartData::getNotANumber() to another double
  80         value using the = operator, you may not get the desired
  81         result!</p>
  82
  83         @returns
  84             `TRUE` if the number given is interpreted by the chart as
  85             a missing value.
  86
  87         @param nNumber
  88             the number that you want to check for validity.
  89      */
  90     boolean isNotANumber( [in] double nNumber );
  91
  92 };
  93
  94
  95 }; }; }; };
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */