offapi/com/sun/star/sheet/XScenario.idl

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