offapi/com/sun/star/sheet/GeneralFunction.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: GeneralFunction.idl,v $
  10  * $Revision: 1.7 $
  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
  31 #ifndef __com_sun_star_sheet_GeneralFunction_idl__
  32 #define __com_sun_star_sheet_GeneralFunction_idl__
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module sheet {
  37
  38 //=============================================================================
  39
  40 /** used to specify a function to be calculated from values.
  41  */
  42 published enum GeneralFunction
  43 {
  44     //-------------------------------------------------------------------------
  45
  46     /** nothing is calculated.
  47      */
  48     NONE,
  49
  50     //-------------------------------------------------------------------------
  51
  52     /** function is determined automatically.
  53
  54         <p>If the values are all numerical, SUM is used, otherwise COUNT.</p>
  55      */
  56     AUTO,
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** sum of all numerical values is calculated.
  61      */
  62     SUM,
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** all values, including non-numerical values, are counted.
  67      */
  68     COUNT,
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** average of all numerical values is calculated.
  73      */
  74     AVERAGE,
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** maximum value of all numerical values is calculated.
  79      */
  80     MAX,
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** minimum value of all numerical values is calculated.
  85      */
  86     MIN,
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** product of all numerical values is calculated.
  91      */
  92     PRODUCT,
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** numerical values are counted.
  97      */
  98     COUNTNUMS,
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** standard deviation is calculated based on a sample.
 103      */
 104     STDEV,
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** standard deviation is calculated based on the entire population.
 109      */
 110     STDEVP,
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** variance is calculated based on a sample.
 115      */
 116     VAR,
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** variance is calculated based on the entire population.
 121      */
 122     VARP
 123
 124 };
 125
 126 //=============================================================================
 127
 128 }; }; }; };
 129
 130 #endif
 131