offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.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 /** contributes properties to control the configuration which is global
  25     for all views of a spreadsheet document.
  26
  27     @deprecated
  28
  29     @see com::sun::star::sheet::SpreadsheetDocument
  30  */
  31 published service SpreadsheetDocumentSettings
  32 {
  33
  34 //!published service PropertySet
  35     /** provides access to the properties.
  36      */
  37     interface com::sun::star::beans::XPropertySet;
  38
  39
  40     /** enables iterated calculation of circular references.
  41      */
  42     [property] boolean IsIterationEnabled;
  43
  44
  45     /** specifies how many iterations are carried out.
  46
  47         <p>This setting is only used, if iteration is enabled using
  48         SpreadsheetDocumentSettings::IsIterationEnabled.</p>
  49      */
  50     [property] long IterationCount;
  51
  52
  53     /** specifies the point at which a change in results will stop
  54         the iteration.
  55
  56         <p>More exactly it specifies a difference in the change of the
  57         result between two iterations. If the result difference
  58         is less than or equal to this epsilon-value, the iteration
  59         is stopped.</p>
  60
  61         <p>This setting is only used, if iteration is enabled using
  62         SpreadsheetDocumentSettings::IsIterationEnabled.</p>
  63      */
  64     [property] double IterationEpsilon;
  65
  66
  67     /** specifies the number of decimals in the default number format.
  68      */
  69     [property] short StandardDecimals;
  70
  71
  72     /** specifies the date that is represented by the value zero.
  73      */
  74     [property] com::sun::star::util::Date NullDate;
  75
  76
  77     /** specifies the width of default tabulators.
  78      */
  79     [property] short DefaultTabStop;
  80
  81
  82     /** specifies whether upper and lower cases are treated as equal
  83         when comparing cells.
  84      */
  85     [property] boolean IgnoreCase;
  86
  87
  88     /** specifies whether calculations are performed with the rounded
  89         values displayed in cells (set to `TRUE`) instead of the
  90         internal values (set to `FALSE`).
  91      */
  92     [property] boolean CalcAsShown;
  93
  94
  95     /** specifies whether filter criteria must match entire cell contents.
  96      */
  97     [property] boolean MatchWholeCell;
  98
  99
 100     /** enables online spell checking.
 101      */
 102     [property] boolean SpellOnline;
 103
 104
 105     /** specifies whether column or row labels are looked up from
 106         anywhere on the sheet.
 107
 108         <p>Explicitly defined label ranges are used even if this property
 109         is set to `FALSE`.</p>
 110
 111         @see com::sun::star::sheet::LabelRanges
 112      */
 113     [property] boolean LookUpLabels;
 114
 115
 116     /** specifies whether regular expressions in formulas are enabled,
 117         e.g., for functions which look up spreadsheet contents.
 118
 119         <p>RegularExpressions and Wildcards are mutually exclusive, only
 120         one can have the value `TRUE`. If both are set to `TRUE` via API
 121         calls then the last one set takes precedence.</p>
 122      */
 123     [property] boolean RegularExpressions;
 124
 125
 126     /** contains the interface XForbiddenCharacters.
 127      */
 128     [readonly, optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
 129
 130
 131     /** If this property is set the document has DrawPages. Use this
 132         property to find out, whether the document has DrawPages or not,
 133         because the getDrawPage method on the XDrawPageSupplier and the
 134         getDrawPages method on the XDrawPagesSupplier always creates the
 135         DrawPages if there are none; and this is very slow and needs more
 136         memory.
 137      */
 138     [readonly, optional, property] boolean HasDrawPages;
 139
 140
 141     /** contains the standard document language for Western text.
 142      */
 143     [optional, property] com::sun::star::lang::Locale CharLocale;
 144
 145
 146     /** contains the standard document language for Asian text.
 147      */
 148     [optional, property] com::sun::star::lang::Locale CharLocaleAsian;
 149
 150
 151     /** contains the standard document language for Complex text.
 152      */
 153     [optional, property] com::sun::star::lang::Locale CharLocaleComplex;
 154
 155
 156     /** specifies whether the document data are already loaded.
 157
 158         @since OOo 3.0
 159      */
 160     [optional, property] boolean IsLoaded;
 161
 162
 163     /** specifies whether the undo command is enabled.
 164
 165         @since OOo 3.0
 166      */
 167     [optional, property] boolean IsUndoEnabled;
 168
 169
 170     /** specifies whether the automatic adjustment of the row height is
 171         enabled.
 172
 173         </p>This boolean is actually a counter internally, of the number of times
 174         something has locked the height, so setting it to false will only perform one
 175         unlock operation, and might leave it still locked</p>
 176
 177         @since OOo 3.0
 178      */
 179     [optional, property] boolean IsAdjustHeightEnabled;
 180
 181
 182     /** specifies whether the automatic execution of links is enabled.
 183
 184         @since OOo 3.0
 185      */
 186     [optional, property] boolean IsExecuteLinkEnabled;
 187
 188
 189     /** contains the reference device used for formatting the document.
 190
 191         @since OOo 3.0
 192      */
 193     [readonly, optional, property] com::sun::star::awt::XDevice ReferenceDevice;
 194
 195     /** specifies whether changes record is enabled.
 196
 197         <p>No modification applied if the record changes protection is activated
 198         information given by SpreadsheetDocumentSettings::IsRecordChangesProtected</p>
 199
 200         @since LibreOffice 5.0
 201      */
 202     [optional, property] boolean RecordChanges;
 203
 204     /** specifies whether changes record is protected.
 205
 206         @since LibreOffice 5.0
 207      */
 208     [readonly,optional, property] boolean IsRecordChangesProtected;
 209
 210
 211     /** specifies whether wildcards in formulas are enabled,
 212         e.g., for functions which look up spreadsheet contents.
 213
 214         <p>Wildcards and RegularExpressions are mutually exclusive, only
 215         one can have the value `TRUE`. If both are set to `TRUE` via API
 216         calls then the last one set takes precedence.</p>
 217
 218         @since LibreOffice 5.2
 219      */
 220     [optional, property] boolean Wildcards;
 221
 222 };
 223
 224
 225 }; }; }; };
 226
 227 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */