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