offapi/com/sun/star/sheet/XSheetCondition.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: XSheetCondition.idl,v $
  10  * $Revision: 1.9 $
  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_XSheetCondition_idl__
  32 #define __com_sun_star_sheet_XSheetCondition_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_ConditionOperator_idl__
  39 #include <com/sun/star/sheet/ConditionOperator.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_CellAddress_idl__
  43 #include <com/sun/star/table/CellAddress.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module sheet {
  49
  50 //=============================================================================
  51
  52 /** provides methods to access the settings of a condition in a
  53     conditional format or data validation.
  54
  55     @see com::sun::star::sheet::TableConditionalEntry
  56     @see com::sun::star::sheet::TableValidation
  57  */
  58 published interface XSheetCondition: com::sun::star::uno::XInterface
  59 {
  60     //-------------------------------------------------------------------------
  61
  62     /** returns the operator in the condition.
  63      */
  64     com::sun::star::sheet::ConditionOperator getOperator();
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** sets the operator in the condition.
  69      */
  70     void setOperator(
  71             [in] com::sun::star::sheet::ConditionOperator nOperator );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** returns either the comparison value, which is used in the condition,
  76         or the first value if two values are needed for the operator.
  77
  78         @returns
  79             a formula, a numeric constant, or a string constant in quotes.
  80      */
  81     string getFormula1();
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** sets either the comparison value, which is used in the condition,
  86         or the first value if two values are needed for the operator.
  87
  88         @param aFormula1
  89             a formula, a numeric constant, or a string constant in quotes.
  90      */
  91     void setFormula1( [in] string aFormula1 );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** if two values are needed for the operator, this method returns
  96         the second one.
  97
  98         @returns
  99             a formula, a numeric constant, or a string constant in quotes.
 100      */
 101     string getFormula2();
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** if two values are needed for the operator, this method sets
 106         the second one.
 107
 108         @param aFormula2
 109             a formula, a numeric constant, or a string constant in quotes.
 110      */
 111     void setFormula2( [in] string aFormula2 );
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** returns the position in the document which is used as a base for
 116         relative references in the formulas.
 117      */
 118     com::sun::star::table::CellAddress getSourcePosition();
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** sets the position in the document which is used as a base for
 123         relative references in the formulas.
 124      */
 125     void setSourcePosition(
 126             [in] com::sun::star::table::CellAddress aSourcePosition );
 127
 128 };
 129
 130 //=============================================================================
 131
 132 }; }; }; };
 133
 134 #endif
 135