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