xref: /trunk/main/offapi/com/sun/star/sheet/Scenario.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_Scenario_idl__
25#define __com_sun_star_sheet_Scenario_idl__
26
27#ifndef __com_sun_star_sheet_XScenario_idl__
28#include <com/sun/star/sheet/XScenario.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XScenarioEnhanced_idl__
32#include <com/sun/star/sheet/XScenarioEnhanced.idl>
33#endif
34
35#ifndef __com_sun_star_beans_XPropertySet_idl__
36#include <com/sun/star/beans/XPropertySet.idl>
37#endif
38
39#ifndef __com_sun_star_container_XNamed_idl__
40#include <com/sun/star/container/XNamed.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sheet {
46
47//=============================================================================
48
49/** represents a scenario in a spreadsheet document.
50
51 */
52service Scenario
53{
54	interface com::sun::star::sheet::XScenario;
55
56	[optional] interface com::sun::star::sheet::XScenarioEnhanced;
57
58	interface com::sun::star::beans::XPropertySet;
59
60	interface com::sun::star::container::XNamed;
61
62	//-------------------------------------------------------------------------
63
64	/** specifies if the scenario is active.
65	 */
66	[optional, property] boolean IsActive;
67
68	//-------------------------------------------------------------------------
69
70	/** specifies the color of the border of the scenario.
71	 */
72	[optional, property] long BorderColor;
73
74	//-------------------------------------------------------------------------
75
76	/** specifies if the scenario is protected.
77	 */
78	[optional, property] boolean Protected;
79
80	//-------------------------------------------------------------------------
81
82	/** specifies if the scenario shows a border.
83	 */
84	[optional, property] boolean ShowBorder;
85
86	//-------------------------------------------------------------------------
87
88	/** specifies if the scenario prints a border.
89	 */
90	[optional, property] boolean PrintBorder;
91
92	//-------------------------------------------------------------------------
93
94	/** specifies if the data should be copied back into the scenario.
95	 */
96	[optional, property] boolean CopyBack;
97
98	//-------------------------------------------------------------------------
99
100	/** specifies if the styles are copied.
101	 */
102	[optional, property] boolean CopyStyles;
103
104	//-------------------------------------------------------------------------
105
106	/** specifies if the formulas are copied or only the results.
107	 */
108	[optional, property] boolean CopyFormulas;
109
110
111};
112
113//=============================================================================
114
115}; }; }; };
116
117#endif
118
119