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