offapi/com/sun/star/sheet/XScenarios.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: XScenarios.idl,v $
  10  * $Revision: 1.9 $
  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
  31 #ifndef __com_sun_star_sheet_XScenarios_idl__
  32 #define __com_sun_star_sheet_XScenarios_idl__
  33
  34 #ifndef __com_sun_star_container_XNameAccess_idl__
  35 #include <com/sun/star/container/XNameAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  39 #include <com/sun/star/table/CellRangeAddress.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides access via name to the scenarios in a collection and inserting
  49     and removing scenarios.
  50
  51     @see com::sun::star::sheet::Scenarios
  52     @see com::sun::star::sheet::Spreadsheet
  53  */
  54 published interface XScenarios: com::sun::star::container::XNameAccess
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** creates a new scenario and adds it to the collection.
  59
  60         @param aName
  61             the name of the scenario (used i.e. for collection access).
  62
  63         @param aRanges
  64             the cell ranges contained in the scenario.
  65
  66         @param aComment
  67             the user defined comment for the scenario.
  68      */
  69     void addNewByName(
  70             [in] string aName,
  71             [in] sequence< com::sun::star::table::CellRangeAddress > aRanges,
  72             [in] string aComment );
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** removes a scenario from the collection.
  77      */
  78     void removeByName( [in] string aName );
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif
  87