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

   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 #ifndef __com_sun_star_sheet_DocumentSettings_idl__
  28 #define __com_sun_star_sheet_DocumentSettings_idl__
  29
  30 #ifndef __com_sun_star_beans_XPropertySet_idl__
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_Color_idl__
  35 #include <com/sun/star/util/Color.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_document_Settings_idl__
  39 #include <com/sun/star/document/Settings.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** describes properties that apply to the whole spreadsheet document.
  49
  50     <p>For settings that affect view properties, these settings apply to
  51     subsequently created views and are saved with the document, while
  52     <type>SpreadsheetViewSettings</type> can be used to alter a specific
  53     view that is already open.</p>
  54  */
  55 published service DocumentSettings
  56 {
  57     service com::sun::star::document::Settings;
  58
  59     //-------------------------------------------------------------------------
  60     /** provides access to the properties.
  61      */
  62     interface com::sun::star::beans::XPropertySet;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** enables display of zero-values.
  67      */
  68     [optional, property] boolean ShowZeroValues;
  69
  70     /** controls whether a marker is shown for notes in cells.
  71      */
  72     [optional, property] boolean ShowNotes;
  73
  74     /** enables the display of the cell grid.
  75      */
  76     [optional, property] boolean ShowGrid;
  77
  78     /** specifies the color in which the cell grid is displayed.
  79      */
  80     [optional, property] com::sun::star::util::Color GridColor;
  81
  82     /** enables display of page breaks.
  83      */
  84     [optional, property] boolean ShowPageBreaks;
  85
  86     /** enables the column and row headers of the view.
  87      */
  88     [optional, property] boolean HasColumnRowHeaders;
  89
  90     /** enables the sheet tabs of the view.
  91      */
  92     [optional, property] boolean HasSheetTabs;
  93
  94     /** enables the display of outline symbols.
  95      */
  96     [optional, property] boolean IsOutlineSymbolsSet;
  97
  98     /** enables the restriction of object movement and resizing
  99         of drawing objects to the raster.
 100      */
 101     [optional, property] boolean IsSnapToRaster;
 102
 103     /** enables the display of the drawing object raster.
 104      */
 105     [optional, property] boolean RasterIsVisible;
 106
 107     /** specifies the distance between horizontal grid elements
 108         in 1/100 mm.
 109      */
 110     [optional, property] long RasterResolutionX;
 111
 112     /** specifies the distance between vertical grid elements
 113         in 1/100 mm.
 114      */
 115     [optional, property] long RasterResolutionY;
 116
 117     /** specifies the number of subdivisions between two horiontal
 118         grid elements.
 119      */
 120     [optional, property] long RasterSubdivisionX;
 121
 122     /** specifies the number of subdivisions between two vertical
 123         grid elements.
 124      */
 125     [optional, property] long RasterSubdivisionY;
 126
 127     /** enables the synchronization of horizontal and vertical
 128         grid settings in the user interface.
 129      */
 130     [optional, property] boolean IsRasterAxisSynchronized;
 131 };
 132
 133 //=============================================================================
 134
 135 }; }; }; };
 136
 137 #endif