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