1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XScenario_idl__ 24cdf0e10cSrcweir#define __com_sun_star_sheet_XScenario_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_table_CellRangeAddress_idl__ 31cdf0e10cSrcweir#include <com/sun/star/table/CellRangeAddress.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweirmodule com { module sun { module star { module sheet { 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweir/** provides access to the settings of a scenario sheet. 42cdf0e10cSrcweir 43cdf0e10cSrcweir @see com::sun::star::sheet::Spreadsheet 44cdf0e10cSrcweir */ 45cdf0e10cSrcweirpublished interface XScenario: com::sun::star::uno::XInterface 46cdf0e10cSrcweir{ 47cdf0e10cSrcweir //------------------------------------------------------------------------- 48cdf0e10cSrcweir 49cdf0e10cSrcweir /** returns <TRUE/> if the current object is a scenario. 50cdf0e10cSrcweir */ 51cdf0e10cSrcweir boolean getIsScenario(); 52cdf0e10cSrcweir 53cdf0e10cSrcweir //------------------------------------------------------------------------- 54cdf0e10cSrcweir 55cdf0e10cSrcweir /** returns the comment for the scenario. 56cdf0e10cSrcweir */ 57cdf0e10cSrcweir string getScenarioComment(); 58cdf0e10cSrcweir 59cdf0e10cSrcweir //------------------------------------------------------------------------- 60cdf0e10cSrcweir 61cdf0e10cSrcweir /** sets a new comment for the scenario. 62cdf0e10cSrcweir */ 63cdf0e10cSrcweir void setScenarioComment( [in] string aScenarioComment ); 64cdf0e10cSrcweir 65cdf0e10cSrcweir //------------------------------------------------------------------------- 66cdf0e10cSrcweir 67cdf0e10cSrcweir /** adds more ranges to the scenario. 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir void addRanges( 70cdf0e10cSrcweir [in] sequence< com::sun::star::table::CellRangeAddress > aRanges ); 71cdf0e10cSrcweir 72cdf0e10cSrcweir //------------------------------------------------------------------------- 73cdf0e10cSrcweir 74cdf0e10cSrcweir /** applies the scenario. 75cdf0e10cSrcweir 76cdf0e10cSrcweir <p>The contents of the scenario ranges are copied into the first 77cdf0e10cSrcweir non-scenario sheet which is in front of the sheet containing 78cdf0e10cSrcweir the scenario by itself.</p> 79cdf0e10cSrcweir */ 80cdf0e10cSrcweir void apply(); 81cdf0e10cSrcweir 82cdf0e10cSrcweir}; 83cdf0e10cSrcweir 84cdf0e10cSrcweir//============================================================================= 85cdf0e10cSrcweir 86cdf0e10cSrcweir}; }; }; }; 87cdf0e10cSrcweir 88cdf0e10cSrcweir#endif 89cdf0e10cSrcweir 90