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

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