summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/GlobalSheetSettings.idl
blob: 664aa584a0358bc5ca9cc6b6e03c128bee96a913 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_GlobalSheetSettings_idl__
#define __com_sun_star_sheet_GlobalSheetSettings_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** contributes properties to access the settings for all spreadsheets of
    a spreadsheet document.
 */
published service GlobalSheetSettings
{
    //-------------------------------------------------------------------------

//! service com::sun::star::beans::PropertySet;
    /** provides access to the properties.
     */
    interface com::sun::star::beans::XPropertySet;

    //=========================================================================

    /** specifies whether the cursor is moved after entering into cells.
     */
    [property] boolean MoveSelection;

    //-------------------------------------------------------------------------

    /** contains the direction the cursor moves after entering cells.

        @see com::sun::star::sheet::MoveDirection
     */
    [property] short MoveDirection;

    //-------------------------------------------------------------------------

    /** specifies whether the enter key can be used to start editing a cell.
     */
    [property] boolean EnterEdit;

    //-------------------------------------------------------------------------

    /** specifies whether cell formatting is extended when entering data.
     */
    [property] boolean ExtendFormat;

    //-------------------------------------------------------------------------

    /** specifies whether ranges are highlighted on the sheet when
        editing a formula.
     */
    [property] boolean RangeFinder;

    //-------------------------------------------------------------------------

    /** specifies whether formula references are extended when cells
        are inserted below or to the right of them.
     */
    [property] boolean ExpandReferences;

    //-------------------------------------------------------------------------

    /** specifies whether the current selection is highlighted in
        column and row headers.
     */
    [property] boolean MarkHeader;

    //-------------------------------------------------------------------------

    /** specifies whether the enter key moves the cursor to the column
        it was in before using the tab key to change columns.
     */
    [property] boolean UseTabCol;

    //-------------------------------------------------------------------------

    /** contains the metric for all spreadsheet documents.

        @see com::sun::star::util::MeasureUnit
     */
    [property] short Metric;

    //-------------------------------------------------------------------------

    /** contains the default scale for new spreadsheet documents
        (in percent).

        <p>There are several special values:</p>
        <p>-1 = Optimal width</p>
        <p>-2 = Show whole page</p>
        <p>-3 = Page width</p>
     */
    [property] short Scale;

    //-------------------------------------------------------------------------

    /** specifies whether automatic completion of text in a cell is used.
     */
    [property] boolean DoAutoComplete;

    //-------------------------------------------------------------------------

    /** contains the function that is displayed in the status bar.

        @see com::sun::star::sheet::StatusBarFunction
     */
    [property] short StatusBarFunction;

    //-------------------------------------------------------------------------

    /** contains the string lists used for sorting and filling.

        <p>Each string contains the members of a list, separated by
        commas.</p>
     */
    [property] sequence< string > UserLists;

    //-------------------------------------------------------------------------

    /** specifies the update mode for external linked data.

        <p>0 = always</p>
        <p>1 = never</p>
        <p>2 = on demand</p>
     */
    [optional, property] short LinkUpdateMode;

    //-------------------------------------------------------------------------

    /** specifies whether all sheets or only selected sheets are printed.
     */
    [optional, property] boolean PrintAllSheets;

    //-------------------------------------------------------------------------

    /** specifies whether empty pages are printed.
     */
    [optional, property] boolean PrintEmptyPages;

    //-------------------------------------------------------------------------

    /** specifies whether printer metrics are used for display.
     */
    [optional, property] boolean UsePrinterMetrics;

    //-------------------------------------------------------------------------

    /** specifies whether a warning is shown before replacing cells
        (i.e. when pasting from clipboard).
     */
    [optional, property] boolean ReplaceCellsWarning;

};

//=============================================================================

}; }; }; };

#endif