1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_document_Settings_idl__
#define __com_sun_star_document_Settings_idl__
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
#include <com/sun/star/i18n/XForbiddenCharacters.idl>
#endif
//=============================================================================
module com { module sun { module star { module document {
//=============================================================================
/** describes properties that apply to the whole document of any
application.
<p>For application specific settings, please refer to the
individual services.</p>
@see com::sun::star::text::DocumentSettings
@see com::sun::star::sheet::DocumentSettings
@see com::sun::star::drawing::DocumentSettings
@see com::sun::star::presentation::DocumentSettings
*/
published service Settings
{
/** gives access to the properties implemented by this service.
*/
interface com::sun::star::beans::XPropertySet;
//-------------------------------------------------------------------------
// Note: These settings are global. However there is a note at
// every property that shows which application currently makes use
// of it.
// Writer and Draw/Impress and Calc
//-------------------------------------------------------------------------
/** gives access to the set of forbidden characters.
@return the
<type scope="com::sun::star::i18n">XForbiddenCharacters</type>
interface to allow retrieval and modification of the
forbidden characters set.
*/
[optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
// Writer and Calc
//-------------------------------------------------------------------------
/** specifies the update mode for links when loading text documents.
<p>For supported values see the constants group
<type>LinkUpdateModes</type>.</p>
*/
[optional, property] short LinkUpdateMode;
// Writer and Draw/Impress and Calc
//-------------------------------------------------------------------------
/** printer used by the document.
*/
[property] string PrinterName;
// Writer and Draw/Impress and Calc
//-------------------------------------------------------------------------
/** platform and driver dependent printer setup data.
<p>This property serves to capture the current printer setup
settings, such as paper tray, printer options, etc. The data
can typically be interpreted only by the system that generated
it. The PrinterSetup property may be used to save and restore
the user's printer settings.</p>
*/
[property] sequence< byte > PrinterSetup;
// Writer and Draw/Impress and Calc
//-------------------------------------------------------------------------
/** specifies if kerning is applied to Asian punctuation.
<p>Applies only if kerning is enabled.</p>
*/
[optional, property] boolean IsKernAsianPunctuation;
// Writer and Draw/Impress and Calc
//-------------------------------------------------------------------------
/** specifies the compression (character spacing) type used for
Asian characters.
@see com::sun::star::text::CharacterCompressionType
*/
[optional, property] short CharacterCompressionType;
// Writer and Draw/Impress and Calc
//-------------------------------------------------------------------------
/** specifies if the user-specific settings saved within a
document should be loaded with the document.
*/
[optional, property] boolean ApplyUserData;
// Writer and Calc
//-------------------------------------------------------------------------
/** specifies if a new version is created if a document has
been modified and you want to close it.
*/
[optional, property] boolean SaveVersionOnClose;
// Writer and Draw/Impress and Calc
//-------------------------------------------------------------------------
/** specifies if the document should be updated when the
template it was created from changes.
<p>Applies only for documents that were created from a template.</p>
*/
[optional, property] boolean UpdateFromTemplate;
// Writer
//-------------------------------------------------------------------------
/** specifies if fields in text documents are updated automatically.
*/
[optional, property] boolean FieldAutoUpdate;
// Writer
//-------------------------------------------------------------------------
/** The name of the globally registered
<type scope="com::sun::star::sdb">DataSource</type>
from which the current data is taken.
<p>The data source can e.g. be used for feeding a form
letter.</p>
*/
[optional, property] string CurrentDatabaseDataSource;
// Writer
//-------------------------------------------------------------------------
/** a string value, specifying the name of the object displayed
currently (or the SQL statement used).
*/
[optional, property] string CurrentDatabaseCommand;
// Writer
//-------------------------------------------------------------------------
// Note: What is the property DataTableName? Is this Writer-specific?
/** determines the interpretation of the property DataTableName.
@see com::sun::star::sdb::CommandType
*/
[optional, property] long CurrentDatabaseCommandType;
// Draw and Impress
//-------------------------------------------------------------------------
/**
*/
[optional, property] long DefaultTabStop;
// Draw and Impress
//-------------------------------------------------------------------------
/** determines if the document will be printed as a booklet
(brochure), i.e., two document pages are put together on one
physical page, such that you can fold the print result and get
a booklet.
<p>Note, that you have to print in duplex mode, if both,
<member>IsPrintBookletFront</member> and
<member>IsPrintBookletBack</member> are set to <TRUE/>.</p>
*/
[optional, property] boolean IsPrintBooklet;
// Draw and Impress
//-------------------------------------------------------------------------
/** is only effective, if <member>IsPrintBooklet</member> is
<TRUE/>. If this property is also <TRUE/>, only the fronts of
the pages of your booklet are printed.
<p>This is especially useful, if your printer does not supply
duplex printing.</p>
*/
[optional, property] boolean IsPrintBookletFront;
// Draw and Impress
//-------------------------------------------------------------------------
/** is only effective, if <member>IsPrintBooklet</member> is
<TRUE/>. If this property is also <TRUE/>, only the backs of
the pages of your booklet are printed.
<p>This is especially useful, if your printer does not supply
duplex printing.</p>
*/
[optional, property] boolean IsPrintBookletBack;
// Draw and Impress
//-------------------------------------------------------------------------
// Note: Define a constant group for that?
/**
*/
[optional, property] long PrintQuality;
// Draw and Impress
//-------------------------------------------------------------------------
/** contains the URL that points to a color table (file extension
.soc) that will be used for showing a palette in dialogs using
colors.
*/
[optional, property] string ColorTableURL;
// Draw and Impress
//-------------------------------------------------------------------------
/**
*/
[optional, property] string DashTableURL;
// Draw and Impress
//-------------------------------------------------------------------------
/**
*/
[optional, property] string LineEndTableURL;
// Draw and Impress
//-------------------------------------------------------------------------
/**
*/
[optional, property] string HatchTableURL;
// Draw and Impress
//-------------------------------------------------------------------------
/**
*/
[optional, property] string GradientTableURL;
// Draw and Impress
//-------------------------------------------------------------------------
/**
*/
[optional, property] string BitmapTableURL;
// Calc
//-------------------------------------------------------------------------
/**
*/
[optional, property] boolean AutoCalculate;
// Writer, later others
//-------------------------------------------------------------------------
/** forbid use of printer metrics for layout
<p>For supported values see the constants group
<type>PrinterIndependentLayout</type>.</p>
*/
[optional, property] short PrinterIndependentLayout;
// Writer, maybe later other applications, too
//-------------------------------------------------------------------------
/** layout engine should add value of a Font's 'external leading'
* attribute to the line spacing.
*/
[optional, property] boolean AddExternalLeading;
};
//=============================================================================
}; }; }; };
#endif
|