1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XSheetConditionalEntries.idl,v $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
31 #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
32 #define __com_sun_star_sheet_XSheetConditionalEntries_idl__
34 #ifndef __com_sun_star_container_XIndexAccess_idl__
35 #include
<com
/sun
/star
/container
/XIndexAccess.idl
>
38 #ifndef __com_sun_star_beans_PropertyValue_idl__
39 #include
<com
/sun
/star
/beans
/PropertyValue.idl
>
42 //=============================================================================
44 module com
{ module sun
{ module star
{ module sheet
{
46 //=============================================================================
48 /** provides methods to add and remove conditions of a conditional format.
50 @see com::sun::star::sheet::TableConditionalFormat
51 @see com::sun::star::sheet::TableConditionalEntry
53 published
interface XSheetConditionalEntries
: com
::sun
::star
::container
::XIndexAccess
55 //-------------------------------------------------------------------------
57 /** adds a conditional entry to the format.
59 <p>Supported properties are:</p>
62 <dt><type>ConditionOperator</type> Operator</dt>
63 <dd>contains the operation to perform for this condition.</dd>
65 <dt><atom>string</atom> Formula1</dt>
66 <dd>contains the value or formula for the operation.</dd>
68 <dt><atom>string</atom> Formula2</dt>
69 <dd>contains the second value or formula for the operation (used with
70 <const>ConditionOperator::BETWEEN</const> or
71 <const>ConditionOperator::NOT_BETWEEN</const> operations).</dd>
73 <dt><type scope="com::sun::star::table">CellAddress</type>
75 <dd>contains the base address for relative cell references in formulas.
78 <dt><atom>string</atom> StyleName</dt>
79 <dd>contains the name of the cell style used by this condition.</dd>
82 @see com::sun::star::sheet::TableConditionalFormat
84 void addNew
( [in] sequence
< com
::sun
::star
::beans
::PropertyValue
> aConditionalEntry
);
86 //-------------------------------------------------------------------------
88 /** removes a conditional entry from the format.
90 void removeByIndex
( [in] long nIndex
);
92 //-------------------------------------------------------------------------
94 /** clears all condition entries.
100 //=============================================================================