ViewSettings.idl (ef785786) ViewSettings.idl (a41e6500)
1/**************************************************************
1/**************************************************************
2 *
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
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 *
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
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.
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 *
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_ViewSettings_idl__
24#define __com_sun_star_text_ViewSettings_idl__
25
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_ViewSettings_idl__
24#define __com_sun_star_text_ViewSettings_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
26#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29#ifndef __com_sun_star_view_DocumentZoomType_idl__
30#include <com/sun/star/view/DocumentZoomType.idl>
27#include <com/sun/star/view/DocumentZoomType.idl>
31#endif
32#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
33#include <com/sun/star/lang/IllegalArgumentException.idl>
28#include <com/sun/star/lang/IllegalArgumentException.idl>
34#endif
35
29
36//=============================================================================
30module com { module sun { module star { module text {
37
31
38 module com { module sun { module star { module text {
39
40//=============================================================================
41
42// DocMerge from xml: service com::sun::star::text::ViewSettings
43/** provides access to the settings of the controller of a text document.
44 */
45published service ViewSettings
46{
32// DocMerge from xml: service com::sun::star::text::ViewSettings
33/** provides access to the settings of the controller of a text document.
34 */
35published service ViewSettings
36{
47 // DocMerge: empty anyway
48 interface com::sun::star::beans::XPropertySet;
37 interface com::sun::star::beans::XPropertySet;
49
38
50 //-------------------------------------------------------------------------
39 /** If this property is <TRUE/>, annotations (notes) are visible.
40 */
41 [property] boolean ShowAnnotations;
51
42
52 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowAnnotations
53 /** If this property is <TRUE/>, annotations (notes) are visible.
54 */
55 [property] boolean ShowAnnotations;
43 /** If this property is <TRUE/>, paragraph line breaks are visible.
44 */
45 [property] boolean ShowBreaks;
56
46
57 //-------------------------------------------------------------------------
47 /** If this property is <TRUE/>, shapes are visible.
48 */
49 [property] boolean ShowDrawings;
58
50
59 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowBreaks
60 /** If this property is <TRUE/>, paragraph line breaks are visible.
61 */
62 [property] boolean ShowBreaks;
51 /** If this property is <TRUE/>, text fields are shown with their commands; otherwise
52 the content is visible.
53 */
54 [property] boolean ShowFieldCommands;
63
55
64 //-------------------------------------------------------------------------
56 /** If this property is <TRUE/>, footnotes symbols are displayed with gray background.
57 */
58 [property] boolean ShowFootnoteBackground;
65
59
66 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFieldCommandsShowDrawings
67 /** If this property is <TRUE/>, shapes are visible.
68 */
69 [property] boolean ShowDrawings;
60 /** If this property is <TRUE/>, graphic objects are visible.
61 */
62 [property] boolean ShowGraphics;
70
63
71 //-------------------------------------------------------------------------
64 /** If this property is <TRUE/>, hidden paragraghs are displayed.
65 */
66 [property] boolean ShowHiddenParagraphs;
72
67
73 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFieldCommands
74 /** If this property is <TRUE/>, text fields are shown with their commands; otherwise
75 the content is visible.
76 */
77 [property] boolean ShowFieldCommands;
68 /** If this property is <TRUE/>, hidden text is displayed.
69 */
70 [property] boolean ShowHiddenText;
78
71
79 //-------------------------------------------------------------------------
72 /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
73 */
74 [property] boolean ShowRulers;
80
75
81 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFootnoteBackground
82 /** If this property is <TRUE/>, footnotes symbols are displayed with gray background.
83 */
84 [property] boolean ShowFootnoteBackground;
76 /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
77 the horizontal ruler is displayed.
78 */
79 [property] boolean ShowHoriRuler;
85
80
86 //-------------------------------------------------------------------------
81 /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
82 the horizontal scroll bar is displayed.
83 */
84 [property] boolean ShowHoriScrollBar;
87
85
88 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowGraphics
89 /** If this property is <TRUE/>, graphic objects are visible.
90 */
91 [property] boolean ShowGraphics;
86 /** If this property is <TRUE/>, index marks are displayed with gray background.
87 */
88 [property] boolean ShowIndexMarkBackground;
92
89
93 //-------------------------------------------------------------------------
90 /** If this property is <TRUE/>, paragraph breaks are visible.
91 */
92 [property] boolean ShowParaBreaks;
94
93
95 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowHiddenParagraphs
96 /** If this property is <TRUE/>, hidden paragraghs are displayed.
97 */
98 [property] boolean ShowHiddenParagraphs;
94 /** If this property is <TRUE/>, protected spaces (hard spaces) are displayed with gray
95 background.
96 */
97 [property] boolean ShowProtectedSpaces;
99
98
100 //-------------------------------------------------------------------------
99 /** If this property is <TRUE/>, soft hyphens are displayed with gray background.
100 */
101 [property] boolean ShowSoftHyphens;
101
102
102 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowHiddenText
103 /** If this property is <TRUE/>, hidden text is displayed.
104 */
105 [property] boolean ShowHiddenText;
103 /** If this property is <TRUE/>, spaces are displayed with dots.
104 */
105 [property] boolean ShowSpaces;
106
106
107 //-------------------------------------------------------------------------
107 /** If this property is <TRUE/>, table boundaries are displayed.
108 */
109 [property] boolean ShowTableBoundaries;
108
110
109 /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
110 */
111 [property] boolean ShowRulers;
111 /** If this property is <TRUE/>, tables are visible.
112 */
113 [property] boolean ShowTables;
112
114
113 //-------------------------------------------------------------------------
115 /** If this property is <TRUE/>, tab stops are visible.
116 */
117 [property] boolean ShowTabstops;
114
118
115 /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
116 the horizontal ruler is displayed.
117 */
118 [property] boolean ShowHoriRuler;
119 /** If this property is <TRUE/>, text boundaries are displayed.
120 */
121 [property] boolean ShowTextBoundaries;
119
122
120 //-------------------------------------------------------------------------
123 /** If this property is <TRUE/>, text fields are displayed with gray background.
124 */
125 [property] boolean ShowTextFieldBackground;
121
126
122 /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
123 the horizontal scroll bar is displayed.
124 */
125 [property] boolean ShowHoriScrollBar;
127 /** If this property is <TRUE/>, the vertical ruler is displayed.
128 */
129 [property] boolean ShowVertRuler;
126
130
127 //-------------------------------------------------------------------------
131 /** If this property is <TRUE/>, the vertical scroll bar is displayed.
132 */
133 [property] boolean ShowVertScrollBar;
128
134
129 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowIndexMarkBackground
130 /** If this property is <TRUE/>, index marks are displayed with gray background.
131 */
132 [property] boolean ShowIndexMarkBackground;
135 /** If this property is <TRUE/>, smooth scrolling is active.
136 */
137 [property] boolean SmoothScrolling;
133
138
134 //-------------------------------------------------------------------------
139 /** If this property is <TRUE/>, handles of drawing objects are visible.
140 */
141 [property] boolean SolidMarkHandles;
135
142
136 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowParaBreaks
137 /** If this property is <TRUE/>, paragraph breaks are visible.
138 */
139 [property] boolean ShowParaBreaks;
140
141 //-------------------------------------------------------------------------
142
143 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowProtectedSpaces
144 /** If this property is <TRUE/>, protected spaces (hard spaces) are displayed with gray
145 background.
146 */
147 [property] boolean ShowProtectedSpaces;
148
149 //-------------------------------------------------------------------------
150
151 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowSoftHyphens
152 /** If this property is <TRUE/>, soft hyphens are displayed with gray background.
153 */
154 [property] boolean ShowSoftHyphens;
155
156 //-------------------------------------------------------------------------
157
158 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowSpaces
159 /** If this property is <TRUE/>, spaces are displayed with dots.
160 */
161 [property] boolean ShowSpaces;
162
163 //-------------------------------------------------------------------------
164
165 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTableBoundaries
166 /** If this property is <TRUE/>, table boundaries are displayed.
167 */
168 [property] boolean ShowTableBoundaries;
169
170 //-------------------------------------------------------------------------
171
172 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTables
173 /** If this property is <TRUE/>, tables are visible.
174 */
175 [property] boolean ShowTables;
176
177 //-------------------------------------------------------------------------
178
179 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTabstops
180 /** If this property is <TRUE/>, tab stops are visible.
181 */
182 [property] boolean ShowTabstops;
183
184 //-------------------------------------------------------------------------
185
186 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTextBoundaries
187 /** If this property is <TRUE/>, text boundaries are displayed.
188 */
189 [property] boolean ShowTextBoundaries;
190
191 //-------------------------------------------------------------------------
192
193 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTextFieldBackground
194 /** If this property is <TRUE/>, text fields are displayed with gray background.
195 */
196 [property] boolean ShowTextFieldBackground;
197
198 //-------------------------------------------------------------------------
199
200 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowVertRuler
201 /** If this property is <TRUE/>, the vertical ruler is displayed.
202 */
203 [property] boolean ShowVertRuler;
204
205 //-------------------------------------------------------------------------
206
207 // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowVertScrollBar
208 /** If this property is <TRUE/>, the vertical scroll bar is displayed.
209 */
210 [property] boolean ShowVertScrollBar;
211
212 //-------------------------------------------------------------------------
213
214 // DocMerge from xml: property com::sun::star::text::ViewSettings::SmoothScrolling
215 /** If this property is <TRUE/>, smooth scrolling is active.
216 */
217 [property] boolean SmoothScrolling;
218
219 //-------------------------------------------------------------------------
220
221 // DocMerge from xml: property com::sun::star::text::ViewSettings::SolidMarkHandles
222 /** If this property is <TRUE/>, handles of drawing objects are visible.
223 */
224 [property] boolean SolidMarkHandles;
225 //-------------------------------------------------------------------------
226 /** If this property is <TRUE/>, the vertical ruler is aligned to the right side
227 of the view and the vertical scrollbar is on the left.
143 /** If this property is <TRUE/>, the vertical ruler is aligned to the right side
144 of the view and the vertical scrollbar is on the left.
228 */
145 */
229 [property] boolean IsVertRulerRightAligned;
230
146 [property] boolean IsVertRulerRightAligned;
147
231 //-------------------------------------------------------------------------
232 /** If this property is <TRUE/> the document will be displayed as if it
233 were a HTML document.
148 /** If this property is <TRUE/> the document will be displayed as if it
149 were a HTML document.
234 */
150 */
235 [property] boolean ShowOnlineLayout;
236
151 [property] boolean ShowOnlineLayout;
152
237 //-------------------------------------------------------------------------
238 /** This property defines the zoom type for the document.
239
240 @see com::sun::star::view::DocumentZoomType
241 */
242 [property] short ZoomType;
243
153 /** This property defines the zoom type for the document.
154
155 @see com::sun::star::view::DocumentZoomType
156 */
157 [property] short ZoomType;
158
244 //-------------------------------------------------------------------------
245 /** Defines the zoom value to use.
246 Valid only if the ZoomType is set to
247 <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>.
159 /** Defines the zoom value to use.
160 Valid only if the ZoomType is set to
161 <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>.
248 */
162 */
249 [property] short ZoomValue;
163 [property] short ZoomValue;
250 //-------------------------------------------------------------------------
164
251 /** If this property is <TRUE/> hyperlinks in the document are executed (loaded) on
252 mouse click. Otherwise they are handled like normal text.
253 */
254 [optional, property] boolean IsExecuteHyperlinks;
255
165 /** If this property is <TRUE/> hyperlinks in the document are executed (loaded) on
166 mouse click. Otherwise they are handled like normal text.
167 */
168 [optional, property] boolean IsExecuteHyperlinks;
169
256 //-------------------------------------------------------------------------
257 /** Specifies whether to display the grid or not
258
259 @since OOo 2.0
260 */
261 [optional, property] boolean IsRasterVisible;
262
170 /** Specifies whether to display the grid or not
171
172 @since OOo 2.0
173 */
174 [optional, property] boolean IsRasterVisible;
175
263 //-------------------------------------------------------------------------
264 /** Specifies whether to move frames, drawing elements, and form
265 functions only between grid points.
266
267 @since OOo 2.0
268 */
269 [optional, property] boolean IsSnapToRaster;
270
176 /** Specifies whether to move frames, drawing elements, and form
177 functions only between grid points.
178
179 @since OOo 2.0
180 */
181 [optional, property] boolean IsSnapToRaster;
182
271 //-------------------------------------------------------------------------
272 /** Specifies the number of intervals between grid points on the X-axis.
273
274 <p>The value must be greater or equal to 0, and the application
275 may enforce an upper bound for the value.</p>
276
277 @since OOo 2.0
278 @throws com::sun::star::lang::IllegalArgumentException
279 if the value is out of bounds.
280 */
281 [optional, property] long RasterSubdivisionX;
282
183 /** Specifies the number of intervals between grid points on the X-axis.
184
185 <p>The value must be greater or equal to 0, and the application
186 may enforce an upper bound for the value.</p>
187
188 @since OOo 2.0
189 @throws com::sun::star::lang::IllegalArgumentException
190 if the value is out of bounds.
191 */
192 [optional, property] long RasterSubdivisionX;
193
283 //-------------------------------------------------------------------------
284 /** Specifies the number of intervals between grid points on the Y-axis.
285
286 <p>The value must be greater or equal to 0, and the application
287 may enforce an upper bound for the value.</p>
288
289 @since OOo 2.0
290 @throws com::sun::star::lang::IllegalArgumentException
291 if the value is out of bounds.
292 */
293 [optional, property] long RasterSubdivisionY;
294
194 /** Specifies the number of intervals between grid points on the Y-axis.
195
196 <p>The value must be greater or equal to 0, and the application
197 may enforce an upper bound for the value.</p>
198
199 @since OOo 2.0
200 @throws com::sun::star::lang::IllegalArgumentException
201 if the value is out of bounds.
202 */
203 [optional, property] long RasterSubdivisionY;
204
295 //-------------------------------------------------------------------------
296 /** Defines the unit of measure for the spacing between grid points
297 on the X-axis.
298
299 <p>The value must be greater than 0. The application
300 may enforce more restricting bounds for the value.</p>
301
302 @since OOo 2.0
303 @throws com::sun::star::lang::IllegalArgumentException
304 if the value is out of bounds.
305 */
306 [optional, property] long RasterResolutionX;
307
205 /** Defines the unit of measure for the spacing between grid points
206 on the X-axis.
207
208 <p>The value must be greater than 0. The application
209 may enforce more restricting bounds for the value.</p>
210
211 @since OOo 2.0
212 @throws com::sun::star::lang::IllegalArgumentException
213 if the value is out of bounds.
214 */
215 [optional, property] long RasterResolutionX;
216
308 //-------------------------------------------------------------------------
309 /** Defines the unit of measure for the spacing between grid points
310 on the Y-axis.
311
312 <p>The value must be greater than 0. The application
313 may enforce more restricting bounds for the value.</p>
314
315 @since OOo 2.0
316 @throws com::sun::star::lang::IllegalArgumentException
317 if the value is out of bounds.
318 */
319 [optional, property] long RasterResolutionY;
320
217 /** Defines the unit of measure for the spacing between grid points
218 on the Y-axis.
219
220 <p>The value must be greater than 0. The application
221 may enforce more restricting bounds for the value.</p>
222
223 @since OOo 2.0
224 @throws com::sun::star::lang::IllegalArgumentException
225 if the value is out of bounds.
226 */
227 [optional, property] long RasterResolutionY;
228
321 //-------------------------------------------------------------------------
322 /** If this property is <TRUE/>, hidden characters are displayed
323
324 @since OOo 3.0
325 */
326 [optional, property] boolean ShowHiddenCharacters;
229 /** If this property is <TRUE/>, hidden characters are displayed
230
231 @since OOo 3.0
232 */
233 [optional, property] boolean ShowHiddenCharacters;
327 //-------------------------------------------------------------------------
234
328 /** If this property is <TRUE/>, the settings of nonprinting characters are applied.
329
330 <p>This option controls the use of the settings ShowHiddenCharacters,
331 ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks </p>
332
333 @since OOo 3.0
334 */
335 [optional, property] boolean ShowNonprintingCharacters;
235 /** If this property is <TRUE/>, the settings of nonprinting characters are applied.
236
237 <p>This option controls the use of the settings ShowHiddenCharacters,
238 ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks </p>
239
240 @since OOo 3.0
241 */
242 [optional, property] boolean ShowNonprintingCharacters;
336 //-------------------------------------------------------------------------
243
337 /** metric unit of the horizontal ruler
338
339 <p>Uses values <type scope="com::sun::star::awt">FieldUnit</type></p>
340
341 @since OOo 3.1
342 */
343 [optional, property] long HorizontalRulerMetric;
244 /** metric unit of the horizontal ruler
245
246 <p>Uses values <type scope="com::sun::star::awt">FieldUnit</type></p>
247
248 @since OOo 3.1
249 */
250 [optional, property] long HorizontalRulerMetric;
344 //-------------------------------------------------------------------------
251
345 /** metric unit of the vertical ruler
346
347 <p>Uses values from <type scope="com::sun::star::awt">FieldUnit</type></p>
348
349 @since OOo 3.1
350 */
351 [optional, property] long VerticalRulerMetric;
252 /** metric unit of the vertical ruler
253
254 <p>Uses values from <type scope="com::sun::star::awt">FieldUnit</type></p>
255
256 @since OOo 3.1
257 */
258 [optional, property] long VerticalRulerMetric;
352 //-------------------------------------------------------------------------
259
353 /** If this property is <TRUE/>, tips for document content are shown,
354 typically in a help balloon when the mouse is over the content.
355
260 /** If this property is <TRUE/>, tips for document content are shown,
261 typically in a help balloon when the mouse is over the content.
262
356 @since Apache OpenOffice 3.5
263 @since Apache OpenOffice 4.0
357 */
358 [optional, property] boolean ShowContentTips;
264 */
265 [optional, property] boolean ShowContentTips;
359};
360
266
361//=============================================================================
267 /** If this property is <TRUE/>, and the scroll bar is shown, a tool tip
268 is displayed while scrolling.
362
269
270 @since Apache OpenOffice 4.0
271 */
272 [optional, property] boolean ShowScrollBarTips;
273};
274
363}; }; }; };
364
365#endif
275}; }; }; };
276
277#endif