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