1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_sheet_XScenario_idl__ 28#define __com_sun_star_sheet_XScenario_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_table_CellRangeAddress_idl__ 35#include <com/sun/star/table/CellRangeAddress.idl> 36#endif 37 38 39//============================================================================= 40 41module com { module sun { module star { module sheet { 42 43//============================================================================= 44 45/** provides access to the settings of a scenario sheet. 46 47 @see com::sun::star::sheet::Spreadsheet 48 */ 49published interface XScenario: com::sun::star::uno::XInterface 50{ 51 //------------------------------------------------------------------------- 52 53 /** returns <TRUE/> if the current object is a scenario. 54 */ 55 boolean getIsScenario(); 56 57 //------------------------------------------------------------------------- 58 59 /** returns the comment for the scenario. 60 */ 61 string getScenarioComment(); 62 63 //------------------------------------------------------------------------- 64 65 /** sets a new comment for the scenario. 66 */ 67 void setScenarioComment( [in] string aScenarioComment ); 68 69 //------------------------------------------------------------------------- 70 71 /** adds more ranges to the scenario. 72 */ 73 void addRanges( 74 [in] sequence< com::sun::star::table::CellRangeAddress > aRanges ); 75 76 //------------------------------------------------------------------------- 77 78 /** applies the scenario. 79 80 <p>The contents of the scenario ranges are copied into the first 81 non-scenario sheet which is in front of the sheet containing 82 the scenario by itself.</p> 83 */ 84 void apply(); 85 86}; 87 88//============================================================================= 89 90}; }; }; }; 91 92#endif 93 94