xref: /AOO41X/main/offapi/com/sun/star/sheet/GlobalSheetSettings.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_GlobalSheetSettings_idl__
25#define __com_sun_star_sheet_GlobalSheetSettings_idl__
26
27#ifndef __com_sun_star_beans_XPropertySet_idl__
28#include <com/sun/star/beans/XPropertySet.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37/** contributes properties to access the settings for all spreadsheets of
38    a spreadsheet document.
39 */
40published service GlobalSheetSettings
41{
42    //-------------------------------------------------------------------------
43
44//! service com::sun::star::beans::PropertySet;
45    /** provides access to the properties.
46     */
47    interface com::sun::star::beans::XPropertySet;
48
49    //=========================================================================
50
51    /** specifies whether the cursor is moved after entering into cells.
52     */
53    [property] boolean MoveSelection;
54
55    //-------------------------------------------------------------------------
56
57    /** contains the direction the cursor moves after entering cells.
58
59        @see com::sun::star::sheet::MoveDirection
60     */
61    [property] short MoveDirection;
62
63    //-------------------------------------------------------------------------
64
65    /** specifies whether the enter key can be used to start editing a cell.
66     */
67    [property] boolean EnterEdit;
68
69    //-------------------------------------------------------------------------
70
71    /** specifies whether cell formatting is extended when entering data.
72     */
73    [property] boolean ExtendFormat;
74
75    //-------------------------------------------------------------------------
76
77    /** specifies whether ranges are highlighted on the sheet when
78        editing a formula.
79     */
80    [property] boolean RangeFinder;
81
82    //-------------------------------------------------------------------------
83
84    /** specifies whether formula references are extended when cells
85        are inserted below or to the right of them.
86     */
87    [property] boolean ExpandReferences;
88
89    //-------------------------------------------------------------------------
90
91    /** specifies whether the current selection is highlighted in
92        column and row headers.
93     */
94    [property] boolean MarkHeader;
95
96    //-------------------------------------------------------------------------
97
98    /** specifies whether the enter key moves the cursor to the column
99        it was in before using the tab key to change columns.
100     */
101    [property] boolean UseTabCol;
102
103    //-------------------------------------------------------------------------
104
105    /** contains the metric for all spreadsheet documents.
106
107        @see com::sun::star::util::MeasureUnit
108     */
109    [property] short Metric;
110
111    //-------------------------------------------------------------------------
112
113    /** contains the default scale for new spreadsheet documents
114        (in percent).
115
116        <p>There are several special values:</p>
117        <p>-1 = Optimal width</p>
118        <p>-2 = Show whole page</p>
119        <p>-3 = Page width</p>
120     */
121    [property] short Scale;
122
123    //-------------------------------------------------------------------------
124
125    /** specifies whether automatic completion of text in a cell is used.
126     */
127    [property] boolean DoAutoComplete;
128
129    //-------------------------------------------------------------------------
130
131    /** contains the function that is displayed in the status bar.
132
133        @see com::sun::star::sheet::StatusBarFunction
134     */
135    [property] short StatusBarFunction;
136
137    //-------------------------------------------------------------------------
138
139    /** contains the string lists used for sorting and filling.
140
141        <p>Each string contains the members of a list, separated by
142        commas.</p>
143     */
144    [property] sequence< string > UserLists;
145
146    //-------------------------------------------------------------------------
147
148    /** specifies the update mode for external linked data.
149
150        <p>0 = always</p>
151        <p>1 = never</p>
152        <p>2 = on demand</p>
153     */
154    [optional, property] short LinkUpdateMode;
155
156    //-------------------------------------------------------------------------
157
158    /** specifies whether all sheets or only selected sheets are printed.
159     */
160    [optional, property] boolean PrintAllSheets;
161
162    //-------------------------------------------------------------------------
163
164    /** specifies whether empty pages are printed.
165     */
166    [optional, property] boolean PrintEmptyPages;
167
168    //-------------------------------------------------------------------------
169
170    /** specifies whether printer metrics are used for display.
171     */
172    [optional, property] boolean UsePrinterMetrics;
173
174    //-------------------------------------------------------------------------
175
176    /** specifies whether a warning is shown before replacing cells
177        (i.e. when pasting from clipboard).
178     */
179    [optional, property] boolean ReplaceCellsWarning;
180
181};
182
183//=============================================================================
184
185}; }; }; };
186
187#endif
188
189