offapi/com/sun/star/document/Settings.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: Settings.idl,v $
  10  * $Revision: 1.10 $
  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 #ifndef __com_sun_star_document_Settings_idl__
  31 #define __com_sun_star_document_Settings_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36 #ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
  37 #include <com/sun/star/i18n/XForbiddenCharacters.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42 module com {   module sun {   module star {   module document {
  43
  44 //=============================================================================
  45
  46 /** describes properties that apply to the whole document of any
  47     application.
  48
  49     <p>For application specific settings, please refer to the
  50     individual services.</p>
  51
  52     @see com::sun::star::text::DocumentSettings
  53     @see com::sun::star::sheet::DocumentSettings
  54     @see com::sun::star::drawing::DocumentSettings
  55     @see com::sun::star::presentation::DocumentSettings
  56  */
  57 published service Settings
  58 {
  59     /** gives access to the properties implemented by this service.
  60      */
  61     interface com::sun::star::beans::XPropertySet;
  62
  63     //-------------------------------------------------------------------------
  64
  65     // Note: These settings are global.  However there is a note at
  66     // every property that shows which application currently makes use
  67     // of it.
  68
  69     // Writer and Draw/Impress and Calc
  70     //-------------------------------------------------------------------------
  71     /** gives access to the set of forbidden characters.
  72
  73         @return the
  74             <type scope="com::sun::star::i18n">XForbiddenCharacters</type>
  75             interface to allow retreival and modification of the
  76             forbidden characters set.
  77     */
  78     [optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
  79
  80     // Writer and Calc
  81     //-------------------------------------------------------------------------
  82     /** specifies the update mode for links when loading text documents.
  83
  84         <p>For supported values see the constants group
  85         <type>LinkUpdateModes</type>.</p>
  86     */
  87     [optional, property] short LinkUpdateMode;
  88
  89     // Writer and Draw/Impress and Calc
  90     //-------------------------------------------------------------------------
  91     /** printer used by the document.
  92      */
  93     [property] string PrinterName;
  94
  95     // Writer and Draw/Impress and Calc
  96     //-------------------------------------------------------------------------
  97     /** platform and driver dependent printer setup data.
  98
  99         <p>This property serves to capture the current printer setup
 100         settings, such as paper tray, printer options, etc. The data
 101         can typically be interpreted only by the system that generated
 102         it. The PrinterSetup property may be used to save and restore
 103         the user's printer settings.</p>
 104     */
 105     [property] sequence< byte > PrinterSetup;
 106
 107     // Writer and Draw/Impress and Calc
 108     //-------------------------------------------------------------------------
 109     /** specifies if kerning is applied to Asian punctuation.
 110
 111         <p>Applies only if kerning is enabled.</p>
 112     */
 113     [optional, property] boolean IsKernAsianPunctuation;
 114
 115     // Writer and Draw/Impress and Calc
 116     //-------------------------------------------------------------------------
 117     /** specifies the compression (character spacing) type used for
 118         Asian characters.
 119
 120         @see com::sun::star::text::CharacterCompressionType
 121     */
 122     [optional, property] short CharacterCompressionType;
 123
 124     // Writer and Draw/Impress and Calc
 125     //-------------------------------------------------------------------------
 126     /** specifies if the user-specific settings saved within a
 127         document should be loaded with the document.
 128     */
 129     [optional, property] boolean ApplyUserData;
 130
 131     // Writer and Calc
 132     //-------------------------------------------------------------------------
 133     /** specifies if a new version is created if a document has
 134         been modified and you want to close it.
 135     */
 136     [optional, property] boolean SaveVersionOnClose;
 137
 138     // Writer and Draw/Impress and Calc
 139     //-------------------------------------------------------------------------
 140     /** specifies if the document should be updated when the
 141         template it was created from changes.
 142
 143         <p>Applies only for documents that were created from a template.</p>
 144     */
 145     [optional, property] boolean UpdateFromTemplate;
 146
 147     // Writer
 148     //-------------------------------------------------------------------------
 149     /** specifies if fields in text documents are updated automatically.
 150      */
 151     [optional, property] boolean FieldAutoUpdate;
 152
 153     // Writer
 154     //-------------------------------------------------------------------------
 155     /** The name of the globally registered
 156         <type scope="com::sun::star::sdb">DataSource</type>
 157         from which the current data is taken.
 158
 159         <p>The data source can e.g. be used for feeding a form
 160         letter.</p>
 161     */
 162     [optional, property] string CurrentDatabaseDataSource;
 163
 164     // Writer
 165     //-------------------------------------------------------------------------
 166     /** a string value, specifying the name of the object displayed
 167         currently (or the SQL statement used).
 168     */
 169     [optional, property] string CurrentDatabaseCommand;
 170
 171     // Writer
 172     //-------------------------------------------------------------------------
 173     // Note: What is the property DataTableName?  Is this Writer-specific?
 174     /** determines the interpretation of the property DataTableName.
 175
 176         @see com::sun::star::sdb::CommandType
 177     */
 178     [optional, property] long CurrentDatabaseCommandType;
 179
 180     // Draw and Impress
 181     //-------------------------------------------------------------------------
 182     /**
 183      */
 184     [optional, property] long DefaultTabStop;
 185
 186     // Draw and Impress
 187     //-------------------------------------------------------------------------
 188     /** determines if the document will be printed as a booklet
 189         (brochure), i.e., two document pages are put together on one
 190         physical page, such that you can fold the print result and get
 191         a booklet.
 192
 193         <p>Note, that you have to print in duplex mode, if both,
 194         <member>IsPrintBookletFront</member> and
 195         <member>IsPrintBookletBack</member> are set to <TRUE/>.</p>
 196      */
 197     [optional, property] boolean IsPrintBooklet;
 198
 199     // Draw and Impress
 200     //-------------------------------------------------------------------------
 201     /** is only effective, if <member>IsPrintBooklet</member> is
 202         <TRUE/>.  If this property is also <TRUE/>, only the fronts of
 203         the pages of your booklet are printed.
 204
 205         <p>This is especially useful, if your printer does not supply
 206         duplex printing.</p>
 207      */
 208     [optional, property] boolean IsPrintBookletFront;
 209
 210     // Draw and Impress
 211     //-------------------------------------------------------------------------
 212     /** is only effective, if <member>IsPrintBooklet</member> is
 213         <TRUE/>.  If this property is also <TRUE/>, only the backs of
 214         the pages of your booklet are printed.
 215
 216         <p>This is especially useful, if your printer does not supply
 217         duplex printing.</p>
 218      */
 219     [optional, property] boolean IsPrintBookletBack;
 220
 221     // Draw and Impress
 222     //-------------------------------------------------------------------------
 223     // Note: Define a constant group for that?
 224     /**
 225      */
 226     [optional, property] long PrintQuality;
 227
 228     // Draw and Impress
 229     //-------------------------------------------------------------------------
 230     /** contains the URL that points to a color table (file extension
 231         .soc) that will be used for showing a palette in dialogs using
 232         colors.
 233      */
 234     [optional, property] string ColorTableURL;
 235
 236     // Draw and Impress
 237     //-------------------------------------------------------------------------
 238     /**
 239      */
 240     [optional, property] string DashTableURL;
 241
 242     // Draw and Impress
 243     //-------------------------------------------------------------------------
 244     /**
 245      */
 246     [optional, property] string LineEndTableURL;
 247
 248     // Draw and Impress
 249     //-------------------------------------------------------------------------
 250     /**
 251      */
 252     [optional, property] string HatchTableURL;
 253
 254     // Draw and Impress
 255     //-------------------------------------------------------------------------
 256     /**
 257      */
 258     [optional, property] string GradientTableURL;
 259
 260     // Draw and Impress
 261     //-------------------------------------------------------------------------
 262     /**
 263      */
 264     [optional, property] string BitmapTableURL;
 265
 266     // Calc
 267     //-------------------------------------------------------------------------
 268     /**
 269      */
 270     [optional, property] boolean AutoCalculate;
 271
 272     // Writer, later others
 273     //-------------------------------------------------------------------------
 274     /** forbid use of printer metrics for layout
 275
 276         <p>For supported values see the constants group
 277         <type>PrinterIndependentLayout</type>.</p>
 278      */
 279     [optional, property] short PrinterIndependentLayout;
 280
 281     // Writer, maybe later other applications, too
 282     //-------------------------------------------------------------------------
 283     /** layout engine should add value of a Font's 'external leading'
 284      * attribute to the line spacing.
 285      */
 286     [optional, property] boolean AddExternalLeading;
 287
 288 };
 289
 290 //=============================================================================
 291
 292 }; }; }; };
 293
 294 #endif