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_SpreadsheetDocumentSettings_idl__
25#define __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__
26
27#ifndef __com_sun_star_beans_XPropertySet_idl__
28#include <com/sun/star/beans/XPropertySet.idl>
29#endif
30
31#ifndef __com_sun_star_util_Date_idl__
32#include <com/sun/star/util/Date.idl>
33#endif
34
35#ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
36#include <com/sun/star/i18n/XForbiddenCharacters.idl>
37#endif
38
39#ifndef __com_sun_star_lang_Locale_idl__
40#include <com/sun/star/lang/Locale.idl>
41#endif
42
43#ifndef __com_sun_star_awt_XDevice_idl__
44#include <com/sun/star/awt/XDevice.idl>
45#endif
46
47//=============================================================================
48
49module com {  module sun {  module star {  module sheet {
50
51//=============================================================================
52
53/** contributes properties to control the configuration which is global
54	for all views of a spreadsheet document.
55
56	@deprecated
57
58	@see com::sun::star::sheet::SpreadsheetDocument
59 */
60published service SpreadsheetDocumentSettings
61{
62	//-------------------------------------------------------------------------
63
64//!published service PropertySet
65	/** provides access to the properties.
66	 */
67	interface com::sun::star::beans::XPropertySet;
68
69	//=========================================================================
70
71	/** enables iterated calculation of circular references.
72	 */
73	[property] boolean IsIterationEnabled;
74
75	//-------------------------------------------------------------------------
76
77	/** specifies how many iterations are carried out.
78
79		<p>This setting is only used, if iteration is enabled using
80		<member>SpreadsheetDocumentSettings::IsIterationEnabled</member>.</p>
81	 */
82	[property] long IterationCount;
83
84	//-------------------------------------------------------------------------
85
86	/** specifies the point at which a change in results will stop
87		the iteration.
88
89		<p>More exactly it specifies a difference in the change of the
90		result between two iterations. If the result difference
91		is less than or equal to this epsilon-value, the iteration
92		is stopped.</p>
93
94		<p>This setting is only used, if iteration is enabled using
95		<member>SpreadsheetDocumentSettings::IsIterationEnabled</member>.</p>
96	 */
97	[property] double IterationEpsilon;
98
99	//-------------------------------------------------------------------------
100
101	/** specifies the number of decimals in the default number format.
102	 */
103	[property] short StandardDecimals;
104
105	//-------------------------------------------------------------------------
106
107	/** specifies the date that is represented by the value zero.
108	 */
109	[property] com::sun::star::util::Date NullDate;
110
111	//-------------------------------------------------------------------------
112
113	/** specifies the width of default tabulators.
114	 */
115	[property] short DefaultTabStop;
116
117	//-------------------------------------------------------------------------
118
119	/** specifies whether upper and lower cases are treated as equal
120		when comparing cells.
121	 */
122	[property] boolean IgnoreCase;
123
124	//-------------------------------------------------------------------------
125
126	/** specifies whether calculations are performed with the rounded
127		values displayed in cells (set to <TRUE/>) instead of the
128		internal values (set to <FALSE/>).
129	 */
130	[property] boolean CalcAsShown;
131
132	//-------------------------------------------------------------------------
133
134	/** specifies whether filter criteria must match entire cell contents.
135	 */
136	[property] boolean MatchWholeCell;
137
138	//-------------------------------------------------------------------------
139
140	/** enables online spell checking.
141	 */
142	[property] boolean SpellOnline;
143
144	//-------------------------------------------------------------------------
145
146	/** specifies whether column or row labels are looked up from
147		anywhere on the sheet.
148
149		<p>Explicitly defined label ranges are used even if this property
150		is set to <FALSE/>.</p>
151
152		@see com::sun::star::sheet::LabelRanges
153	 */
154	[property] boolean LookUpLabels;
155
156	//-------------------------------------------------------------------------
157
158    /** specifies whether regular expressions in formulas are enabled,
159        e.g., for functions which look up spreadsheet contents.
160     */
161    [property] boolean RegularExpressions;
162
163	//-------------------------------------------------------------------------
164
165    /** contains the interface XForbiddenCharacters.
166     */
167    [readonly, optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
168
169	//-------------------------------------------------------------------------
170
171    /** If this property is set the document has DrawPages. Use this
172		property to find out, whether the document has DrawPages or not,
173		because the getDrawPage method on the XDrawPageSupplier and the
174		getDrawPages method on the XDrawPagesSupplier always creates the
175		DrawPages if there are none; and this is very slow and needs more
176		memory.
177     */
178    [readonly, optional, property] boolean HasDrawPages;
179
180	//-------------------------------------------------------------------------
181
182	/** contains the standard document language for Western text.
183	 */
184	[optional, property] com::sun::star::lang::Locale CharLocale;
185
186	//-------------------------------------------------------------------------
187
188	/** contains the standard document language for Asian text.
189	 */
190	[optional, property] com::sun::star::lang::Locale CharLocaleAsian;
191
192	//-------------------------------------------------------------------------
193
194	/** contains the standard document language for Complex text.
195	 */
196	[optional, property] com::sun::star::lang::Locale CharLocaleComplex;
197
198    //-------------------------------------------------------------------------
199
200    /** specifies whether the document data are already loaded.
201
202        @since OOo 3.0
203     */
204    [optional, property] boolean IsLoaded;
205
206    //-------------------------------------------------------------------------
207
208    /** specifies whether the undo command is enabled.
209
210        @since OOo 3.0
211     */
212    [optional, property] boolean IsUndoEnabled;
213
214    //-------------------------------------------------------------------------
215
216    /** specifies whether the automatic adjustment of the row height is
217        enabled.
218
219        @since OOo 3.0
220     */
221    [optional, property] boolean IsAdjustHeightEnabled;
222
223    //-------------------------------------------------------------------------
224
225    /** specifies whether the automatic execution of links is enabled.
226
227        @since OOo 3.0
228     */
229    [optional, property] boolean IsExecuteLinkEnabled;
230
231    //-------------------------------------------------------------------------
232
233    /** contains the reference device used for formatting the document.
234
235        @since OOo 3.0
236     */
237    [readonly, optional, property] com::sun::star::awt::XDevice ReferenceDevice;
238
239};
240
241//=============================================================================
242
243}; }; }; };
244
245#endif
246
247