blob: c6f1489d168d460f8877f6bbe7e4ee76731a80d5 (
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
|
/*************************************************************************
*
* 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_XSheetConditionalEntries_idl__
#define __com_sun_star_sheet_XSheetConditionalEntries_idl__
#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif
#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** provides methods to add and remove conditions of a conditional format.
@see com::sun::star::sheet::TableConditionalFormat
@see com::sun::star::sheet::TableConditionalEntry
*/
published interface XSheetConditionalEntries: com::sun::star::container::XIndexAccess
{
//-------------------------------------------------------------------------
/** adds a conditional entry to the format.
<p>Supported properties are:</p>
<dl>
<dt><type>ConditionOperator</type> Operator</dt>
<dd>contains the operation to perform for this condition.</dd>
<dt><atom>string</atom> Formula1</dt>
<dd>contains the value or formula for the operation.</dd>
<dt><atom>string</atom> Formula2</dt>
<dd>contains the second value or formula for the operation (used with
<const>ConditionOperator::BETWEEN</const> or
<const>ConditionOperator::NOT_BETWEEN</const> operations).</dd>
<dt><type scope="com::sun::star::table">CellAddress</type>
SourcePosition</dt>
<dd>contains the base address for relative cell references in formulas.
</dd>
<dt><atom>string</atom> StyleName</dt>
<dd>contains the name of the cell style used by this condition.</dd>
</dl>
@see com::sun::star::sheet::TableConditionalFormat
*/
void addNew( [in] sequence< com::sun::star::beans::PropertyValue > aConditionalEntry );
//-------------------------------------------------------------------------
/** removes a conditional entry from the format.
*/
void removeByIndex( [in] long nIndex );
//-------------------------------------------------------------------------
/** clears all condition entries.
*/
void clear();
};
//=============================================================================
}; }; }; };
#endif
|