LibreOffice
LibreOffice 6.2 SDK API Reference
ViewSettings.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_text_ViewSettings_idl__
20 #define __com_sun_star_text_ViewSettings_idl__
21 
25 
26 module com { module sun { module star { module text {
27 
30 published service ViewSettings
31 {
33 
36  [property] boolean ShowAnnotations;
37 
40  [property] boolean ShowBreaks;
41 
44  [property] boolean ShowDrawings;
45 
49  [property] boolean ShowFieldCommands;
50 
53  [property] boolean ShowFootnoteBackground;
54 
57  [property] boolean ShowGraphics;
58 
61  [property] boolean ShowHiddenParagraphs;
62 
65  [property] boolean ShowHiddenText;
66 
69  [property] boolean ShowRulers;
70 
74  [property] boolean ShowHoriRuler;
75 
79  [property] boolean ShowHoriScrollBar;
80 
83  [property] boolean ShowIndexMarkBackground;
84 
87  [property] boolean ShowParaBreaks;
88 
92  [property] boolean ShowProtectedSpaces;
93 
96  [property] boolean ShowSoftHyphens;
97 
100  [property] boolean ShowSpaces;
101 
104  [property] boolean ShowTableBoundaries;
105 
108  [property] boolean ShowTables;
109 
112  [property] boolean ShowTabstops;
113 
116  [property] boolean ShowTextBoundaries;
117 
120  [property] boolean ShowTextFieldBackground;
121 
124  [property] boolean ShowVertRuler;
125 
128  [property] boolean ShowVertScrollBar;
129 
132  [property] boolean SmoothScrolling;
133 
137  [property] boolean IsVertRulerRightAligned;
138 
142  [property] boolean ShowOnlineLayout;
143 
148  [property] short ZoomType;
149 
154  [property] short ZoomValue;
158  [optional, property] boolean IsExecuteHyperlinks;
159 
164  [optional, property] boolean IsRasterVisible;
165 
171  [optional, property] boolean IsSnapToRaster;
172 
182  [optional, property] long RasterSubdivisionX;
183 
193  [optional, property] long RasterSubdivisionY;
194 
205  [optional, property] long RasterResolutionX;
206 
217  [optional, property] long RasterResolutionY;
218 
223  [optional, property] boolean ShowHiddenCharacters;
231  [optional, property] boolean ShowNonprintingCharacters;
232 
239  [optional, property] long HorizontalRulerMetric;
240 
247  [optional, property] long VerticalRulerMetric;
248 
254  [optional, property] boolean ShowContentTips;
255 
261  [optional, property] boolean ShowScrollBarTips;
262 
267  [optional, property] boolean HideWhitespace;
268 
273  [optional, property] boolean ShowInlineTooltips;
274 };
275 
276 }; }; }; };
277 
278 #endif
279 
280 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
long HorizontalRulerMetric
metric unit of the horizontal ruler
Definition: ViewSettings.idl:239
boolean ShowTextFieldBackground
If this property is TRUE, text fields are displayed with gray background.
Definition: ViewSettings.idl:120
boolean ShowFieldCommands
If this property is TRUE, text fields are shown with their commands; otherwise the content is visible...
Definition: ViewSettings.idl:49
boolean IsExecuteHyperlinks
If this property is TRUE hyperlinks in the document are executed (loaded) on mouse click...
Definition: ViewSettings.idl:158
boolean ShowGraphics
If this property is TRUE, graphic objects are visible.
Definition: ViewSettings.idl:57
long RasterResolutionX
Defines the unit of measure for the spacing between grid points on the X-axis.
Definition: ViewSettings.idl:205
boolean ShowRulers
ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
Definition: ViewSettings.idl:69
boolean ShowTextBoundaries
If this property is TRUE, text boundaries are displayed.
Definition: ViewSettings.idl:116
boolean SmoothScrolling
If this property is TRUE, smooth scrolling is active.
Definition: ViewSettings.idl:132
long RasterSubdivisionX
Specifies the number of intervals between grid points on the X-axis.
Definition: ViewSettings.idl:182
boolean ShowDrawings
If this property is TRUE, shapes are visible.
Definition: ViewSettings.idl:44
Definition: Ambiguous.idl:22
boolean ShowVertScrollBar
If this property is TRUE, the vertical scroll bar is displayed.
Definition: ViewSettings.idl:128
boolean ShowOnlineLayout
If this property is TRUE the document will be displayed as if it were a HTML document.
Definition: ViewSettings.idl:142
boolean ShowBreaks
If this property is TRUE, paragraph line breaks are visible.
Definition: ViewSettings.idl:40
boolean IsSnapToRaster
Specifies whether to move frames, drawing elements, and form functions only between grid points...
Definition: ViewSettings.idl:171
boolean ShowIndexMarkBackground
If this property is TRUE, index marks are displayed with gray background.
Definition: ViewSettings.idl:83
long RasterResolutionY
Defines the unit of measure for the spacing between grid points on the Y-axis.
Definition: ViewSettings.idl:217
boolean ShowVertRuler
If this property is TRUE, the vertical ruler is displayed.
Definition: ViewSettings.idl:124
boolean ShowAnnotations
If this property is TRUE, annotations (notes) are visible.
Definition: ViewSettings.idl:32
boolean ShowSoftHyphens
If this property is TRUE, soft hyphens are displayed with gray background.
Definition: ViewSettings.idl:96
boolean ShowHoriRuler
If this property is TRUE and the property ShowRulers is TRUE, the horizontal ruler is displayed...
Definition: ViewSettings.idl:74
boolean ShowHoriScrollBar
If this property is TRUE and the property ShowRulers is TRUE, the horizontal scroll bar is displayed...
Definition: ViewSettings.idl:79
boolean ShowFootnoteBackground
If this property is TRUE, footnotes symbols are displayed with gray background.
Definition: ViewSettings.idl:53
short ZoomValue
Defines the zoom value to use.
Definition: ViewSettings.idl:154
boolean ShowHiddenCharacters
If this property is TRUE, hidden characters are displayed.
Definition: ViewSettings.idl:223
boolean ShowProtectedSpaces
If this property is TRUE, protected spaces (hard spaces) are displayed with gray background.
Definition: ViewSettings.idl:92
boolean IsVertRulerRightAligned
If this property is TRUE, the vertical ruler is aligned to the right side of the view and the vertica...
Definition: ViewSettings.idl:137
long VerticalRulerMetric
metric unit of the vertical ruler
Definition: ViewSettings.idl:247
boolean HideWhitespace
If this property is TRUE, whitespaces around pages are hidden.
Definition: ViewSettings.idl:267
boolean ShowInlineTooltips
If this property is TRUE, tooltips for tracked changes are shown.
Definition: ViewSettings.idl:273
boolean ShowTabstops
If this property is TRUE, tab stops are visible.
Definition: ViewSettings.idl:112
provides access to the settings of the controller of a text document.
Definition: ViewSettings.idl:30
boolean ShowContentTips
If this property is TRUE, tips for document content are shown, typically in a help balloon when the m...
Definition: ViewSettings.idl:254
boolean IsRasterVisible
Specifies whether to display the grid or not.
Definition: ViewSettings.idl:164
long RasterSubdivisionY
Specifies the number of intervals between grid points on the Y-axis.
Definition: ViewSettings.idl:193
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:63
boolean ShowHiddenParagraphs
If this property is TRUE, hidden paragraphs are displayed.
Definition: ViewSettings.idl:61
boolean ShowSpaces
If this property is TRUE, spaces are displayed with dots.
Definition: ViewSettings.idl:100
boolean ShowTableBoundaries
If this property is TRUE, table boundaries are displayed.
Definition: ViewSettings.idl:104
boolean ShowScrollBarTips
If this property is TRUE, and the scroll bar is shown, a tool tip is displayed while scrolling...
Definition: ViewSettings.idl:261
boolean ShowTables
If this property is TRUE, tables are visible.
Definition: ViewSettings.idl:108
boolean ShowNonprintingCharacters
If this property is TRUE, the settings of non-printing characters are applied.
Definition: ViewSettings.idl:231
boolean ShowParaBreaks
If this property is TRUE, paragraph breaks are visible.
Definition: ViewSettings.idl:87
short ZoomType
This property defines the zoom type for the document.
Definition: ViewSettings.idl:148
boolean ShowHiddenText
If this property is TRUE, hidden text is displayed.
Definition: ViewSettings.idl:65