xref: /AOO41X/main/offapi/com/sun/star/sheet/GeneralFunction.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_GeneralFunction_idl__
25#define __com_sun_star_sheet_GeneralFunction_idl__
26
27//=============================================================================
28
29module com {  module sun {  module star {  module sheet {
30
31//=============================================================================
32
33/** used to specify a function to be calculated from values.
34 */
35published enum GeneralFunction
36{
37    //-------------------------------------------------------------------------
38
39    /** nothing is calculated.
40     */
41    NONE,
42
43    //-------------------------------------------------------------------------
44
45    /** function is determined automatically.
46
47        <p>If the values are all numerical, SUM is used, otherwise COUNT.</p>
48     */
49    AUTO,
50
51    //-------------------------------------------------------------------------
52
53    /** sum of all numerical values is calculated.
54     */
55    SUM,
56
57    //-------------------------------------------------------------------------
58
59    /** all values, including non-numerical values, are counted.
60     */
61    COUNT,
62
63    //-------------------------------------------------------------------------
64
65    /** average of all numerical values is calculated.
66     */
67    AVERAGE,
68
69    //-------------------------------------------------------------------------
70
71    /** maximum value of all numerical values is calculated.
72     */
73    MAX,
74
75    //-------------------------------------------------------------------------
76
77    /** minimum value of all numerical values is calculated.
78     */
79    MIN,
80
81    //-------------------------------------------------------------------------
82
83    /** product of all numerical values is calculated.
84     */
85    PRODUCT,
86
87    //-------------------------------------------------------------------------
88
89    /** numerical values are counted.
90     */
91    COUNTNUMS,
92
93    //-------------------------------------------------------------------------
94
95    /** standard deviation is calculated based on a sample.
96     */
97    STDEV,
98
99    //-------------------------------------------------------------------------
100
101    /** standard deviation is calculated based on the entire population.
102     */
103    STDEVP,
104
105    //-------------------------------------------------------------------------
106
107    /** variance is calculated based on a sample.
108     */
109    VAR,
110
111    //-------------------------------------------------------------------------
112
113    /** variance is calculated based on the entire population.
114     */
115    VARP
116
117};
118
119//=============================================================================
120
121}; }; }; };
122
123#endif
124
125