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