1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XSheetCondition_idl__
29#define __com_sun_star_sheet_XSheetCondition_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_ConditionOperator_idl__
36#include <com/sun/star/sheet/ConditionOperator.idl>
37#endif
38
39#ifndef __com_sun_star_table_CellAddress_idl__
40#include <com/sun/star/table/CellAddress.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sheet {
46
47//=============================================================================
48
49/** provides methods to access the settings of a condition in a
50	conditional format or data validation.
51
52	@see com::sun::star::sheet::TableConditionalEntry
53	@see com::sun::star::sheet::TableValidation
54 */
55published interface XSheetCondition: com::sun::star::uno::XInterface
56{
57	//-------------------------------------------------------------------------
58
59	/** returns the operator in the condition.
60	 */
61	com::sun::star::sheet::ConditionOperator getOperator();
62
63	//-------------------------------------------------------------------------
64
65	/** sets the operator in the condition.
66	 */
67	void setOperator(
68			[in] com::sun::star::sheet::ConditionOperator nOperator );
69
70	//-------------------------------------------------------------------------
71
72	/** returns either the comparison value, which is used in the condition,
73		or the first value if two values are needed for the operator.
74
75		@returns
76			a formula, a numeric constant, or a string constant in quotes.
77	 */
78	string getFormula1();
79
80	//-------------------------------------------------------------------------
81
82	/** sets either the comparison value, which is used in the condition,
83		or the first value if two values are needed for the operator.
84
85		@param aFormula1
86			a formula, a numeric constant, or a string constant in quotes.
87	 */
88	void setFormula1( [in] string aFormula1 );
89
90	//-------------------------------------------------------------------------
91
92	/** if two values are needed for the operator, this method returns
93		the second one.
94
95		@returns
96			a formula, a numeric constant, or a string constant in quotes.
97	 */
98	string getFormula2();
99
100	//-------------------------------------------------------------------------
101
102	/** if two values are needed for the operator, this method sets
103		the second one.
104
105		@param aFormula2
106			a formula, a numeric constant, or a string constant in quotes.
107	 */
108	void setFormula2( [in] string aFormula2 );
109
110	//-------------------------------------------------------------------------
111
112	/** returns the position in the document which is used as a base for
113		relative references in the formulas.
114	 */
115	com::sun::star::table::CellAddress getSourcePosition();
116
117	//-------------------------------------------------------------------------
118
119	/** sets the position in the document which is used as a base for
120		relative references in the formulas.
121	 */
122	void setSourcePosition(
123			[in] com::sun::star::table::CellAddress aSourcePosition );
124
125};
126
127//=============================================================================
128
129}; }; }; };
130
131#endif
132
133