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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XScenarios_idl__
  21 #define __com_sun_star_sheet_XScenarios_idl__
  22
  23 #include <com/sun/star/container/XNameAccess.idl>
  24 #include <com/sun/star/table/CellRangeAddress.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides access via name to the scenarios in a collection and inserting
  31     and removing scenarios.
  32
  33     @see com::sun::star::sheet::Scenarios
  34     @see com::sun::star::sheet::Spreadsheet
  35  */
  36 published interface XScenarios: com::sun::star::container::XNameAccess
  37 {
  38
  39     /** creates a new scenario and adds it to the collection.
  40
  41         @param aName
  42             the name of the scenario (used i.e. for collection access).
  43
  44         @param aRanges
  45             the cell ranges contained in the scenario.
  46
  47         @param aComment
  48             the user defined comment for the scenario.
  49      */
  50     void addNewByName(
  51             [in] string aName,
  52             [in] sequence< com::sun::star::table::CellRangeAddress > aRanges,
  53             [in] string aComment );
  54
  55
  56     /** removes a scenario from the collection.
  57      */
  58     void removeByName( [in] string aName );
  59
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */