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#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>
28#endif
29#ifndef __com_sun_star_view_DocumentZoomType_idl__
30#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>
34#endif
35
36//=============================================================================
37
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{
47	// DocMerge: empty anyway
48	interface com::sun::star::beans::XPropertySet;
49
50	//-------------------------------------------------------------------------
51
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;
56
57	//-------------------------------------------------------------------------
58
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;
63
64	//-------------------------------------------------------------------------
65
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;
70
71	//-------------------------------------------------------------------------
72
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;
78
79	//-------------------------------------------------------------------------
80
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;
85
86	//-------------------------------------------------------------------------
87
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;
92
93	//-------------------------------------------------------------------------
94
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;
99
100	//-------------------------------------------------------------------------
101
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;
106
107	//-------------------------------------------------------------------------
108
109         /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
110         */
111        [property] boolean ShowRulers;
112
113        //-------------------------------------------------------------------------
114
115        /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
116           the horizontal ruler is displayed.
117	 */
118	[property] boolean ShowHoriRuler;
119
120	//-------------------------------------------------------------------------
121
122        /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
123           the horizontal scroll bar is displayed.
124	 */
125	[property] boolean ShowHoriScrollBar;
126
127	//-------------------------------------------------------------------------
128
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;
133
134	//-------------------------------------------------------------------------
135
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.
228	 */
229    [property] boolean IsVertRulerRightAligned;
230
231    //-------------------------------------------------------------------------
232    /** If this property is <TRUE/> the document will be displayed as if it
233        were a HTML document.
234	 */
235    [property] boolean ShowOnlineLayout;
236
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
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>.
248	 */
249    [property] short ZoomValue;
250    //-------------------------------------------------------------------------
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
256    //-------------------------------------------------------------------------
257    /** Specifies whether to display the grid or not
258
259        @since OOo 2.0
260     */
261    [optional, property] boolean IsRasterVisible;
262
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
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
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
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
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
321    //-------------------------------------------------------------------------
322    /** If this property is <TRUE/>, hidden characters are displayed
323
324        @since OOo 3.0
325     */
326    [optional, property] boolean ShowHiddenCharacters;
327    //-------------------------------------------------------------------------
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;
336    //-------------------------------------------------------------------------
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;
344    //-------------------------------------------------------------------------
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;
352    //-------------------------------------------------------------------------
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
356        @since Apache OpenOffice 3.5
357     */
358    [optional, property] boolean ShowContentTips;
359};
360
361//=============================================================================
362
363}; }; }; };
364
365#endif
366