summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/DocumentSettings.idl
blob: a1533bc9dead1d24cca656dfad6a2ab47462dcf3 (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
/*************************************************************************
 *
 * 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_DocumentSettings_idl__
#define __com_sun_star_sheet_DocumentSettings_idl__

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

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_document_Settings_idl__
#include <com/sun/star/document/Settings.idl>
#endif

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

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

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

/** describes properties that apply to the whole spreadsheet document.

    <p>For settings that affect view properties, these settings apply to
    subsequently created views and are saved with the document, while
    <type>SpreadsheetViewSettings</type> can be used to alter a specific
    view that is already open.</p>
 */
published service DocumentSettings
{
    service com::sun::star::document::Settings;
    
    //-------------------------------------------------------------------------
    /** provides access to the properties.
     */
    interface com::sun::star::beans::XPropertySet;

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

    /** enables display of zero-values.
     */
    [optional, property] boolean ShowZeroValues;

    /** controls whether a marker is shown for notes in cells.
     */
    [optional, property] boolean ShowNotes;

    /** enables the display of the cell grid.
     */
    [optional, property] boolean ShowGrid;

    /** specifies the color in which the cell grid is displayed.
     */
    [optional, property] com::sun::star::util::Color GridColor;

    /** enables display of page breaks.
     */
    [optional, property] boolean ShowPageBreaks;

    /** enables the column and row headers of the view.
     */
    [optional, property] boolean HasColumnRowHeaders;

    /** enables the sheet tabs of the view.
     */
    [optional, property] boolean HasSheetTabs;

    /** enables the display of outline symbols.
     */
    [optional, property] boolean IsOutlineSymbolsSet;

    /** enables the restriction of object movement and resizing
        of drawing objects to the raster.
     */
    [optional, property] boolean IsSnapToRaster;

    /** enables the display of the drawing object raster.
     */
    [optional, property] boolean RasterIsVisible;

    /** specifies the distance between horizontal grid elements
        in 1/100 mm.
     */
    [optional, property] long RasterResolutionX;

    /** specifies the distance between vertical grid elements
        in 1/100 mm.
     */
    [optional, property] long RasterResolutionY;

    /** specifies the number of subdivisions between two horiontal
        grid elements.
     */
    [optional, property] long RasterSubdivisionX;

    /** specifies the number of subdivisions between two vertical
        grid elements.
     */
    [optional, property] long RasterSubdivisionY;

    /** enables the synchronization of horizontal and vertical
        grid settings in the user interface.
     */
    [optional, property] boolean IsRasterAxisSynchronized;
};

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

}; }; }; };

#endif