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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Scenario.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_Scenario_idl__
  32 #define __com_sun_star_sheet_Scenario_idl__
  33
  34 #ifndef __com_sun_star_sheet_XScenario_idl__
  35 #include <com/sun/star/sheet/XScenario.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XScenarioEnhanced_idl__
  39 #include <com/sun/star/sheet/XScenarioEnhanced.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_XPropertySet_idl__
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_container_XNamed_idl__
  47 #include <com/sun/star/container/XNamed.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** represents a scenario in a spreadsheet document.
  57
  58  */
  59 service Scenario
  60 {
  61     interface com::sun::star::sheet::XScenario;
  62
  63     [optional] interface com::sun::star::sheet::XScenarioEnhanced;
  64
  65     interface com::sun::star::beans::XPropertySet;
  66
  67     interface com::sun::star::container::XNamed;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** specifies if the scenario is active.
  72      */
  73     [optional, property] boolean IsActive;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** specifies the color of the border of the scenario.
  78      */
  79     [optional, property] long BorderColor;
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** specifies if the scenario is protected.
  84      */
  85     [optional, property] boolean Protected;
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** specifies if the scenario shows a border.
  90      */
  91     [optional, property] boolean ShowBorder;
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** specifies if the scenario prints a border.
  96      */
  97     [optional, property] boolean PrintBorder;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** specifies if the data should be copied back into the scenario.
 102      */
 103     [optional, property] boolean CopyBack;
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** specifies if the styles are copied.
 108      */
 109     [optional, property] boolean CopyStyles;
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** specifies if the formulas are copied or only the results.
 114      */
 115     [optional, property] boolean CopyFormulas;
 116
 117
 118 };
 119
 120 //=============================================================================
 121
 122 }; }; }; };
 123
 124 #endif
 125