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#ifndef __com_sun_star_sheet_DocumentSettings_idl__
24#define __com_sun_star_sheet_DocumentSettings_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30#ifndef __com_sun_star_util_Color_idl__
31#include <com/sun/star/util/Color.idl>
32#endif
33
34#ifndef __com_sun_star_document_Settings_idl__
35#include <com/sun/star/document/Settings.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module sheet {
41
42//=============================================================================
43
44/** describes properties that apply to the whole spreadsheet document.
45
46    <p>For settings that affect view properties, these settings apply to
47    subsequently created views and are saved with the document, while
48    <type>SpreadsheetViewSettings</type> can be used to alter a specific
49    view that is already open.</p>
50 */
51published service DocumentSettings
52{
53    service com::sun::star::document::Settings;
54
55    //-------------------------------------------------------------------------
56    /** provides access to the properties.
57     */
58    interface com::sun::star::beans::XPropertySet;
59
60    //-------------------------------------------------------------------------
61
62    /** enables display of zero-values.
63     */
64    [optional, property] boolean ShowZeroValues;
65
66    /** controls whether a marker is shown for notes in cells.
67     */
68    [optional, property] boolean ShowNotes;
69
70    /** enables the display of the cell grid.
71     */
72    [optional, property] boolean ShowGrid;
73
74    /** specifies the color in which the cell grid is displayed.
75     */
76    [optional, property] com::sun::star::util::Color GridColor;
77
78    /** enables display of page breaks.
79     */
80    [optional, property] boolean ShowPageBreaks;
81
82    /** enables the column and row headers of the view.
83     */
84    [optional, property] boolean HasColumnRowHeaders;
85
86    /** enables the sheet tabs of the view.
87     */
88    [optional, property] boolean HasSheetTabs;
89
90    /** enables the display of outline symbols.
91     */
92    [optional, property] boolean IsOutlineSymbolsSet;
93
94    /** enables the restriction of object movement and resizing
95        of drawing objects to the raster.
96     */
97    [optional, property] boolean IsSnapToRaster;
98
99    /** enables the display of the drawing object raster.
100     */
101    [optional, property] boolean RasterIsVisible;
102
103    /** specifies the distance between horizontal grid elements
104        in 1/100 mm.
105     */
106    [optional, property] long RasterResolutionX;
107
108    /** specifies the distance between vertical grid elements
109        in 1/100 mm.
110     */
111    [optional, property] long RasterResolutionY;
112
113    /** specifies the number of subdivisions between two horiontal
114        grid elements.
115     */
116    [optional, property] long RasterSubdivisionX;
117
118    /** specifies the number of subdivisions between two vertical
119        grid elements.
120     */
121    [optional, property] long RasterSubdivisionY;
122
123    /** enables the synchronization of horizontal and vertical
124        grid settings in the user interface.
125     */
126    [optional, property] boolean IsRasterAxisSynchronized;
127};
128
129//=============================================================================
130
131}; }; }; };
132
133#endif
134