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

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