summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XSheetCondition.idl
blob: 3fc4635f9b4adf5ce17458b871be7ba07374e9ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*************************************************************************
 *
 * 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_XSheetCondition_idl__
#define __com_sun_star_sheet_XSheetCondition_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sheet_ConditionOperator_idl__
#include <com/sun/star/sheet/ConditionOperator.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides methods to access the settings of a condition in a
    conditional format or data validation.

    @see com::sun::star::sheet::TableConditionalEntry
    @see com::sun::star::sheet::TableValidation
 */
published interface XSheetCondition: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the operator in the condition.
     */
    com::sun::star::sheet::ConditionOperator getOperator();

    //-------------------------------------------------------------------------

    /** sets the operator in the condition.
     */
    void setOperator(
            [in] com::sun::star::sheet::ConditionOperator nOperator );

    //-------------------------------------------------------------------------

    /** returns either the comparison value, which is used in the condition,
        or the first value if two values are needed for the operator.

        @returns
            a formula, a numeric constant, or a string constant in quotes.
     */
    string getFormula1();

    //-------------------------------------------------------------------------

    /** sets either the comparison value, which is used in the condition,
        or the first value if two values are needed for the operator.

        @param aFormula1
            a formula, a numeric constant, or a string constant in quotes.
     */
    void setFormula1( [in] string aFormula1 );

    //-------------------------------------------------------------------------

    /** if two values are needed for the operator, this method returns
        the second one.

        @returns
            a formula, a numeric constant, or a string constant in quotes.
     */
    string getFormula2();

    //-------------------------------------------------------------------------

    /** if two values are needed for the operator, this method sets
        the second one.

        @param aFormula2
            a formula, a numeric constant, or a string constant in quotes.
     */
    void setFormula2( [in] string aFormula2 );

    //-------------------------------------------------------------------------

    /** returns the position in the document which is used as a base for
        relative references in the formulas.
     */
    com::sun::star::table::CellAddress getSourcePosition();

    //-------------------------------------------------------------------------

    /** sets the position in the document which is used as a base for
        relative references in the formulas.
     */
    void setSourcePosition(
            [in] com::sun::star::table::CellAddress aSourcePosition );

};

//=============================================================================

}; }; }; };

#endif