summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/GeneralFunction.idl
blob: abf954cbec3ebf560181ba25c084fcd2c08a40a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_GeneralFunction_idl__
#define __com_sun_star_sheet_GeneralFunction_idl__

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** used to specify a function to be calculated from values.
 */
published enum GeneralFunction
{
    //-------------------------------------------------------------------------

    /** nothing is calculated.
     */
    NONE,

    //-------------------------------------------------------------------------

    /** function is determined automatically.

        <p>If the values are all numerical, SUM is used, otherwise COUNT.</p>
     */
    AUTO,

    //-------------------------------------------------------------------------

    /** sum of all numerical values is calculated.
     */
    SUM,

    //-------------------------------------------------------------------------

    /** all values, including non-numerical values, are counted.
     */
    COUNT,

    //-------------------------------------------------------------------------

    /** average of all numerical values is calculated.
     */
    AVERAGE,

    //-------------------------------------------------------------------------

    /** maximum value of all numerical values is calculated.
     */
    MAX,

    //-------------------------------------------------------------------------

    /** minimum value of all numerical values is calculated.
     */
    MIN,

    //-------------------------------------------------------------------------

    /** product of all numerical values is calculated.
     */
    PRODUCT,

    //-------------------------------------------------------------------------

    /** numerical values are counted.
     */
    COUNTNUMS,

    //-------------------------------------------------------------------------

    /** standard deviation is calculated based on a sample.
     */
    STDEV,

    //-------------------------------------------------------------------------

    /** standard deviation is calculated based on the entire population.
     */
    STDEVP,

    //-------------------------------------------------------------------------

    /** variance is calculated based on a sample.
     */
    VAR,

    //-------------------------------------------------------------------------

    /** variance is calculated based on the entire population.
     */
    VARP

};

//=============================================================================

}; }; }; };

#endif