1d1766043SAndrew Rist/**************************************************************
2*a41e6500SAriel Constenla-Haile *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*a41e6500SAriel Constenla-Haile *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*a41e6500SAriel Constenla-Haile *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19*a41e6500SAriel Constenla-Haile *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_ViewSettings_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_ViewSettings_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl>
27cdf0e10cSrcweir#include <com/sun/star/view/DocumentZoomType.idl>
28cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
29cdf0e10cSrcweir
30*a41e6500SAriel Constenla-Hailemodule com {  module sun {  module star {  module text {
31cdf0e10cSrcweir
32cdf0e10cSrcweir// DocMerge from xml: service com::sun::star::text::ViewSettings
33cdf0e10cSrcweir/** provides access to the settings of the controller of a text document.
34cdf0e10cSrcweir */
35cdf0e10cSrcweirpublished service ViewSettings
36cdf0e10cSrcweir{
37*a41e6500SAriel Constenla-Haile    interface com::sun::star::beans::XPropertySet;
38cdf0e10cSrcweir
39*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, annotations (notes) are visible.
40*a41e6500SAriel Constenla-Haile     */
41*a41e6500SAriel Constenla-Haile    [property] boolean ShowAnnotations;
42cdf0e10cSrcweir
43*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, paragraph line breaks are visible.
44*a41e6500SAriel Constenla-Haile     */
45*a41e6500SAriel Constenla-Haile    [property] boolean ShowBreaks;
46cdf0e10cSrcweir
47*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, shapes are visible.
48*a41e6500SAriel Constenla-Haile     */
49*a41e6500SAriel Constenla-Haile    [property] boolean ShowDrawings;
50cdf0e10cSrcweir
51*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, text fields are shown with their commands; otherwise
52*a41e6500SAriel Constenla-Haile        the content is visible.
53*a41e6500SAriel Constenla-Haile     */
54*a41e6500SAriel Constenla-Haile    [property] boolean ShowFieldCommands;
55cdf0e10cSrcweir
56*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, footnotes symbols are displayed with gray background.
57*a41e6500SAriel Constenla-Haile     */
58*a41e6500SAriel Constenla-Haile    [property] boolean ShowFootnoteBackground;
59cdf0e10cSrcweir
60*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, graphic objects are visible.
61*a41e6500SAriel Constenla-Haile     */
62*a41e6500SAriel Constenla-Haile    [property] boolean ShowGraphics;
63cdf0e10cSrcweir
64*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, hidden paragraghs are displayed.
65*a41e6500SAriel Constenla-Haile     */
66*a41e6500SAriel Constenla-Haile    [property] boolean ShowHiddenParagraphs;
67cdf0e10cSrcweir
68*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, hidden text is displayed.
69*a41e6500SAriel Constenla-Haile     */
70*a41e6500SAriel Constenla-Haile    [property] boolean ShowHiddenText;
71cdf0e10cSrcweir
72*a41e6500SAriel Constenla-Haile    /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
73*a41e6500SAriel Constenla-Haile     */
74*a41e6500SAriel Constenla-Haile    [property] boolean ShowRulers;
75cdf0e10cSrcweir
76*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
77*a41e6500SAriel Constenla-Haile        the horizontal ruler is displayed.
78*a41e6500SAriel Constenla-Haile     */
79*a41e6500SAriel Constenla-Haile    [property] boolean ShowHoriRuler;
80cdf0e10cSrcweir
81*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
82*a41e6500SAriel Constenla-Haile        the horizontal scroll bar is displayed.
83*a41e6500SAriel Constenla-Haile     */
84*a41e6500SAriel Constenla-Haile    [property] boolean ShowHoriScrollBar;
85cdf0e10cSrcweir
86*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, index marks are displayed with gray background.
87*a41e6500SAriel Constenla-Haile     */
88*a41e6500SAriel Constenla-Haile    [property] boolean ShowIndexMarkBackground;
89cdf0e10cSrcweir
90*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, paragraph breaks are visible.
91*a41e6500SAriel Constenla-Haile     */
92*a41e6500SAriel Constenla-Haile    [property] boolean ShowParaBreaks;
93cdf0e10cSrcweir
94*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, protected spaces (hard spaces) are displayed with gray
95*a41e6500SAriel Constenla-Haile        background.
96*a41e6500SAriel Constenla-Haile     */
97*a41e6500SAriel Constenla-Haile    [property] boolean ShowProtectedSpaces;
98cdf0e10cSrcweir
99*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, soft hyphens are displayed with gray background.
100*a41e6500SAriel Constenla-Haile     */
101*a41e6500SAriel Constenla-Haile    [property] boolean ShowSoftHyphens;
102cdf0e10cSrcweir
103*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, spaces are displayed with dots.
104*a41e6500SAriel Constenla-Haile     */
105*a41e6500SAriel Constenla-Haile    [property] boolean ShowSpaces;
106cdf0e10cSrcweir
107*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, table boundaries are displayed.
108*a41e6500SAriel Constenla-Haile     */
109*a41e6500SAriel Constenla-Haile    [property] boolean ShowTableBoundaries;
110cdf0e10cSrcweir
111*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, tables are visible.
112*a41e6500SAriel Constenla-Haile     */
113*a41e6500SAriel Constenla-Haile    [property] boolean ShowTables;
114cdf0e10cSrcweir
115*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, tab stops are visible.
116*a41e6500SAriel Constenla-Haile     */
117*a41e6500SAriel Constenla-Haile    [property] boolean ShowTabstops;
118cdf0e10cSrcweir
119*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, text boundaries are displayed.
120*a41e6500SAriel Constenla-Haile     */
121*a41e6500SAriel Constenla-Haile    [property] boolean ShowTextBoundaries;
122cdf0e10cSrcweir
123*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, text fields are displayed with gray background.
124*a41e6500SAriel Constenla-Haile     */
125*a41e6500SAriel Constenla-Haile    [property] boolean ShowTextFieldBackground;
126cdf0e10cSrcweir
127*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, the vertical ruler is displayed.
128*a41e6500SAriel Constenla-Haile     */
129*a41e6500SAriel Constenla-Haile    [property] boolean ShowVertRuler;
130cdf0e10cSrcweir
131*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, the vertical scroll bar is displayed.
132*a41e6500SAriel Constenla-Haile     */
133*a41e6500SAriel Constenla-Haile    [property] boolean ShowVertScrollBar;
134cdf0e10cSrcweir
135*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, smooth scrolling is active.
136*a41e6500SAriel Constenla-Haile     */
137*a41e6500SAriel Constenla-Haile    [property] boolean SmoothScrolling;
138cdf0e10cSrcweir
139*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, handles of drawing objects are visible.
140*a41e6500SAriel Constenla-Haile     */
141*a41e6500SAriel Constenla-Haile    [property] boolean SolidMarkHandles;
142cdf0e10cSrcweir
143cdf0e10cSrcweir    /** If this property is <TRUE/>, the vertical ruler is aligned to the right side
144cdf0e10cSrcweir     of the view and the vertical scrollbar is on the left.
145*a41e6500SAriel Constenla-Haile     */
146cdf0e10cSrcweir    [property] boolean IsVertRulerRightAligned;
147cdf0e10cSrcweir
148cdf0e10cSrcweir    /** If this property is <TRUE/> the document will be displayed as if it
149cdf0e10cSrcweir        were a HTML document.
150*a41e6500SAriel Constenla-Haile     */
151cdf0e10cSrcweir    [property] boolean ShowOnlineLayout;
152cdf0e10cSrcweir
153cdf0e10cSrcweir    /** This property defines the zoom type for the document.
154cdf0e10cSrcweir
155cdf0e10cSrcweir        @see com::sun::star::view::DocumentZoomType
156cdf0e10cSrcweir     */
157cdf0e10cSrcweir    [property] short ZoomType;
158cdf0e10cSrcweir
159cdf0e10cSrcweir    /** Defines the zoom value to use.
160cdf0e10cSrcweir        Valid only if the ZoomType is set to
161cdf0e10cSrcweir        <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>.
162*a41e6500SAriel Constenla-Haile     */
163cdf0e10cSrcweir    [property] short ZoomValue;
164*a41e6500SAriel Constenla-Haile
165cdf0e10cSrcweir    /** If this property is <TRUE/> hyperlinks in the document are executed (loaded) on
166cdf0e10cSrcweir     mouse click. Otherwise they are handled like normal text.
167cdf0e10cSrcweir         */
168cdf0e10cSrcweir    [optional, property] boolean IsExecuteHyperlinks;
169cdf0e10cSrcweir
170cdf0e10cSrcweir    /** Specifies whether to display the grid or not
171cdf0e10cSrcweir
172cdf0e10cSrcweir        @since OOo 2.0
173cdf0e10cSrcweir     */
174cdf0e10cSrcweir    [optional, property] boolean IsRasterVisible;
175cdf0e10cSrcweir
176cdf0e10cSrcweir    /** Specifies whether to move frames, drawing elements, and form
177cdf0e10cSrcweir        functions only between grid points.
178cdf0e10cSrcweir
179cdf0e10cSrcweir        @since OOo 2.0
180cdf0e10cSrcweir     */
181cdf0e10cSrcweir    [optional, property] boolean IsSnapToRaster;
182cdf0e10cSrcweir
183cdf0e10cSrcweir    /** Specifies the number of intervals between grid points on the X-axis.
184cdf0e10cSrcweir
185cdf0e10cSrcweir        <p>The value must be greater or equal to 0, and the application
186cdf0e10cSrcweir        may enforce an upper bound for the value.</p>
187cdf0e10cSrcweir
188cdf0e10cSrcweir        @since OOo 2.0
189cdf0e10cSrcweir        @throws com::sun::star::lang::IllegalArgumentException
190cdf0e10cSrcweir            if the value is out of bounds.
191cdf0e10cSrcweir     */
192cdf0e10cSrcweir    [optional, property] long RasterSubdivisionX;
193cdf0e10cSrcweir
194cdf0e10cSrcweir    /** Specifies the number of intervals between grid points on the Y-axis.
195cdf0e10cSrcweir
196cdf0e10cSrcweir        <p>The value must be greater or equal to 0, and the application
197cdf0e10cSrcweir        may enforce an upper bound for the value.</p>
198cdf0e10cSrcweir
199cdf0e10cSrcweir        @since OOo 2.0
200cdf0e10cSrcweir        @throws com::sun::star::lang::IllegalArgumentException
201cdf0e10cSrcweir            if the value is out of bounds.
202cdf0e10cSrcweir     */
203cdf0e10cSrcweir    [optional, property] long RasterSubdivisionY;
204cdf0e10cSrcweir
205cdf0e10cSrcweir    /** Defines the unit of measure for the spacing between grid points
206cdf0e10cSrcweir        on the X-axis.
207cdf0e10cSrcweir
208cdf0e10cSrcweir        <p>The value must be greater than 0. The application
209cdf0e10cSrcweir        may enforce more restricting bounds for the value.</p>
210cdf0e10cSrcweir
211cdf0e10cSrcweir        @since OOo 2.0
212cdf0e10cSrcweir        @throws com::sun::star::lang::IllegalArgumentException
213cdf0e10cSrcweir            if the value is out of bounds.
214cdf0e10cSrcweir     */
215cdf0e10cSrcweir    [optional, property] long RasterResolutionX;
216cdf0e10cSrcweir
217cdf0e10cSrcweir    /** Defines the unit of measure for the spacing between grid points
218cdf0e10cSrcweir        on the Y-axis.
219cdf0e10cSrcweir
220cdf0e10cSrcweir        <p>The value must be greater than 0. The application
221cdf0e10cSrcweir        may enforce more restricting bounds for the value.</p>
222cdf0e10cSrcweir
223cdf0e10cSrcweir        @since OOo 2.0
224cdf0e10cSrcweir        @throws com::sun::star::lang::IllegalArgumentException
225cdf0e10cSrcweir            if the value is out of bounds.
226cdf0e10cSrcweir     */
227cdf0e10cSrcweir    [optional, property] long RasterResolutionY;
228cdf0e10cSrcweir
229cdf0e10cSrcweir    /** If this property is <TRUE/>, hidden characters are displayed
230cdf0e10cSrcweir
231cdf0e10cSrcweir        @since OOo 3.0
232cdf0e10cSrcweir     */
233cdf0e10cSrcweir    [optional, property] boolean ShowHiddenCharacters;
234*a41e6500SAriel Constenla-Haile
235ef785786SAriel Constenla-Haile    /** If this property is <TRUE/>, the settings of nonprinting characters are applied.
236cdf0e10cSrcweir
237cdf0e10cSrcweir        <p>This option controls the use of the settings ShowHiddenCharacters,
238cdf0e10cSrcweir        ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks </p>
239cdf0e10cSrcweir
240cdf0e10cSrcweir        @since OOo 3.0
241cdf0e10cSrcweir     */
242cdf0e10cSrcweir    [optional, property] boolean ShowNonprintingCharacters;
243*a41e6500SAriel Constenla-Haile
244cdf0e10cSrcweir    /** metric unit of the horizontal ruler
245cdf0e10cSrcweir
246cdf0e10cSrcweir        <p>Uses values <type scope="com::sun::star::awt">FieldUnit</type></p>
247cdf0e10cSrcweir
248cdf0e10cSrcweir        @since OOo 3.1
249cdf0e10cSrcweir     */
250cdf0e10cSrcweir    [optional, property] long HorizontalRulerMetric;
251*a41e6500SAriel Constenla-Haile
252cdf0e10cSrcweir    /** metric unit of the vertical ruler
253cdf0e10cSrcweir
254cdf0e10cSrcweir        <p>Uses values from <type scope="com::sun::star::awt">FieldUnit</type></p>
255cdf0e10cSrcweir
256cdf0e10cSrcweir        @since OOo 3.1
257cdf0e10cSrcweir     */
258cdf0e10cSrcweir    [optional, property] long VerticalRulerMetric;
259*a41e6500SAriel Constenla-Haile
260ef785786SAriel Constenla-Haile    /** If this property is <TRUE/>, tips for document content are shown,
261ef785786SAriel Constenla-Haile        typically in a help balloon when the mouse is over the content.
262ef785786SAriel Constenla-Haile
263*a41e6500SAriel Constenla-Haile        @since Apache OpenOffice 4.0
264ef785786SAriel Constenla-Haile     */
265ef785786SAriel Constenla-Haile    [optional, property] boolean ShowContentTips;
266cdf0e10cSrcweir
267*a41e6500SAriel Constenla-Haile    /** If this property is <TRUE/>, and the scroll bar is shown, a tool tip
268*a41e6500SAriel Constenla-Haile        is displayed while scrolling.
269*a41e6500SAriel Constenla-Haile
270*a41e6500SAriel Constenla-Haile        @since Apache OpenOffice 4.0
271*a41e6500SAriel Constenla-Haile     */
272*a41e6500SAriel Constenla-Haile    [optional, property] boolean ShowScrollBarTips;
273*a41e6500SAriel Constenla-Haile};
274cdf0e10cSrcweir
275cdf0e10cSrcweir}; }; }; };
276cdf0e10cSrcweir
277cdf0e10cSrcweir#endif
278