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