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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** describes properties that apply to the whole spreadsheet document.
  25
  26     <p>For settings that affect view properties, these settings apply to
  27     subsequently created views and are saved with the document, while
  28     SpreadsheetViewSettings can be used to alter a specific
  29     view that is already open.</p>
  30  */
  31 published service DocumentSettings
  32 {
  33     service com::sun::star::document::Settings;
  34
  35     /** provides access to the properties.
  36      */
  37     interface com::sun::star::beans::XPropertySet;
  38
  39
  40     /** enables display of zero-values.
  41      */
  42     [optional, property] boolean ShowZeroValues;
  43
  44     /** controls whether a marker is shown for notes in cells.
  45      */
  46     [optional, property] boolean ShowNotes;
  47
  48     /** enables the display of the cell grid.
  49      */
  50     [optional, property] boolean ShowGrid;
  51
  52     /** specifies the color in which the cell grid is displayed.
  53      */
  54     [optional, property] com::sun::star::util::Color GridColor;
  55
  56     /** enables display of page breaks.
  57      */
  58     [optional, property] boolean ShowPageBreaks;
  59
  60     /** enables the column and row headers of the view.
  61      */
  62     [optional, property] boolean HasColumnRowHeaders;
  63
  64     /** enables the sheet tabs of the view.
  65      */
  66     [optional, property] boolean HasSheetTabs;
  67
  68     /** enables the display of outline symbols.
  69      */
  70     [optional, property] boolean IsOutlineSymbolsSet;
  71
  72     /** enables the restriction of object movement and resizing
  73         of drawing objects to the raster.
  74      */
  75     [optional, property] boolean IsSnapToRaster;
  76
  77     /** enables the display of the drawing object raster.
  78      */
  79     [optional, property] boolean RasterIsVisible;
  80
  81     /** specifies the distance between horizontal grid elements
  82         in 1/100 mm.
  83      */
  84     [optional, property] long RasterResolutionX;
  85
  86     /** specifies the distance between vertical grid elements
  87         in 1/100 mm.
  88      */
  89     [optional, property] long RasterResolutionY;
  90
  91     /** specifies the number of subdivisions between two horizontal
  92         grid elements.
  93      */
  94     [optional, property] long RasterSubdivisionX;
  95
  96     /** specifies the number of subdivisions between two vertical
  97         grid elements.
  98      */
  99     [optional, property] long RasterSubdivisionY;
 100
 101     /** enables the synchronization of horizontal and vertical
 102         grid settings in the user interface.
 103      */
 104     [optional, property] boolean IsRasterAxisSynchronized;
 105
 106     /** enables the document sharing feature (Tools->Share Spreadsheet)
 107      */
 108     [optional, property] boolean IsDocumentShared;
 109 };
 110
 111
 112 }; }; }; };
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */