offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__
  29 #define __com_sun_star_sheet_SpreadsheetViewSettings_idl__
  30
  31 #ifndef __com_sun_star_beans_XPropertySet_idl__
  32 #include <com/sun/star/beans/XPropertySet.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_util_Color_idl__
  36 #include <com/sun/star/util/Color.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** contains settings which are specific to each view of a spreadsheet
  46  */
  47 published service SpreadsheetViewSettings
  48 {
  49     /** provides access to the properties.
  50      */
  51     interface com::sun::star::beans::XPropertySet;
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** controls whether formulas are displayed instead of their
  56         results.
  57      */
  58     [property] boolean ShowFormulas;
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** enables display of zero-values.
  63      */
  64     [property] boolean ShowZeroValues;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** controls whether strings, values, and formulas are
  69         displayed in different colors.
  70      */
  71     [property] boolean IsValueHighlightingEnabled;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** controls whether a marker is shown for notes in cells.
  76      */
  77     [property] boolean ShowNotes;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** enables the vertical scroll bar of the view.
  82      */
  83     [property] boolean HasVerticalScrollBar;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** enables the horizontal scroll bar of the view.
  88      */
  89     [property] boolean HasHorizontalScrollBar;
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** enables the sheet tabs of the view.
  94      */
  95     [property] boolean HasSheetTabs;
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** enables the display of outline symbols.
 100      */
 101     [property] boolean IsOutlineSymbolsSet;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** enables the column and row headers of the view.
 106      */
 107     [property] boolean HasColumnRowHeaders;
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** enables the display of the cell grid.
 112      */
 113     [property] boolean ShowGrid;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** specifies the color in which the cell grid is
 118         displayed.
 119      */
 120     [property] com::sun::star::util::Color GridColor;
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** enables display of help lines when moving drawing
 125         objects.
 126      */
 127     [property] boolean ShowHelpLines;
 128
 129     //-------------------------------------------------------------------------
 130
 131     /** enables display of anchor symbols when drawing
 132         objects are selected.
 133      */
 134     [property] boolean ShowAnchor;
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** enables display of page breaks.
 139      */
 140     [property] boolean ShowPageBreaks;
 141
 142     //-------------------------------------------------------------------------
 143
 144     /** enables solid (colored) handles when drawing
 145         objects are selected.
 146      */
 147     [property] boolean SolidHandles;
 148
 149     //-------------------------------------------------------------------------
 150
 151     /** enables display of embedded objects in the view.
 152      */
 153     [property] short ShowObjects;
 154
 155     //-------------------------------------------------------------------------
 156
 157     /** enables the display of charts in the view.
 158      */
 159     [property] short ShowCharts;
 160
 161     //-------------------------------------------------------------------------
 162
 163     /** enables the display of drawing objects in the view.
 164      */
 165     [property] short ShowDrawing;
 166
 167     //-------------------------------------------------------------------------
 168
 169     /** disables the display of marks from online spelling.
 170      */
 171     [property] boolean HideSpellMarks;
 172
 173     //-------------------------------------------------------------------------
 174     /** This property defines the zoom type for the document.
 175
 176         @see com::sun::star::view::DocumentZoomType
 177     */
 178         [property] short ZoomType;
 179
 180         //-------------------------------------------------------------------------
 181         /** Defines the zoom value to use.
 182             Valid only if the ZoomType is set to
 183             <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>.
 184     */
 185         [property] short ZoomValue;
 186 };
 187
 188 //=============================================================================
 189
 190 }; }; }; };
 191
 192 #endif
 193