offapi/com/sun/star/sheet/StatusBarFunction.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: StatusBarFunction.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_StatusBarFunction_idl__
  32 #define __com_sun_star_sheet_StatusBarFunction_idl__
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module sheet {
  37
  38 //=============================================================================
  39
  40 /** used to specify the function used to calculate a result in the
  41     spreadsheet's status bar.
  42  */
  43 published constants StatusBarFunction
  44 {
  45     //-------------------------------------------------------------------------
  46
  47     /** nothing is calculated.
  48      */
  49     const short NONE = 0;
  50
  51     //-------------------------------------------------------------------------
  52
  53     /** average of all numerical values is calculated.
  54      */
  55     const short AVERAGE = 1;
  56
  57     //-------------------------------------------------------------------------
  58
  59     /** all values, including non-numerical values, are counted.
  60      */
  61     const short COUNTNUMS = 2;
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** numerical values are counted.
  66      */
  67     const short COUNT = 3;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** maximum value of all numerical values is calculated.
  72      */
  73     const short MAX = 4;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** minimum value of all numerical values is calculated.
  78      */
  79     const short MIN = 5;
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** sum of all numerical values is calculated.
  84      */
  85     const short SUM = 9;
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif
  94