offapi/com/sun/star/sheet/DocumentSettings.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DocumentSettings.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sheet_DocumentSettings_idl__
  31 #define __com_sun_star_sheet_DocumentSettings_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_document_Settings_idl__
  42 #include <com/sun/star/document/Settings.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module sheet {
  48
  49 //=============================================================================
  50
  51 /** describes properties that apply to the whole spreadsheet document.
  52
  53     <p>For settings that affect view properties, these settings apply to
  54     subsequently created views and are saved with the document, while
  55     <type>SpreadsheetViewSettings</type> can be used to alter a specific
  56     view that is already open.</p>
  57  */
  58 published service DocumentSettings
  59 {
  60     service com::sun::star::document::Settings;
  61
  62     //-------------------------------------------------------------------------
  63     /** provides access to the properties.
  64      */
  65     interface com::sun::star::beans::XPropertySet;
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** enables display of zero-values.
  70      */
  71     [optional, property] boolean ShowZeroValues;
  72
  73     /** controls whether a marker is shown for notes in cells.
  74      */
  75     [optional, property] boolean ShowNotes;
  76
  77     /** enables the display of the cell grid.
  78      */
  79     [optional, property] boolean ShowGrid;
  80
  81     /** specifies the color in which the cell grid is displayed.
  82      */
  83     [optional, property] com::sun::star::util::Color GridColor;
  84
  85     /** enables display of page breaks.
  86      */
  87     [optional, property] boolean ShowPageBreaks;
  88
  89     /** enables the column and row headers of the view.
  90      */
  91     [optional, property] boolean HasColumnRowHeaders;
  92
  93     /** enables the sheet tabs of the view.
  94      */
  95     [optional, property] boolean HasSheetTabs;
  96
  97     /** enables the display of outline symbols.
  98      */
  99     [optional, property] boolean IsOutlineSymbolsSet;
 100
 101     /** enables the restriction of object movement and resizing
 102         of drawing objects to the raster.
 103      */
 104     [optional, property] boolean IsSnapToRaster;
 105
 106     /** enables the display of the drawing object raster.
 107      */
 108     [optional, property] boolean RasterIsVisible;
 109
 110     /** specifies the distance between horizontal grid elements
 111         in 1/100 mm.
 112      */
 113     [optional, property] long RasterResolutionX;
 114
 115     /** specifies the distance between vertical grid elements
 116         in 1/100 mm.
 117      */
 118     [optional, property] long RasterResolutionY;
 119
 120     /** specifies the number of subdivisions between two horiontal
 121         grid elements.
 122      */
 123     [optional, property] long RasterSubdivisionX;
 124
 125     /** specifies the number of subdivisions between two vertical
 126         grid elements.
 127      */
 128     [optional, property] long RasterSubdivisionY;
 129
 130     /** enables the synchronization of horizontal and vertical
 131         grid settings in the user interface.
 132      */
 133     [optional, property] boolean IsRasterAxisSynchronized;
 134 };
 135
 136 //=============================================================================
 137
 138 }; }; }; };
 139
 140 #endif