LibreOffice
LibreOffice 24.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 
20 module com { module sun { module star { module text {
21 
24 published service ViewSettings
25 {
27 
30  [property] boolean ShowAnnotations;
31 
34  [property] boolean ShowBreaks;
35 
38  [property] boolean ShowDrawings;
39 
43  [property] boolean ShowFieldCommands;
44 
47  [property] boolean ShowFootnoteBackground;
48 
51  [property] boolean ShowGraphics;
52 
55  [property] boolean ShowHiddenParagraphs;
56 
59  [property] boolean ShowHiddenText;
60 
63  [property] boolean ShowRulers;
64 
68  [property] boolean ShowHoriRuler;
69 
73  [property] boolean ShowHoriScrollBar;
74 
77  [property] boolean ShowIndexMarkBackground;
78 
81  [property] boolean ShowParaBreaks;
82 
86  [property] boolean ShowProtectedSpaces;
87 
90  [property] boolean ShowSoftHyphens;
91 
94  [property] boolean ShowSpaces;
95 
98  [property] boolean ShowTableBoundaries;
99 
102  [property] boolean ShowTables;
103 
106  [property] boolean ShowTabstops;
107 
110  [property] boolean ShowTextBoundaries;
111 
114  [property] boolean ShowTextFieldBackground;
115 
118  [property] boolean ShowVertRuler;
119 
122  [property] boolean ShowVertScrollBar;
123 
126  [property] boolean SmoothScrolling;
127 
131  [property] boolean IsVertRulerRightAligned;
132 
136  [property] boolean ShowOnlineLayout;
137 
142  [property] short ZoomType;
143 
148  [property] short ZoomValue;
152  [optional, property] boolean IsExecuteHyperlinks;
153 
158  [optional, property] boolean IsRasterVisible;
159 
165  [optional, property] boolean IsSnapToRaster;
166 
176  [optional, property] long RasterSubdivisionX;
177 
187  [optional, property] long RasterSubdivisionY;
188 
199  [optional, property] long RasterResolutionX;
200 
211  [optional, property] long RasterResolutionY;
212 
217  [optional, property] boolean ShowHiddenCharacters;
225  [optional, property] boolean ShowNonprintingCharacters;
226 
233  [optional, property] long HorizontalRulerMetric;
234 
241  [optional, property] long VerticalRulerMetric;
242 
248  [optional, property] boolean ShowContentTips;
249 
255  [optional, property] boolean ShowScrollBarTips;
256 
261  [optional, property] boolean HideWhitespace;
262 
267  [optional, property] boolean ShowInlineTooltips;
268 
273  [optional, property] boolean UseHeaderFooterMenu;
274 
279  [optional, property] boolean ShowBookmarks;
280 
285  [optional, property] boolean ShowOutlineContentVisibilityButton;
286 
291  [optional, property] boolean ShowChangesInMargin;
292 
298  [optional, property] boolean TreatSubOutlineLevelsAsContent;
299 };
300 
301 }; }; }; };
302 
303 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
long HorizontalRulerMetric
metric unit of the horizontal ruler
Definition: ViewSettings.idl:233
boolean ShowTextFieldBackground
If this property is TRUE, text fields are displayed with gray background.
Definition: ViewSettings.idl:114
boolean ShowFieldCommands
If this property is TRUE, text fields are shown with their commands; otherwise the content is visible...
Definition: ViewSettings.idl:43
boolean IsExecuteHyperlinks
If this property is TRUE hyperlinks in the document are executed (loaded) on mouse click...
Definition: ViewSettings.idl:152
boolean ShowChangesInMargin
If this property is TRUE, tracked deletions are shown in margin.
Definition: ViewSettings.idl:291
boolean ShowGraphics
If this property is TRUE, graphic objects are visible.
Definition: ViewSettings.idl:51
long RasterResolutionX
Defines the unit of measure for the spacing between grid points on the X-axis.
Definition: ViewSettings.idl:199
boolean ShowRulers
ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
Definition: ViewSettings.idl:63
boolean ShowTextBoundaries
If this property is TRUE, text boundaries are displayed.
Definition: ViewSettings.idl:110
boolean SmoothScrolling
If this property is TRUE, smooth scrolling is active.
Definition: ViewSettings.idl:126
long RasterSubdivisionX
Specifies the number of intervals between grid points on the X-axis.
Definition: ViewSettings.idl:176
boolean ShowDrawings
If this property is TRUE, shapes are visible.
Definition: ViewSettings.idl:38
Definition: Ambiguous.idl:20
boolean ShowVertScrollBar
If this property is TRUE, the vertical scroll bar is displayed.
Definition: ViewSettings.idl:122
boolean ShowOnlineLayout
If this property is TRUE the document will be displayed as if it were a HTML document.
Definition: ViewSettings.idl:136
boolean ShowBreaks
If this property is TRUE, paragraph line breaks are visible.
Definition: ViewSettings.idl:34
boolean IsSnapToRaster
Specifies whether to move frames, drawing elements, and form functions only between grid points...
Definition: ViewSettings.idl:165
boolean ShowIndexMarkBackground
If this property is TRUE, index marks are displayed with gray background.
Definition: ViewSettings.idl:77
long RasterResolutionY
Defines the unit of measure for the spacing between grid points on the Y-axis.
Definition: ViewSettings.idl:211
boolean ShowBookmarks
If this property is TRUE, bookmark positions are displayed.
Definition: ViewSettings.idl:279
boolean ShowVertRuler
If this property is TRUE, the vertical ruler is displayed.
Definition: ViewSettings.idl:118
boolean ShowAnnotations
If this property is TRUE, annotations (notes) are visible.
Definition: ViewSettings.idl:26
boolean ShowSoftHyphens
If this property is TRUE, soft hyphens are displayed with gray background.
Definition: ViewSettings.idl:90
boolean ShowOutlineContentVisibilityButton
If this property is TRUE, the outline content visibility toggle button is shown.
Definition: ViewSettings.idl:285
boolean ShowHoriRuler
If this property is TRUE and the property ShowRulers is TRUE, the horizontal ruler is displayed...
Definition: ViewSettings.idl:68
boolean ShowHoriScrollBar
If this property is TRUE and the property ShowRulers is TRUE, the horizontal scroll bar is displayed...
Definition: ViewSettings.idl:73
boolean ShowFootnoteBackground
If this property is TRUE, footnotes symbols are displayed with gray background.
Definition: ViewSettings.idl:47
short ZoomValue
Defines the zoom value to use.
Definition: ViewSettings.idl:148
boolean ShowHiddenCharacters
If this property is TRUE, hidden characters are displayed.
Definition: ViewSettings.idl:217
boolean ShowProtectedSpaces
If this property is TRUE, protected spaces (hard spaces) are displayed with gray background.
Definition: ViewSettings.idl:86
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:131
long VerticalRulerMetric
metric unit of the vertical ruler
Definition: ViewSettings.idl:241
boolean UseHeaderFooterMenu
If this property is TRUE, the advanced menu for header/footer is shown.
Definition: ViewSettings.idl:273
boolean HideWhitespace
If this property is TRUE, whitespaces around pages are hidden.
Definition: ViewSettings.idl:261
boolean ShowInlineTooltips
If this property is TRUE, tooltips for tracked changes are shown.
Definition: ViewSettings.idl:267
boolean ShowTabstops
If this property is TRUE, tab stops are visible.
Definition: ViewSettings.idl:106
boolean TreatSubOutlineLevelsAsContent
If this property is TRUE, sub outline levels are treated as content in outline content visibility act...
Definition: ViewSettings.idl:298
provides access to the settings of the controller of a text document.
Definition: ViewSettings.idl:24
boolean ShowContentTips
If this property is TRUE, tips for document content are shown, typically in a help balloon when the m...
Definition: ViewSettings.idl:248
boolean IsRasterVisible
Specifies whether to display the grid or not.
Definition: ViewSettings.idl:158
long RasterSubdivisionY
Specifies the number of intervals between grid points on the Y-axis.
Definition: ViewSettings.idl:187
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:45
boolean ShowHiddenParagraphs
If this property is TRUE, hidden paragraphs are displayed.
Definition: ViewSettings.idl:55
boolean ShowSpaces
If this property is TRUE, spaces are displayed with dots.
Definition: ViewSettings.idl:94
boolean ShowTableBoundaries
If this property is TRUE, table boundaries are displayed.
Definition: ViewSettings.idl:98
boolean ShowScrollBarTips
If this property is TRUE, and the scroll bar is shown, a tool tip is displayed while scrolling...
Definition: ViewSettings.idl:255
boolean ShowTables
If this property is TRUE, tables are visible.
Definition: ViewSettings.idl:102
boolean ShowNonprintingCharacters
If this property is TRUE, the settings of non-printing characters are applied.
Definition: ViewSettings.idl:225
boolean ShowParaBreaks
If this property is TRUE, paragraph breaks are visible.
Definition: ViewSettings.idl:81
short ZoomType
This property defines the zoom type for the document.
Definition: ViewSettings.idl:142
boolean ShowHiddenText
If this property is TRUE, hidden text is displayed.
Definition: ViewSettings.idl:59