LibreOffice LibreOffice 25.2 SDK API Reference

Settings.idl
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 http://mozilla.org/MPL/2.0/.
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 http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21module com { module sun { module star { module document {
22
23
35published service Settings
36{
39 interface com::sun::star::beans::XPropertySet;
40
41
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.
45
46 // Writer and Draw/Impress and Calc
54 [optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
55
56 // Writer and Calc
62 [optional, property] short LinkUpdateMode;
63
64 // Writer and Draw/Impress and Calc
67 [property] string PrinterName;
68
69 // Writer and Draw/Impress and Calc
78 [property] sequence< byte > PrinterSetup;
79
80 // Writer and Draw/Impress and Calc
85 [optional, property] boolean IsKernAsianPunctuation;
86
87 // Writer and Draw/Impress and Calc
93 [optional, property] short CharacterCompressionType;
94
95 // Writer and Draw/Impress and Calc
99 [optional, property] boolean ApplyUserData;
100
101 // Writer and Calc
105 [optional, property] boolean SaveVersionOnClose;
106
107 // Writer and Draw/Impress and Calc
113 [optional, property] boolean UpdateFromTemplate;
114
115 // Writer
118 [optional, property] boolean FieldAutoUpdate;
119
120 // Writer
128 [optional, property] string CurrentDatabaseDataSource;
129
130 // Writer
134 [optional, property] string CurrentDatabaseCommand;
135
136 // Writer
137 // Note: What is the property DataTableName? Is this Writer-specific?
142 [optional, property] long CurrentDatabaseCommandType;
143
144 // Draw and Impress
147 [optional, property] long DefaultTabStop;
148
149 // Draw and Impress
159 [optional, property] boolean IsPrintBooklet;
160
161 // Draw and Impress
169 [optional, property] boolean IsPrintBookletFront;
170
171 // Draw and Impress
179 [optional, property] boolean IsPrintBookletBack;
180
181 // Draw and Impress
190 [optional, property] long PrintQuality;
191
192 // Draw and Impress
197 [optional, property] string ColorTableURL;
198
199 // Draw and Impress
202 [optional, property] string DashTableURL;
203
204 // Draw and Impress
207 [optional, property] string LineEndTableURL;
208
209 // Draw and Impress
212 [optional, property] string HatchTableURL;
213
214 // Draw and Impress
217 [optional, property] string GradientTableURL;
218
219 // Draw and Impress
222 [optional, property] string BitmapTableURL;
223
224 // Calc
227 [optional, property] boolean AutoCalculate;
228
229 // Writer, later others
235 [optional, property] short PrinterIndependentLayout;
236
237 // Writer, maybe later other applications, too
241 [optional, property] boolean AddExternalLeading;
242
243 // Writer, maybe later others
249 [optional, property] boolean EmbedFonts;
250 // Writer, maybe later others
256 [optional, property] boolean EmbedSystemFonts;
257
262 [optional, property] boolean EmbedOnlyUsedFonts;
263
268 [optional, property] boolean EmbedLatinScriptFonts;
269
274 [optional, property] boolean EmbedAsianScriptFonts;
275
280 [optional, property] boolean EmbedComplexScriptFonts;
281};
282
283
284}; }; }; };
285
286/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:46
com::sun::star::i18n::XForbiddenCharacters
provides access to forbidden character settings in a document.
Definition: XForbiddenCharacters.idl:33
com
Definition: Ambiguous.idl:20
com::sun::star::document::Settings
describes properties that apply to the whole document of any application.
Definition: Settings.idl:36
com::sun::star::document::Settings::UpdateFromTemplate
boolean UpdateFromTemplate
specifies if the document should be updated when the template it was created from changes.
Definition: Settings.idl:113
com::sun::star::document::Settings::IsPrintBookletBack
boolean IsPrintBookletBack
is only effective, if IsPrintBooklet is TRUE.
Definition: Settings.idl:179
com::sun::star::document::Settings::PrinterName
string PrinterName
printer used by the document.
Definition: Settings.idl:67
com::sun::star::document::Settings::LinkUpdateMode
short LinkUpdateMode
specifies the update mode for links when loading text documents.
Definition: Settings.idl:62
com::sun::star::document::Settings::SaveVersionOnClose
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
com::sun::star::document::Settings::EmbedComplexScriptFonts
boolean EmbedComplexScriptFonts
Whether to embed Complex script fonts.
Definition: Settings.idl:280
com::sun::star::document::Settings::DefaultTabStop
long DefaultTabStop
Definition: Settings.idl:147
com::sun::star::document::Settings::ColorTableURL
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
com::sun::star::document::Settings::CurrentDatabaseDataSource
string CurrentDatabaseDataSource
The name of the globally registered com::sun::star::sdb::DataSource from which the current data is ta...
Definition: Settings.idl:128
com::sun::star::document::Settings::EmbedFonts
boolean EmbedFonts
Whether to embed fonts used by the document (see e.g.
Definition: Settings.idl:249
com::sun::star::document::Settings::PrinterIndependentLayout
short PrinterIndependentLayout
forbid use of printer metrics for layout
Definition: Settings.idl:235
com::sun::star::document::Settings::EmbedAsianScriptFonts
boolean EmbedAsianScriptFonts
Whether to embed Asian script fonts.
Definition: Settings.idl:274
com::sun::star::document::Settings::CurrentDatabaseCommandType
long CurrentDatabaseCommandType
determines the interpretation of the property DataTableName.
Definition: Settings.idl:142
com::sun::star::document::Settings::ApplyUserData
boolean ApplyUserData
specifies if the user-specific settings saved within a document should be loaded with the document.
Definition: Settings.idl:99
com::sun::star::document::Settings::CurrentDatabaseCommand
string CurrentDatabaseCommand
a string value, specifying the name of the object displayed currently (or the SQL statement used).
Definition: Settings.idl:134
com::sun::star::document::Settings::IsPrintBookletFront
boolean IsPrintBookletFront
is only effective, if IsPrintBooklet is TRUE.
Definition: Settings.idl:169
com::sun::star::document::Settings::GradientTableURL
string GradientTableURL
Definition: Settings.idl:217
com::sun::star::document::Settings::DashTableURL
string DashTableURL
Definition: Settings.idl:202
com::sun::star::document::Settings::IsKernAsianPunctuation
boolean IsKernAsianPunctuation
specifies if kerning is applied to Asian punctuation.
Definition: Settings.idl:85
com::sun::star::document::Settings::FieldAutoUpdate
boolean FieldAutoUpdate
specifies if fields in text documents are updated automatically.
Definition: Settings.idl:118
com::sun::star::document::Settings::IsPrintBooklet
boolean IsPrintBooklet
determines if the document will be printed as a booklet (brochure), i.e., two document pages are put ...
Definition: Settings.idl:159
com::sun::star::document::Settings::EmbedLatinScriptFonts
boolean EmbedLatinScriptFonts
Whether to embed Latin script fonts.
Definition: Settings.idl:268
com::sun::star::document::Settings::EmbedSystemFonts
boolean EmbedSystemFonts
Whether to embed also system fonts used by the document.
Definition: Settings.idl:256
com::sun::star::document::Settings::HatchTableURL
string HatchTableURL
Definition: Settings.idl:212
com::sun::star::document::Settings::AddExternalLeading
boolean AddExternalLeading
layout engine should add value of a Font's "external leading" attribute to the line spacing.
Definition: Settings.idl:241
com::sun::star::document::Settings::PrinterSetup
sequence< byte > PrinterSetup
platform and driver dependent printer setup data.
Definition: Settings.idl:78
com::sun::star::document::Settings::BitmapTableURL
string BitmapTableURL
Definition: Settings.idl:222
com::sun::star::document::Settings::LineEndTableURL
string LineEndTableURL
Definition: Settings.idl:207
com::sun::star::document::Settings::PrintQuality
long PrintQuality
how printing uses color.
Definition: Settings.idl:190
com::sun::star::document::Settings::AutoCalculate
boolean AutoCalculate
Definition: Settings.idl:227
com::sun::star::document::Settings::CharacterCompressionType
short CharacterCompressionType
specifies the compression (character spacing) type used for Asian characters.
Definition: Settings.idl:93
com::sun::star::document::Settings::ForbiddenCharacters
com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters
gives access to the set of forbidden characters.
Definition: Settings.idl:39
com::sun::star::document::Settings::EmbedOnlyUsedFonts
boolean EmbedOnlyUsedFonts
Whether to embed only the fonts that are used in the document.
Definition: Settings.idl:262