LibreOffice 24.2 SDK API Reference
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at .
18  */
21 module com { module sun { module star { module document {
35 published service Settings
36 {
42  // Note: These settings are global. However there is a note at
43  // every property that shows which application currently makes use
44  // of it.
46  // Writer and Draw/Impress and Calc
56  // Writer and Calc
62  [optional, property] short LinkUpdateMode;
64  // Writer and Draw/Impress and Calc
67  [property] string PrinterName;
69  // Writer and Draw/Impress and Calc
78  [property] sequence< byte > PrinterSetup;
80  // Writer and Draw/Impress and Calc
85  [optional, property] boolean IsKernAsianPunctuation;
87  // Writer and Draw/Impress and Calc
93  [optional, property] short CharacterCompressionType;
95  // Writer and Draw/Impress and Calc
99  [optional, property] boolean ApplyUserData;
101  // Writer and Calc
105  [optional, property] boolean SaveVersionOnClose;
107  // Writer and Draw/Impress and Calc
113  [optional, property] boolean UpdateFromTemplate;
115  // Writer
118  [optional, property] boolean FieldAutoUpdate;
120  // Writer
128  [optional, property] string CurrentDatabaseDataSource;
130  // Writer
134  [optional, property] string CurrentDatabaseCommand;
136  // Writer
137  // Note: What is the property DataTableName? Is this Writer-specific?
142  [optional, property] long CurrentDatabaseCommandType;
144  // Draw and Impress
147  [optional, property] long DefaultTabStop;
149  // Draw and Impress
159  [optional, property] boolean IsPrintBooklet;
161  // Draw and Impress
169  [optional, property] boolean IsPrintBookletFront;
171  // Draw and Impress
179  [optional, property] boolean IsPrintBookletBack;
181  // Draw and Impress
190  [optional, property] long PrintQuality;
192  // Draw and Impress
197  [optional, property] string ColorTableURL;
199  // Draw and Impress
202  [optional, property] string DashTableURL;
204  // Draw and Impress
207  [optional, property] string LineEndTableURL;
209  // Draw and Impress
212  [optional, property] string HatchTableURL;
214  // Draw and Impress
217  [optional, property] string GradientTableURL;
219  // Draw and Impress
222  [optional, property] string BitmapTableURL;
224  // Calc
227  [optional, property] boolean AutoCalculate;
229  // Writer, later others
235  [optional, property] short PrinterIndependentLayout;
237  // Writer, maybe later other applications, too
241  [optional, property] boolean AddExternalLeading;
243  // Writer, maybe later others
249  [optional, property] boolean EmbedFonts;
250  // Writer, maybe later others
256  [optional, property] boolean EmbedSystemFonts;
262  [optional, property] boolean EmbedOnlyUsedFonts;
268  [optional, property] boolean EmbedLatinScriptFonts;
274  [optional, property] boolean EmbedAsianScriptFonts;
280  [optional, property] boolean EmbedComplexScriptFonts;
281 };
284 }; }; }; };
286 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
boolean EmbedFonts
Whether to embed fonts used by the document (see e.g.
Definition: Settings.idl:249
boolean EmbedLatinScriptFonts
Whether to embed Latin script fonts.
Definition: Settings.idl:268
short LinkUpdateMode
specifies the update mode for links when loading text documents.
Definition: Settings.idl:62
sequence< byte > PrinterSetup
platform and driver dependent printer setup data.
Definition: Settings.idl:78
string PrinterName
printer used by the document.
Definition: Settings.idl:67
boolean EmbedSystemFonts
Whether to embed also system fonts used by the document.
Definition: Settings.idl:256
boolean EmbedOnlyUsedFonts
Whether to embed only the fonts that are used in the document.
Definition: Settings.idl:262
long CurrentDatabaseCommandType
determines the interpretation of the property DataTableName.
Definition: Settings.idl:142
Definition: Ambiguous.idl:20
boolean AutoCalculate
Definition: Settings.idl:227
string HatchTableURL
Definition: Settings.idl:212
short PrinterIndependentLayout
forbid use of printer metrics for layout
Definition: Settings.idl:235
string DashTableURL
Definition: Settings.idl:202
boolean SaveVersionOnClose
specifies if a new version is created if a document has been modified and you want to close it...
Definition: Settings.idl:105
string CurrentDatabaseCommand
a string value, specifying the name of the object displayed currently (or the SQL statement used)...
Definition: Settings.idl:134
boolean EmbedAsianScriptFonts
Whether to embed Asian script fonts.
Definition: Settings.idl:274
boolean IsPrintBookletBack
is only effective, if IsPrintBooklet is TRUE.
Definition: Settings.idl:179
string CurrentDatabaseDataSource
The name of the globally registered com::sun::star::sdb::DataSource from which the current data is ta...
Definition: Settings.idl:128
long PrintQuality
how printing uses color.
Definition: Settings.idl:190
long DefaultTabStop
Definition: Settings.idl:147
boolean EmbedComplexScriptFonts
Whether to embed Complex script fonts.
Definition: Settings.idl:280
short CharacterCompressionType
specifies the compression (character spacing) type used for Asian characters.
Definition: Settings.idl:93
string GradientTableURL
Definition: Settings.idl:217
boolean IsPrintBookletFront
is only effective, if IsPrintBooklet is TRUE.
Definition: Settings.idl:169
boolean AddExternalLeading
layout engine should add value of a Font&#39;s "external leading" attribute to the line spacing...
Definition: Settings.idl:241
com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters
gives access to the set of forbidden characters.
Definition: Settings.idl:39
boolean ApplyUserData
specifies if the user-specific settings saved within a document should be loaded with the document...
Definition: Settings.idl:99
boolean IsPrintBooklet
determines if the document will be printed as a booklet (brochure), i.e., two document pages are put ...
Definition: Settings.idl:159
describes properties that apply to the whole document of any application.
Definition: Settings.idl:35
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:45
string BitmapTableURL
Definition: Settings.idl:222
boolean IsKernAsianPunctuation
specifies if kerning is applied to Asian punctuation.
Definition: Settings.idl:85
boolean UpdateFromTemplate
specifies if the document should be updated when the template it was created from changes...
Definition: Settings.idl:113
string LineEndTableURL
Definition: Settings.idl:207
provides access to forbidden character settings in a document.
Definition: XForbiddenCharacters.idl:32
string ColorTableURL
contains the URL that points to a color table (file extension .soc) that will be used for showing a p...
Definition: Settings.idl:197
boolean FieldAutoUpdate
specifies if fields in text documents are updated automatically.
Definition: Settings.idl:118