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