diff options
Diffstat (limited to 'offapi/com/sun/star/document/Settings.idl')
| -rw-r--r-- | offapi/com/sun/star/document/Settings.idl | 293 |
1 files changed, 293 insertions, 0 deletions
diff --git a/offapi/com/sun/star/document/Settings.idl b/offapi/com/sun/star/document/Settings.idl new file mode 100644 index 000000000..55ece20e5 --- /dev/null +++ b/offapi/com/sun/star/document/Settings.idl @@ -0,0 +1,293 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_document_Settings_idl__ +#define __com_sun_star_document_Settings_idl__ + +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/i18n/XForbiddenCharacters.idl> + + +module com { module sun { module star { module document { + + +/** describes properties that apply to the whole document of any + application. + + <p>For application specific settings, please refer to the + individual services.</p> + + @see com::sun::star::text::DocumentSettings + @see com::sun::star::sheet::DocumentSettings + @see com::sun::star::drawing::DocumentSettings + @see com::sun::star::presentation::DocumentSettings + */ +published service Settings +{ + /** gives access to the properties implemented by this service. + */ + interface com::sun::star::beans::XPropertySet; + + + // Note: These settings are global. However there is a note at + // every property that shows which application currently makes use + // of it. + + // Writer and Draw/Impress and Calc + /** gives access to the set of forbidden characters. + + @return the + com::sun::star::i18n::XForbiddenCharacters + interface to allow retrieval and modification of the + forbidden characters set. + */ + [optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters; + + // Writer and Calc + /** specifies the update mode for links when loading text documents. + + <p>For supported values see the constants group + LinkUpdateModes.</p> + */ + [optional, property] short LinkUpdateMode; + + // Writer and Draw/Impress and Calc + /** printer used by the document. + */ + [property] string PrinterName; + + // Writer and Draw/Impress and Calc + /** platform and driver dependent printer setup data. + + <p>This property serves to capture the current printer setup + settings, such as paper tray, printer options, etc. The data + can typically be interpreted only by the system that generated + it. The PrinterSetup property may be used to save and restore + the user's printer settings.</p> + */ + [property] sequence< byte > PrinterSetup; + + // Writer and Draw/Impress and Calc + /** specifies if kerning is applied to Asian punctuation. + + <p>Applies only if kerning is enabled.</p> + */ + [optional, property] boolean IsKernAsianPunctuation; + + // Writer and Draw/Impress and Calc + /** specifies the compression (character spacing) type used for + Asian characters. + + @see com::sun::star::text::CharacterCompressionType + */ + [optional, property] short CharacterCompressionType; + + // Writer and Draw/Impress and Calc + /** specifies if the user-specific settings saved within a + document should be loaded with the document. + */ + [optional, property] boolean ApplyUserData; + + // Writer and Calc + /** specifies if a new version is created if a document has + been modified and you want to close it. + */ + [optional, property] boolean SaveVersionOnClose; + + // Writer and Draw/Impress and Calc + /** specifies if the document should be updated when the + template it was created from changes. + + <p>Applies only for documents that were created from a template.</p> + */ + [optional, property] boolean UpdateFromTemplate; + + // Writer + /** specifies if fields in text documents are updated automatically. + */ + [optional, property] boolean FieldAutoUpdate; + + // Writer + /** The name of the globally registered + com::sun::star::sdb::DataSource + from which the current data is taken. + + <p>The data source can e.g. be used for feeding a form + letter.</p> + */ + [optional, property] string CurrentDatabaseDataSource; + + // Writer + /** a string value, specifying the name of the object displayed + currently (or the SQL statement used). + */ + [optional, property] string CurrentDatabaseCommand; + + // Writer + // Note: What is the property DataTableName? Is this Writer-specific? + /** determines the interpretation of the property DataTableName. + + @see com::sun::star::sdb::CommandType + */ + [optional, property] long CurrentDatabaseCommandType; + + // Draw and Impress + /** + */ + [optional, property] long DefaultTabStop; + + // Draw and Impress + /** determines if the document will be printed as a booklet + (brochure), i.e., two document pages are put together on one + physical page, such that you can fold the print result and get + a booklet. + + <p>Note, that you have to print in duplex mode, if both, + #IsPrintBookletFront and + #IsPrintBookletBack are set to `TRUE`.</p> + */ + [optional, property] boolean IsPrintBooklet; + + // Draw and Impress + /** is only effective, if #IsPrintBooklet is + `TRUE`. If this property is also `TRUE`, only the fronts of + the pages of your booklet are printed. + + <p>This is especially useful, if your printer does not supply + duplex printing.</p> + */ + [optional, property] boolean IsPrintBookletFront; + + // Draw and Impress + /** is only effective, if #IsPrintBooklet is + `TRUE`. If this property is also `TRUE`, only the backs of + the pages of your booklet are printed. + + <p>This is especially useful, if your printer does not supply + duplex printing.</p> + */ + [optional, property] boolean IsPrintBookletBack; + + // Draw and Impress + /** how printing uses color. + + <ul> + <li>0: Default</li> + <li>1: Grayscale</li> + <li>2: Black & White (with grayscale images)</li> + </ul> + */ + [optional, property] long PrintQuality; + + // Draw and Impress + /** contains the URL that points to a color table (file extension + .soc) that will be used for showing a palette in dialogs using + colors. + */ + [optional, property] string ColorTableURL; + + // Draw and Impress + /** + */ + [optional, property] string DashTableURL; + + // Draw and Impress + /** + */ + [optional, property] string LineEndTableURL; + + // Draw and Impress + /** + */ + [optional, property] string HatchTableURL; + + // Draw and Impress + /** + */ + [optional, property] string GradientTableURL; + + // Draw and Impress + /** + */ + [optional, property] string BitmapTableURL; + + // Calc + /** + */ + [optional, property] boolean AutoCalculate; + + // Writer, later others + /** forbid use of printer metrics for layout + + <p>For supported values see the constants group + PrinterIndependentLayout.</p> + */ + [optional, property] short PrinterIndependentLayout; + + // Writer, maybe later other applications, too + /** layout engine should add value of a Font's "external leading" + * attribute to the line spacing. + */ + [optional, property] boolean AddExternalLeading; + + // Writer, maybe later others + /** + Whether to embed fonts used by the document (see e.g. handling + of OOXML embedRegular etc.) + @since LibreOffice 4.0 + */ + [optional, property] boolean EmbedFonts; + // Writer, maybe later others + /** + Whether to embed also system fonts used by the document. + Does not have any effect if EmbedFonts is false. + @since LibreOffice 4.0 + */ + [optional, property] boolean EmbedSystemFonts; + + /** Whether to embed only the fonts that are used in the document. + + @since LibreOffice 6.2 + */ + [optional, property] boolean EmbedOnlyUsedFonts; + + /** Whether to embed Latin script fonts. + + @since LibreOffice 6.2 + */ + [optional, property] boolean EmbedLatinScriptFonts; + + /** Whether to embed Asian script fonts. + + @since LibreOffice 6.2 + */ + [optional, property] boolean EmbedAsianScriptFonts; + + /** Whether to embed Complex script fonts. + + @since LibreOffice 6.2 + */ + [optional, property] boolean EmbedComplexScriptFonts; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |