/*************************************************************************
 *
 * 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