offapi/com/sun/star/sheet/SpreadsheetViewSettings.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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** contains settings which are specific to each view of a spreadsheet
  25  */
  26 published service SpreadsheetViewSettings
  27 {
  28     /** provides access to the properties.
  29      */
  30     interface com::sun::star::beans::XPropertySet;
  31
  32
  33     /** controls whether formulas are displayed instead of their
  34         results.
  35      */
  36     [property] boolean ShowFormulas;
  37
  38
  39     /** enables display of zero-values.
  40      */
  41     [property] boolean ShowZeroValues;
  42
  43
  44     /** controls whether strings, values, and formulas are
  45         displayed in different colors.
  46      */
  47     [property] boolean IsValueHighlightingEnabled;
  48
  49
  50     /** controls whether a marker is shown for notes in cells.
  51      */
  52     [property] boolean ShowNotes;
  53
  54
  55     /** enables the vertical scroll bar of the view.
  56      */
  57     [property] boolean HasVerticalScrollBar;
  58
  59
  60     /** enables the horizontal scroll bar of the view.
  61      */
  62     [property] boolean HasHorizontalScrollBar;
  63
  64
  65     /** enables the sheet tabs of the view.
  66      */
  67     [property] boolean HasSheetTabs;
  68
  69
  70     /** enables the display of outline symbols.
  71      */
  72     [property] boolean IsOutlineSymbolsSet;
  73
  74
  75     /** enables the column and row headers of the view.
  76      */
  77     [property] boolean HasColumnRowHeaders;
  78
  79
  80     /** enables the display of the cell grid.
  81      */
  82     [property] boolean ShowGrid;
  83
  84
  85     /** specifies the color in which the cell grid is
  86         displayed.
  87      */
  88     [property] com::sun::star::util::Color GridColor;
  89
  90
  91     /** enables display of help lines when moving drawing
  92         objects.
  93      */
  94     [property] boolean ShowHelpLines;
  95
  96
  97     /** enables display of anchor symbols when drawing
  98         objects are selected.
  99      */
 100     [property] boolean ShowAnchor;
 101
 102
 103     /** enables display of page breaks.
 104      */
 105     [property] boolean ShowPageBreaks;
 106
 107
 108     /** enables display of embedded objects in the view.
 109
 110         @see SpreadsheetViewObjectsMode
 111      */
 112     [property] short ShowObjects;
 113
 114
 115     /** enables the display of charts in the view.
 116
 117         @see SpreadsheetViewObjectsMode
 118      */
 119     [property] short ShowCharts;
 120
 121
 122     /** enables the display of drawing objects in the view.
 123
 124         @see SpreadsheetViewObjectsMode
 125      */
 126     [property] short ShowDrawing;
 127
 128
 129     /** disables the display of marks from online spelling.
 130
 131         @deprecated
 132      */
 133     [property] boolean HideSpellMarks;
 134
 135
 136     /** This property defines the zoom type for the document.
 137
 138         @see com::sun::star::view::DocumentZoomType
 139     */
 140     [property] short ZoomType;
 141
 142
 143     /** Defines the zoom value to use.
 144         Valid only if the ZoomType is set to
 145         com::sun::star::view::DocumentZoomType::BY_VALUE.
 146     */
 147     [property] short ZoomValue;
 148
 149     /** Number of lines shown in the Formula bar
 150         Default is 1, maximum value is 25.
 151
 152         @since LibreOffice 7.4
 153     */
 154     [optional, property] short FormulaBarHeight;
 155 };
 156
 157
 158 }; }; }; };
 159
 160 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */