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
  20
  21
  22  module com {  module sun {  module star {  module chart {
  23
  24
  25 /** manages the data of the chart.
  26
  27     @see XChartDocument
  28  */
  29 published interface XChartData: com::sun::star::uno::XInterface
  30 {
  31
  32     /** allows a component supporting the
  33         XChartDataChangeEventListener interface to
  34         register as listener.  The component will be notified with a
  35         ChartDataChangeEvent every time the chart's data
  36         changes.</p>
  37
  38         @param aListener
  39             the component that is to be added as listener
  40
  41         @see XChartDataChangeEventListener
  42         @see ChartDataChangeEvent
  43      */
  44     void addChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener );
  45
  46
  47     /** removes a previously registered listener.
  48
  49         @param aListener
  50             the component that is to be removed
  51      */
  52     void removeChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener );
  53
  54
  55     /** @returns
  56             the value which is to be used as an indicator for a
  57             missing value in the data.
  58
  59         <p>In IEEE arithmetic format it is one of the NaN values, so
  60         there are no conflicts with existing numeric values.</p>
  61      */
  62     double getNotANumber();
  63
  64
  65     /** checks whether the value given is equal to the indicator value
  66         for a missing value.
  67
  68         <p>In IEEE arithmetic format it is one of the NaN values, so
  69         there are no conflicts with existing numeric values.</p>
  70
  71         <p>Always use this method to check, if a value is <em>not a
  72         number</em>.  If you compare the value returned by
  73         XChartData::getNotANumber() to another double
  74         value using the = operator, you may not get the desired
  75         result!</p>
  76
  77         @returns
  78             `TRUE` if the number given is interpreted by the chart as
  79             a missing value.
  80
  81         @param nNumber
  82             the number that you want to check for validity.
  83      */
  84     boolean isNotANumber( [in] double nNumber );
  85
  86 };
  87
  88
  89 }; }; }; };
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */