offapi/com/sun/star/sheet/XScenario.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 #ifndef __com_sun_star_sheet_XScenario_idl__
  20 #define __com_sun_star_sheet_XScenario_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/table/CellRangeAddress.idl>
  24
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides access to the settings of a scenario sheet.
  31
  32     @see com::sun::star::sheet::Spreadsheet
  33  */
  34 published interface XScenario: com::sun::star::uno::XInterface
  35 {
  36
  37     /** returns `TRUE` if the current object is a scenario.
  38      */
  39     boolean getIsScenario();
  40
  41
  42     /** returns the comment for the scenario.
  43      */
  44     string getScenarioComment();
  45
  46
  47     /** sets a new comment for the scenario.
  48      */
  49     void setScenarioComment( [in] string aScenarioComment );
  50
  51
  52     /** adds more ranges to the scenario.
  53      */
  54     void addRanges(
  55             [in] sequence< com::sun::star::table::CellRangeAddress > aRanges );
  56
  57
  58     /** applies the scenario.
  59
  60         <p>The contents of the scenario ranges are copied into the first
  61         non-scenario sheet which is in front of the sheet containing
  62         the scenario by itself.</p>
  63      */
  64     void apply();
  65
  66 };
  67
  68
  69 }; }; }; };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */