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

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