offapi/com/sun/star/text/ViewSettings.idl

   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
  22 /** provides access to the settings of the controller of a text document.
  23  */
  24 published service ViewSettings
  25 {
  26     interface com::sun::star::beans::XPropertySet;
  27
  28     /** If this property is `TRUE`, annotations (notes) are visible.
  29      */
  30     [property] boolean ShowAnnotations;
  31
  32     /** If this property is `TRUE`, paragraph line breaks are visible.
  33      */
  34     [property] boolean ShowBreaks;
  35
  36     /** If this property is `TRUE`, shapes are visible.
  37      */
  38     [property] boolean ShowDrawings;
  39
  40     /** If this property is `TRUE`, text fields are shown with their commands; otherwise
  41         the content is visible.
  42      */
  43     [property] boolean ShowFieldCommands;
  44
  45     /** If this property is `TRUE`, footnotes symbols are displayed with gray background.
  46      */
  47     [property] boolean ShowFootnoteBackground;
  48
  49     /** If this property is `TRUE`, graphic objects are visible.
  50      */
  51     [property] boolean ShowGraphics;
  52
  53     /** If this property is `TRUE`, hidden paragraphs are displayed.
  54      */
  55     [property] boolean ShowHiddenParagraphs;
  56
  57     /** If this property is `TRUE`, hidden text is displayed.
  58      */
  59     [property] boolean ShowHiddenText;
  60
  61     /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
  62      */
  63     [property] boolean ShowRulers;
  64
  65     /** If this property is `TRUE` and the property ShowRulers is `TRUE`,
  66         the horizontal ruler is displayed.
  67      */
  68     [property] boolean ShowHoriRuler;
  69
  70     /** If this property is `TRUE` and the property ShowRulers is `TRUE`,
  71         the horizontal scroll bar is displayed.
  72      */
  73     [property] boolean ShowHoriScrollBar;
  74
  75     /** If this property is `TRUE`, index marks are displayed with gray background.
  76      */
  77     [property] boolean ShowIndexMarkBackground;
  78
  79     /** If this property is `TRUE`, paragraph breaks are visible.
  80      */
  81     [property] boolean ShowParaBreaks;
  82
  83     /** If this property is `TRUE`, protected spaces (hard spaces) are displayed with gray
  84         background.
  85      */
  86     [property] boolean ShowProtectedSpaces;
  87
  88     /** If this property is `TRUE`, soft hyphens are displayed with gray background.
  89      */
  90     [property] boolean ShowSoftHyphens;
  91
  92     /** If this property is `TRUE`, spaces are displayed with dots.
  93      */
  94     [property] boolean ShowSpaces;
  95
  96     /** If this property is `TRUE`, table boundaries are displayed.
  97      */
  98     [property] boolean ShowTableBoundaries;
  99
 100     /** If this property is `TRUE`, tables are visible.
 101      */
 102     [property] boolean ShowTables;
 103
 104     /** If this property is `TRUE`, tab stops are visible.
 105      */
 106     [property] boolean ShowTabstops;
 107
 108     /** If this property is `TRUE`, text boundaries are displayed.
 109      */
 110     [property] boolean ShowTextBoundaries;
 111
 112     /** If this property is `TRUE`, text fields are displayed with gray background.
 113      */
 114     [property] boolean ShowTextFieldBackground;
 115
 116     /** If this property is `TRUE`, the vertical ruler is displayed.
 117      */
 118     [property] boolean ShowVertRuler;
 119
 120     /** If this property is `TRUE`, the vertical scroll bar is displayed.
 121      */
 122     [property] boolean ShowVertScrollBar;
 123
 124     /** If this property is `TRUE`, smooth scrolling is active.
 125      */
 126     [property] boolean SmoothScrolling;
 127
 128     /** If this property is `TRUE`, the vertical ruler is aligned to the right side
 129      of the view and the vertical scrollbar is on the left.
 130      */
 131     [property] boolean IsVertRulerRightAligned;
 132
 133     /** If this property is `TRUE` the document will be displayed as if it
 134         were a HTML document.
 135      */
 136     [property] boolean ShowOnlineLayout;
 137
 138     /** This property defines the zoom type for the document.
 139
 140         @see com::sun::star::view::DocumentZoomType
 141      */
 142     [property] short ZoomType;
 143
 144     /** Defines the zoom value to use.
 145         Valid only if the ZoomType is set to
 146         com::sun::star::view::DocumentZoomType::BY_VALUE.
 147      */
 148     [property] short ZoomValue;
 149     /** If this property is `TRUE` hyperlinks in the document are executed (loaded) on
 150      mouse click. Otherwise they are handled like normal text.
 151          */
 152     [optional, property] boolean IsExecuteHyperlinks;
 153
 154     /** Specifies whether to display the grid or not
 155
 156         @since OOo 2.0
 157      */
 158     [optional, property] boolean IsRasterVisible;
 159
 160     /** Specifies whether to move frames, drawing elements, and form
 161         functions only between grid points.
 162
 163         @since OOo 2.0
 164      */
 165     [optional, property] boolean IsSnapToRaster;
 166
 167     /** Specifies the number of intervals between grid points on the X-axis.
 168
 169         <p>The value must be greater or equal to 0, and the application
 170         may enforce an upper bound for the value.</p>
 171
 172         @since OOo 2.0
 173         @throws com::sun::star::lang::IllegalArgumentException
 174             if the value is out of bounds.
 175      */
 176     [optional, property] long RasterSubdivisionX;
 177
 178     /** Specifies the number of intervals between grid points on the Y-axis.
 179
 180         <p>The value must be greater or equal to 0, and the application
 181         may enforce an upper bound for the value.</p>
 182
 183         @since OOo 2.0
 184         @throws com::sun::star::lang::IllegalArgumentException
 185             if the value is out of bounds.
 186      */
 187     [optional, property] long RasterSubdivisionY;
 188
 189     /** Defines the unit of measure for the spacing between grid points
 190         on the X-axis.
 191
 192         <p>The value must be greater than 0. The application
 193         may enforce more restricting bounds for the value.</p>
 194
 195         @since OOo 2.0
 196         @throws com::sun::star::lang::IllegalArgumentException
 197             if the value is out of bounds.
 198      */
 199     [optional, property] long RasterResolutionX;
 200
 201     /** Defines the unit of measure for the spacing between grid points
 202         on the Y-axis.
 203
 204         <p>The value must be greater than 0. The application
 205         may enforce more restricting bounds for the value.</p>
 206
 207         @since OOo 2.0
 208         @throws com::sun::star::lang::IllegalArgumentException
 209             if the value is out of bounds.
 210      */
 211     [optional, property] long RasterResolutionY;
 212
 213     /** If this property is `TRUE`, hidden characters are displayed
 214
 215         @since OOo 3.0
 216      */
 217     [optional, property] boolean ShowHiddenCharacters;
 218     /** If this property is `TRUE`, the settings of non-printing characters are applied.
 219
 220         <p>This option controls the use of the settings ShowHiddenCharacters,
 221         ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks </p>
 222
 223         @since OOo 3.0
 224      */
 225     [optional, property] boolean ShowNonprintingCharacters;
 226
 227     /** metric unit of the horizontal ruler
 228
 229         <p>Uses values com::sun::star::awt::FieldUnit</p>
 230
 231         @since OOo 3.1
 232      */
 233     [optional, property] long HorizontalRulerMetric;
 234
 235     /** metric unit of the vertical ruler
 236
 237         <p>Uses values from com::sun::star::awt::FieldUnit</p>
 238
 239         @since OOo 3.1
 240      */
 241     [optional, property] long VerticalRulerMetric;
 242
 243     /** If this property is `TRUE`, tips for document content are shown,
 244         typically in a help balloon when the mouse is over the content.
 245
 246         @since LibreOffice 4.1
 247      */
 248     [optional, property] boolean ShowContentTips;
 249
 250     /** If this property is `TRUE`, and the scroll bar is shown, a tool tip
 251         is displayed while scrolling.
 252
 253         @since LibreOffice 4.2
 254      */
 255     [optional, property] boolean ShowScrollBarTips;
 256
 257     /** If this property is `TRUE`, whitespaces around pages are hidden.
 258
 259         @since LibreOffice 5.1
 260     */
 261     [optional, property] boolean HideWhitespace;
 262
 263     /** If this property is `TRUE`, tooltips for tracked changes are shown.
 264
 265         @since LibreOffice 6.1
 266     */
 267     [optional, property] boolean ShowInlineTooltips;
 268
 269     /** If this property is `TRUE`, the advanced menu for header/footer is shown
 270
 271         @since LibreOffice 6.2
 272     */
 273     [optional, property] boolean UseHeaderFooterMenu;
 274
 275     /** If this property is `TRUE`, bookmark positions are displayed.
 276
 277         @since LibreOffice 7.0
 278      */
 279     [optional, property] boolean ShowBookmarks;
 280
 281     /** If this property is `TRUE`, the outline content visibility toggle button is shown.
 282
 283         @since LibreOffice 7.1
 284     */
 285     [optional, property] boolean ShowOutlineContentVisibilityButton;
 286
 287     /** If this property is `TRUE`, tracked deletions are shown in margin.
 288
 289         @since LibreOffice 7.1
 290     */
 291     [optional, property] boolean ShowChangesInMargin;
 292
 293     /** If this property is `TRUE`, sub outline levels are treated as content in
 294         outline content visibility actions.
 295
 296         @since LibreOffice 7.2
 297     */
 298     [optional, property] boolean TreatSubOutlineLevelsAsContent;
 299 };
 300
 301 }; }; }; };
 302
 303 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */