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