offapi/com/sun/star/sheet/GeneralFunction.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 #ifndef __com_sun_star_sheet_GeneralFunction_idl__
  21 #define __com_sun_star_sheet_GeneralFunction_idl__
  22
  23
  24 module com {  module sun {  module star {  module sheet {
  25
  26
  27 /** used to specify a function to be calculated from values.
  28  */
  29 published enum GeneralFunction
  30 {
  31
  32     /** nothing is calculated.
  33      */
  34     NONE,
  35
  36
  37     /** function is determined automatically.
  38
  39         <p>If the values are all numerical, SUM is used, otherwise COUNT.</p>
  40      */
  41     AUTO,
  42
  43
  44     /** sum of all numerical values is calculated.
  45      */
  46     SUM,
  47
  48
  49     /** all values, including non-numerical values, are counted.
  50      */
  51     COUNT,
  52
  53
  54     /** average of all numerical values is calculated.
  55      */
  56     AVERAGE,
  57
  58
  59     /** maximum value of all numerical values is calculated.
  60      */
  61     MAX,
  62
  63
  64     /** minimum value of all numerical values is calculated.
  65      */
  66     MIN,
  67
  68
  69     /** product of all numerical values is calculated.
  70      */
  71     PRODUCT,
  72
  73
  74     /** numerical values are counted.
  75      */
  76     COUNTNUMS,
  77
  78
  79     /** standard deviation is calculated based on a sample.
  80      */
  81     STDEV,
  82
  83
  84     /** standard deviation is calculated based on the entire population.
  85      */
  86     STDEVP,
  87
  88
  89     /** variance is calculated based on a sample.
  90      */
  91     VAR,
  92
  93
  94     /** variance is calculated based on the entire population.
  95      */
  96     VARP
  97
  98 };
  99
 100
 101 }; }; }; };
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */