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#include <com/sun/star/beans/XPropertySet.idl>
27#include <com/sun/star/view/DocumentZoomType.idl>
28#include <com/sun/star/lang/IllegalArgumentException.idl>
29
30module com {  module sun {  module star {  module text {
31
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{
37    interface com::sun::star::beans::XPropertySet;
38
39    /** If this property is <TRUE/>, annotations (notes) are visible.
40     */
41    [property] boolean ShowAnnotations;
42
43    /** If this property is <TRUE/>, paragraph line breaks are visible.
44     */
45    [property] boolean ShowBreaks;
46
47    /** If this property is <TRUE/>, shapes are visible.
48     */
49    [property] boolean ShowDrawings;
50
51    /** If this property is <TRUE/>, text fields are shown with their commands; otherwise
52        the content is visible.
53     */
54    [property] boolean ShowFieldCommands;
55
56    /** If this property is <TRUE/>, footnotes symbols are displayed with gray background.
57     */
58    [property] boolean ShowFootnoteBackground;
59
60    /** If this property is <TRUE/>, graphic objects are visible.
61     */
62    [property] boolean ShowGraphics;
63
64    /** If this property is <TRUE/>, hidden paragraghs are displayed.
65     */
66    [property] boolean ShowHiddenParagraphs;
67
68    /** If this property is <TRUE/>, hidden text is displayed.
69     */
70    [property] boolean ShowHiddenText;
71
72    /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
73     */
74    [property] boolean ShowRulers;
75
76    /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
77        the horizontal ruler is displayed.
78     */
79    [property] boolean ShowHoriRuler;
80
81    /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
82        the horizontal scroll bar is displayed.
83     */
84    [property] boolean ShowHoriScrollBar;
85
86    /** If this property is <TRUE/>, index marks are displayed with gray background.
87     */
88    [property] boolean ShowIndexMarkBackground;
89
90    /** If this property is <TRUE/>, paragraph breaks are visible.
91     */
92    [property] boolean ShowParaBreaks;
93
94    /** If this property is <TRUE/>, protected spaces (hard spaces) are displayed with gray
95        background.
96     */
97    [property] boolean ShowProtectedSpaces;
98
99    /** If this property is <TRUE/>, soft hyphens are displayed with gray background.
100     */
101    [property] boolean ShowSoftHyphens;
102
103    /** If this property is <TRUE/>, spaces are displayed with dots.
104     */
105    [property] boolean ShowSpaces;
106
107    /** If this property is <TRUE/>, table boundaries are displayed.
108     */
109    [property] boolean ShowTableBoundaries;
110
111    /** If this property is <TRUE/>, tables are visible.
112     */
113    [property] boolean ShowTables;
114
115    /** If this property is <TRUE/>, tab stops are visible.
116     */
117    [property] boolean ShowTabstops;
118
119    /** If this property is <TRUE/>, text boundaries are displayed.
120     */
121    [property] boolean ShowTextBoundaries;
122
123    /** If this property is <TRUE/>, text fields are displayed with gray background.
124     */
125    [property] boolean ShowTextFieldBackground;
126
127    /** If this property is <TRUE/>, the vertical ruler is displayed.
128     */
129    [property] boolean ShowVertRuler;
130
131    /** If this property is <TRUE/>, the vertical scroll bar is displayed.
132     */
133    [property] boolean ShowVertScrollBar;
134
135    /** If this property is <TRUE/>, smooth scrolling is active.
136     */
137    [property] boolean SmoothScrolling;
138
139    /** If this property is <TRUE/>, handles of drawing objects are visible.
140     */
141    [property] boolean SolidMarkHandles;
142
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.
145     */
146    [property] boolean IsVertRulerRightAligned;
147
148    /** If this property is <TRUE/> the document will be displayed as if it
149        were a HTML document.
150     */
151    [property] boolean ShowOnlineLayout;
152
153    /** This property defines the zoom type for the document.
154
155        @see com::sun::star::view::DocumentZoomType
156     */
157    [property] short ZoomType;
158
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>.
162     */
163    [property] short ZoomValue;
164
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
170    /** Specifies whether to display the grid or not
171
172        @since OOo 2.0
173     */
174    [optional, property] boolean IsRasterVisible;
175
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
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
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
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
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
229    /** If this property is <TRUE/>, hidden characters are displayed
230
231        @since OOo 3.0
232     */
233    [optional, property] boolean ShowHiddenCharacters;
234
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;
243
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;
251
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;
259
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
263        @since Apache OpenOffice 4.0
264     */
265    [optional, property] boolean ShowContentTips;
266
267    /** If this property is <TRUE/>, and the scroll bar is shown, a tool tip
268        is displayed while scrolling.
269
270        @since Apache OpenOffice 4.0
271     */
272    [optional, property] boolean ShowScrollBarTips;
273};
274
275}; }; }; };
276
277#endif
278