offapi/com/sun/star/sheet/Scenario.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_Scenario_idl__
  29 #define __com_sun_star_sheet_Scenario_idl__
  30
  31 #ifndef __com_sun_star_sheet_XScenario_idl__
  32 #include <com/sun/star/sheet/XScenario.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_sheet_XScenarioEnhanced_idl__
  36 #include <com/sun/star/sheet/XScenarioEnhanced.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_beans_XPropertySet_idl__
  40 #include <com/sun/star/beans/XPropertySet.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_container_XNamed_idl__
  44 #include <com/sun/star/container/XNamed.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module sheet {
  50
  51 //=============================================================================
  52
  53 /** represents a scenario in a spreadsheet document.
  54
  55  */
  56 service Scenario
  57 {
  58     interface com::sun::star::sheet::XScenario;
  59
  60     [optional] interface com::sun::star::sheet::XScenarioEnhanced;
  61
  62     interface com::sun::star::beans::XPropertySet;
  63
  64     interface com::sun::star::container::XNamed;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** specifies if the scenario is active.
  69      */
  70     [optional, property] boolean IsActive;
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** specifies the color of the border of the scenario.
  75      */
  76     [optional, property] long BorderColor;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies if the scenario is protected.
  81      */
  82     [optional, property] boolean Protected;
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** specifies if the scenario shows a border.
  87      */
  88     [optional, property] boolean ShowBorder;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** specifies if the scenario prints a border.
  93      */
  94     [optional, property] boolean PrintBorder;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** specifies if the data should be copied back into the scenario.
  99      */
 100     [optional, property] boolean CopyBack;
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** specifies if the styles are copied.
 105      */
 106     [optional, property] boolean CopyStyles;
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** specifies if the formulas are copied or only the results.
 111      */
 112     [optional, property] boolean CopyFormulas;
 113
 114
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif
 122