offapi/com/sun/star/sheet/GlobalSheetSettings.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: GlobalSheetSettings.idl,v $
  10  * $Revision: 1.7 $
  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_GlobalSheetSettings_idl__
  32 #define __com_sun_star_sheet_GlobalSheetSettings_idl__
  33
  34 #ifndef __com_sun_star_beans_XPropertySet_idl__
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** contributes properties to access the settings for all spreadsheets of
  45     a spreadsheet document.
  46  */
  47 published service GlobalSheetSettings
  48 {
  49     //-------------------------------------------------------------------------
  50
  51 //! service com::sun::star::beans::PropertySet;
  52     /** provides access to the properties.
  53      */
  54     interface com::sun::star::beans::XPropertySet;
  55
  56     //=========================================================================
  57
  58     /** specifies whether the cursor is moved after entering into cells.
  59      */
  60     [property] boolean MoveSelection;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** contains the direction the cursor moves after entering cells.
  65
  66         @see com::sun::star::sheet::MoveDirection
  67      */
  68     [property] short MoveDirection;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** specifies whether the enter key can be used to start editing a cell.
  73      */
  74     [property] boolean EnterEdit;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** specifies whether cell formatting is extended when entering data.
  79      */
  80     [property] boolean ExtendFormat;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** specifies whether ranges are highlighted on the sheet when
  85         editing a formula.
  86      */
  87     [property] boolean RangeFinder;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** specifies whether formula references are extended when cells
  92         are inserted below or to the right of them.
  93      */
  94     [property] boolean ExpandReferences;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** specifies whether the current selection is highlighted in
  99         column and row headers.
 100      */
 101     [property] boolean MarkHeader;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** specifies whether the enter key moves the cursor to the column
 106         it was in before using the tab key to change columns.
 107      */
 108     [property] boolean UseTabCol;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** contains the metric for all spreadsheet documents.
 113
 114         @see com::sun::star::util::MeasureUnit
 115      */
 116     [property] short Metric;
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** contains the default scale for new spreadsheet documents
 121         (in percent).
 122
 123         <p>There are several special values:</p>
 124         <p>-1 = Optimal width</p>
 125         <p>-2 = Show whole page</p>
 126         <p>-3 = Page width</p>
 127      */
 128     [property] short Scale;
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** specifies whether automatic completion of text in a cell is used.
 133      */
 134     [property] boolean DoAutoComplete;
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** contains the function that is displayed in the status bar.
 139
 140         @see com::sun::star::sheet::StatusBarFunction
 141      */
 142     [property] short StatusBarFunction;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** contains the string lists used for sorting and filling.
 147
 148         <p>Each string contains the members of a list, separated by
 149         commas.</p>
 150      */
 151     [property] sequence< string > UserLists;
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** specifies the update mode for external linked data.
 156
 157         <p>0 = always</p>
 158         <p>1 = never</p>
 159         <p>2 = on demand</p>
 160      */
 161     [optional, property] short LinkUpdateMode;
 162
 163     //-------------------------------------------------------------------------
 164
 165     /** specifies whether all sheets or only selected sheets are printed.
 166      */
 167     [optional, property] boolean PrintAllSheets;
 168
 169     //-------------------------------------------------------------------------
 170
 171     /** specifies whether empty pages are printed.
 172      */
 173     [optional, property] boolean PrintEmptyPages;
 174
 175     //-------------------------------------------------------------------------
 176
 177     /** specifies whether printer metrics are used for display.
 178      */
 179     [optional, property] boolean UsePrinterMetrics;
 180
 181     //-------------------------------------------------------------------------
 182
 183     /** specifies whether a warning is shown before replacing cells
 184         (i.e. when pasting from clipboard).
 185      */
 186     [optional, property] boolean ReplaceCellsWarning;
 187
 188 };
 189
 190 //=============================================================================
 191
 192 }; }; }; };
 193
 194 #endif
 195