1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ 25#define __com_sun_star_sheet_XSheetConditionalEntries_idl__ 26 27#ifndef __com_sun_star_container_XIndexAccess_idl__ 28#include <com/sun/star/container/XIndexAccess.idl> 29#endif 30 31#ifndef __com_sun_star_beans_PropertyValue_idl__ 32#include <com/sun/star/beans/PropertyValue.idl> 33#endif 34 35//============================================================================= 36 37module com { module sun { module star { module sheet { 38 39//============================================================================= 40 41/** provides methods to add and remove conditions of a conditional format. 42 43 @see com::sun::star::sheet::TableConditionalFormat 44 @see com::sun::star::sheet::TableConditionalEntry 45 */ 46published interface XSheetConditionalEntries: com::sun::star::container::XIndexAccess 47{ 48 //------------------------------------------------------------------------- 49 50 /** adds a conditional entry to the format. 51 52 <p>Supported properties are:</p> 53 54 <dl> 55 <dt><type>ConditionOperator</type> Operator</dt> 56 <dd>contains the operation to perform for this condition.</dd> 57 58 <dt><atom>string</atom> Formula1</dt> 59 <dd>contains the value or formula for the operation.</dd> 60 61 <dt><atom>string</atom> Formula2</dt> 62 <dd>contains the second value or formula for the operation (used with 63 <const>ConditionOperator::BETWEEN</const> or 64 <const>ConditionOperator::NOT_BETWEEN</const> operations).</dd> 65 66 <dt><type scope="com::sun::star::table">CellAddress</type> 67 SourcePosition</dt> 68 <dd>contains the base address for relative cell references in formulas. 69 </dd> 70 71 <dt><atom>string</atom> StyleName</dt> 72 <dd>contains the name of the cell style used by this condition.</dd> 73 </dl> 74 75 @see com::sun::star::sheet::TableConditionalFormat 76 */ 77 void addNew( [in] sequence< com::sun::star::beans::PropertyValue > aConditionalEntry ); 78 79 //------------------------------------------------------------------------- 80 81 /** removes a conditional entry from the format. 82 */ 83 void removeByIndex( [in] long nIndex ); 84 85 //------------------------------------------------------------------------- 86 87 /** clears all condition entries. 88 */ 89 void clear(); 90 91}; 92 93//============================================================================= 94 95}; }; }; }; 96 97#endif 98 99