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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_text_ViewSettings_idl__
#define __com_sun_star_text_ViewSettings_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/view/DocumentZoomType.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
module com { module sun { module star { module text {
/** provides access to the settings of the controller of a text document.
*/
published service ViewSettings
{
interface com::sun::star::beans::XPropertySet;
/** If this property is `TRUE`, annotations (notes) are visible.
*/
[property] boolean ShowAnnotations;
/** If this property is `TRUE`, paragraph line breaks are visible.
*/
[property] boolean ShowBreaks;
/** If this property is `TRUE`, shapes are visible.
*/
[property] boolean ShowDrawings;
/** If this property is `TRUE`, text fields are shown with their commands; otherwise
the content is visible.
*/
[property] boolean ShowFieldCommands;
/** If this property is `TRUE`, footnotes symbols are displayed with gray background.
*/
[property] boolean ShowFootnoteBackground;
/** If this property is `TRUE`, graphic objects are visible.
*/
[property] boolean ShowGraphics;
/** If this property is `TRUE`, hidden paragraphs are displayed.
*/
[property] boolean ShowHiddenParagraphs;
/** If this property is `TRUE`, hidden text is displayed.
*/
[property] boolean ShowHiddenText;
/** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
*/
[property] boolean ShowRulers;
/** If this property is `TRUE` and the property ShowRulers is `TRUE`,
the horizontal ruler is displayed.
*/
[property] boolean ShowHoriRuler;
/** If this property is `TRUE` and the property ShowRulers is `TRUE`,
the horizontal scroll bar is displayed.
*/
[property] boolean ShowHoriScrollBar;
/** If this property is `TRUE`, index marks are displayed with gray background.
*/
[property] boolean ShowIndexMarkBackground;
/** If this property is `TRUE`, paragraph breaks are visible.
*/
[property] boolean ShowParaBreaks;
/** If this property is `TRUE`, protected spaces (hard spaces) are displayed with gray
background.
*/
[property] boolean ShowProtectedSpaces;
/** If this property is `TRUE`, soft hyphens are displayed with gray background.
*/
[property] boolean ShowSoftHyphens;
/** If this property is `TRUE`, spaces are displayed with dots.
*/
[property] boolean ShowSpaces;
/** If this property is `TRUE`, table boundaries are displayed.
*/
[property] boolean ShowTableBoundaries;
/** If this property is `TRUE`, tables are visible.
*/
[property] boolean ShowTables;
/** If this property is `TRUE`, tab stops are visible.
*/
[property] boolean ShowTabstops;
/** If this property is `TRUE`, text boundaries are displayed.
*/
[property] boolean ShowTextBoundaries;
/** If this property is `TRUE`, text fields are displayed with gray background.
*/
[property] boolean ShowTextFieldBackground;
/** If this property is `TRUE`, the vertical ruler is displayed.
*/
[property] boolean ShowVertRuler;
/** If this property is `TRUE`, the vertical scroll bar is displayed.
*/
[property] boolean ShowVertScrollBar;
/** If this property is `TRUE`, smooth scrolling is active.
*/
[property] boolean SmoothScrolling;
/** If this property is `TRUE`, the vertical ruler is aligned to the right side
of the view and the vertical scrollbar is on the left.
*/
[property] boolean IsVertRulerRightAligned;
/** If this property is `TRUE` the document will be displayed as if it
were a HTML document.
*/
[property] boolean ShowOnlineLayout;
/** This property defines the zoom type for the document.
@see com::sun::star::view::DocumentZoomType
*/
[property] short ZoomType;
/** Defines the zoom value to use.
Valid only if the ZoomType is set to
com::sun::star::view::DocumentZoomType::BY_VALUE.
*/
[property] short ZoomValue;
/** If this property is `TRUE` hyperlinks in the document are executed (loaded) on
mouse click. Otherwise they are handled like normal text.
*/
[optional, property] boolean IsExecuteHyperlinks;
/** Specifies whether to display the grid or not
@since OOo 2.0
*/
[optional, property] boolean IsRasterVisible;
/** Specifies whether to move frames, drawing elements, and form
functions only between grid points.
@since OOo 2.0
*/
[optional, property] boolean IsSnapToRaster;
/** Specifies the number of intervals between grid points on the X-axis.
<p>The value must be greater or equal to 0, and the application
may enforce an upper bound for the value.</p>
@since OOo 2.0
@throws com::sun::star::lang::IllegalArgumentException
if the value is out of bounds.
*/
[optional, property] long RasterSubdivisionX;
/** Specifies the number of intervals between grid points on the Y-axis.
<p>The value must be greater or equal to 0, and the application
may enforce an upper bound for the value.</p>
@since OOo 2.0
@throws com::sun::star::lang::IllegalArgumentException
if the value is out of bounds.
*/
[optional, property] long RasterSubdivisionY;
/** Defines the unit of measure for the spacing between grid points
on the X-axis.
<p>The value must be greater than 0. The application
may enforce more restricting bounds for the value.</p>
@since OOo 2.0
@throws com::sun::star::lang::IllegalArgumentException
if the value is out of bounds.
*/
[optional, property] long RasterResolutionX;
/** Defines the unit of measure for the spacing between grid points
on the Y-axis.
<p>The value must be greater than 0. The application
may enforce more restricting bounds for the value.</p>
@since OOo 2.0
@throws com::sun::star::lang::IllegalArgumentException
if the value is out of bounds.
*/
[optional, property] long RasterResolutionY;
/** If this property is `TRUE`, hidden characters are displayed
@since OOo 3.0
*/
[optional, property] boolean ShowHiddenCharacters;
/** If this property is `TRUE`, the settings of non-printing characters are applied.
<p>This option controls the use of the settings ShowHiddenCharacters,
ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks </p>
@since OOo 3.0
*/
[optional, property] boolean ShowNonprintingCharacters;
/** metric unit of the horizontal ruler
<p>Uses values com::sun::star::awt::FieldUnit</p>
@since OOo 3.1
*/
[optional, property] long HorizontalRulerMetric;
/** metric unit of the vertical ruler
<p>Uses values from com::sun::star::awt::FieldUnit</p>
@since OOo 3.1
*/
[optional, property] long VerticalRulerMetric;
/** If this property is `TRUE`, tips for document content are shown,
typically in a help balloon when the mouse is over the content.
@since LibreOffice 4.1
*/
[optional, property] boolean ShowContentTips;
/** If this property is `TRUE`, and the scroll bar is shown, a tool tip
is displayed while scrolling.
@since LibreOffice 4.2
*/
[optional, property] boolean ShowScrollBarTips;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
