offapi/com/sun/star/sheet/Scenario.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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a scenario in a spreadsheet document.
  25
  26  */
  27 service Scenario
  28 {
  29     interface com::sun::star::sheet::XScenario;
  30
  31     [optional] interface com::sun::star::sheet::XScenarioEnhanced;
  32
  33     interface com::sun::star::beans::XPropertySet;
  34
  35     interface com::sun::star::container::XNamed;
  36
  37
  38     /** specifies if the scenario is active.
  39      */
  40     [optional, property] boolean IsActive;
  41
  42
  43     /** specifies the color of the border of the scenario.
  44      */
  45     [optional, property] long BorderColor;
  46
  47
  48     /** specifies if the scenario is protected.
  49      */
  50     [optional, property] boolean Protected;
  51
  52
  53     /** specifies if the scenario shows a border.
  54      */
  55     [optional, property] boolean ShowBorder;
  56
  57
  58     /** specifies if the scenario prints a border.
  59      */
  60     [optional, property] boolean PrintBorder;
  61
  62
  63     /** specifies if the data should be copied back into the scenario.
  64      */
  65     [optional, property] boolean CopyBack;
  66
  67
  68     /** specifies if the styles are copied.
  69      */
  70     [optional, property] boolean CopyStyles;
  71
  72
  73     /** specifies if the formulas are copied or only the results.
  74      */
  75     [optional, property] boolean CopyFormulas;
  76
  77
  78 };
  79
  80
  81 }; }; }; };
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */