xref: /aoo41x/main/offapi/com/sun/star/sheet/GeneralFunction.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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