xref: /AOO41X/main/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__
25#define __com_sun_star_sheet_SpreadsheetViewSettings_idl__
26
27#ifndef __com_sun_star_beans_XPropertySet_idl__
28#include <com/sun/star/beans/XPropertySet.idl>
29#endif
30
31#ifndef __com_sun_star_util_Color_idl__
32#include <com/sun/star/util/Color.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** contains settings which are specific to each view of a spreadsheet
42 */
43published service SpreadsheetViewSettings
44{
45    /** provides access to the properties.
46     */
47    interface com::sun::star::beans::XPropertySet;
48
49    //-------------------------------------------------------------------------
50
51    /** controls whether formulas are displayed instead of their
52        results.
53     */
54    [property] boolean ShowFormulas;
55
56    //-------------------------------------------------------------------------
57
58    /** enables display of zero-values.
59     */
60    [property] boolean ShowZeroValues;
61
62    //-------------------------------------------------------------------------
63
64    /** controls whether strings, values, and formulas are
65        displayed in different colors.
66     */
67    [property] boolean IsValueHighlightingEnabled;
68
69    //-------------------------------------------------------------------------
70
71    /** controls whether a marker is shown for notes in cells.
72     */
73    [property] boolean ShowNotes;
74
75    //-------------------------------------------------------------------------
76
77    /** enables the vertical scroll bar of the view.
78     */
79    [property] boolean HasVerticalScrollBar;
80
81    //-------------------------------------------------------------------------
82
83    /** enables the horizontal scroll bar of the view.
84     */
85    [property] boolean HasHorizontalScrollBar;
86
87    //-------------------------------------------------------------------------
88
89    /** enables the sheet tabs of the view.
90     */
91    [property] boolean HasSheetTabs;
92
93    //-------------------------------------------------------------------------
94
95    /** enables the display of outline symbols.
96     */
97    [property] boolean IsOutlineSymbolsSet;
98
99    //-------------------------------------------------------------------------
100
101    /** enables the column and row headers of the view.
102     */
103    [property] boolean HasColumnRowHeaders;
104
105    //-------------------------------------------------------------------------
106
107    /** enables the display of the cell grid.
108     */
109    [property] boolean ShowGrid;
110
111    //-------------------------------------------------------------------------
112
113    /** specifies the color in which the cell grid is
114        displayed.
115     */
116    [property] com::sun::star::util::Color GridColor;
117
118    //-------------------------------------------------------------------------
119
120    /** enables display of help lines when moving drawing
121        objects.
122     */
123    [property] boolean ShowHelpLines;
124
125    //-------------------------------------------------------------------------
126
127    /** enables display of anchor symbols when drawing
128        objects are selected.
129     */
130    [property] boolean ShowAnchor;
131
132    //-------------------------------------------------------------------------
133
134    /** enables display of page breaks.
135     */
136    [property] boolean ShowPageBreaks;
137
138    //-------------------------------------------------------------------------
139
140    /** enables solid (colored) handles when drawing
141        objects are selected.
142     */
143    [property] boolean SolidHandles;
144
145    //-------------------------------------------------------------------------
146
147    /** enables display of embedded objects in the view.
148
149        @see SpreadsheetViewObjectsMode
150     */
151    [property] short ShowObjects;
152
153    //-------------------------------------------------------------------------
154
155    /** enables the display of charts in the view.
156
157        @see SpreadsheetViewObjectsMode
158     */
159    [property] short ShowCharts;
160
161    //-------------------------------------------------------------------------
162
163    /** enables the display of drawing objects in the view.
164
165        @see SpreadsheetViewObjectsMode
166     */
167    [property] short ShowDrawing;
168
169    //-------------------------------------------------------------------------
170
171    /** disables the display of marks from online spelling.
172     */
173    [property] boolean HideSpellMarks;
174
175    //-------------------------------------------------------------------------
176    /** This property defines the zoom type for the document.
177
178        @see com::sun::star::view::DocumentZoomType
179    */
180    [property] short ZoomType;
181
182        //-------------------------------------------------------------------------
183        /** Defines the zoom value to use.
184            Valid only if the ZoomType is set to
185            <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>.
186    */
187    [property] short ZoomValue;
188};
189
190//=============================================================================
191
192}; }; }; };
193
194#endif
195
196