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#ifndef __com_sun_star_sheet_XScenario_idl__ 24#define __com_sun_star_sheet_XScenario_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_table_CellRangeAddress_idl__ 31#include <com/sun/star/table/CellRangeAddress.idl> 32#endif 33 34 35//============================================================================= 36 37module com { module sun { module star { module sheet { 38 39//============================================================================= 40 41/** provides access to the settings of a scenario sheet. 42 43 @see com::sun::star::sheet::Spreadsheet 44 */ 45published interface XScenario: com::sun::star::uno::XInterface 46{ 47 //------------------------------------------------------------------------- 48 49 /** returns <TRUE/> if the current object is a scenario. 50 */ 51 boolean getIsScenario(); 52 53 //------------------------------------------------------------------------- 54 55 /** returns the comment for the scenario. 56 */ 57 string getScenarioComment(); 58 59 //------------------------------------------------------------------------- 60 61 /** sets a new comment for the scenario. 62 */ 63 void setScenarioComment( [in] string aScenarioComment ); 64 65 //------------------------------------------------------------------------- 66 67 /** adds more ranges to the scenario. 68 */ 69 void addRanges( 70 [in] sequence< com::sun::star::table::CellRangeAddress > aRanges ); 71 72 //------------------------------------------------------------------------- 73 74 /** applies the scenario. 75 76 <p>The contents of the scenario ranges are copied into the first 77 non-scenario sheet which is in front of the sheet containing 78 the scenario by itself.</p> 79 */ 80 void apply(); 81 82}; 83 84//============================================================================= 85 86}; }; }; }; 87 88#endif 89 90