diff options
author | Björn Milcke <bm@openoffice.org> | 2002-11-29 15:51:57 +0000 |
---|---|---|
committer | Björn Milcke <bm@openoffice.org> | 2002-11-29 15:51:57 +0000 |
commit | e71d7472b83d0556808ccd62b0444956571c13d6 (patch) | |
tree | 7825c1f0412fb6f9a6bdf637a17ff0e2639c80fc /offapi/com/sun | |
parent | ccb435bf40e3e0acc9766ea6320ddfa80bd562dc (diff) |
#96976# text-document specific properties were moved to css::text::DocumentSettings
Diffstat (limited to 'offapi/com/sun')
-rw-r--r-- | offapi/com/sun/star/document/Settings.idl | 421 |
1 files changed, 247 insertions, 174 deletions
diff --git a/offapi/com/sun/star/document/Settings.idl b/offapi/com/sun/star/document/Settings.idl index 0bacf917c..844e39bde 100644 --- a/offapi/com/sun/star/document/Settings.idl +++ b/offapi/com/sun/star/document/Settings.idl @@ -2,9 +2,9 @@ * * $RCSfile: Settings.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tl $ $Date: 2002-11-14 16:23:49 $ + * last change: $Author: bm $ $Date: 2002-11-29 16:51:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -50,7 +50,7 @@ * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * - * Copyright: 2000 by Sun Microsystems, Inc. + * Copyright: 2002 by Sun Microsystems, Inc. * * All Rights Reserved. * @@ -58,178 +58,251 @@ * * ************************************************************************/ -#ifndef __com_sun_star_document_Settings_idl__ -#define __com_sun_star_document_Settings_idl__ - -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif -#ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__ +#ifndef __com_sun_star_document_Settings_idl__ +#define __com_sun_star_document_Settings_idl__ + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__ #include <com/sun/star/i18n/XForbiddenCharacters.idl> -#endif - -//============================================================================= - -module com { module sun { module star { module document { - -//============================================================================= - -/** +#endif + +//============================================================================= + +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 */ service Settings -{ - /** gives access to the properties implemented by the service. - */ - interface com::sun::star::beans::XPropertySet; - - - //------------------------------------------------------------------------- - /** gives access to the set of forbidden characters. - * - * Returns the - * <type scope="com::sun::star::i18n">XForbiddenCharacters<\type> - * interface to allow retreival and modification of the forbidden - * characters set. - */ - [optional, readonly, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters; - - //------------------------------------------------------------------------- - /** specifies the update mode for links when loading text documents. - * - * The following values are supported: - * 0: never update links - * 1: manual update (on request while loading). - * 2: automatic update of links. - * 3: the document uses the settings of the Office. - */ - [optional, property] short LinkUpdateMode; - - //------------------------------------------------------------------------- - /** specifies if fields in text documents are updated automatically. - */ - [optional, property] boolean FieldAutoUpdate; - - //------------------------------------------------------------------------- - /** specifies if charts in text documents are updated automatically. - * - * This has no effect if 'FieldAutoUpdate' is <FALSE/>. - */ - [optional, property] boolean ChartAutoUpdate; - - //------------------------------------------------------------------------- - /** specifies if spacing between paragraphs and tables is to be added. - * - * If between two paragraphs, two tables, or a paragraph and a table, - * you have defined spacing above and below - * each object, usually only the larger one of the two spaces is used. - * If the spacing between hte objects are to be - * added this property has to be <TRUE\>. - */ - [optional, property] boolean AddParaTableSpacing; - - //------------------------------------------------------------------------- - /** specifies if top paragraph spacing is applied to paragraphs - * on the first page of text documents. - * - * If <TRUE\>, the paragraph or table spacing to the top will also be - * effective at the beginning of a page or column if the paragraph - * or table is positioned on the first page of the document. - * The same applies for a page break. - */ - [optional, property] boolean AddParaTableSpacingAtStart; - - //------------------------------------------------------------------------- - /** specifies the alignment of tab stops in text documents. - * - * If <TRUE\> centered and right-aligned paragraphs containing - * tabs are formatted as a whole in the center or aligned to - * the right. If <FLASE\>, only the text to the right of the - * last tab, for example, is aligned to the right, while the - * text to the left remains where it is. - */ - [optional, property] boolean AlignTabStopPosition; - - //------------------------------------------------------------------------- - /** printer used by the document. - */ - [optional, property] string PrinterName; - - //------------------------------------------------------------------------- - /** platform and driver dependent printer setup data. - * - * 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. - */ - [optional, property] sequence< byte > PrinterSetup; - - //------------------------------------------------------------------------- - /** specifies if kerning is applied to Asian punctuation. - * - * Applies only if kerning is enabled. - */ - [optional, property] boolean IsKernAsianPunctuation; - - //------------------------------------------------------------------------- - /** specifies the compression (character spacing) type used for - * Asian characters. - * - * @see <type scope="com::sun::star::text">CharacterCompressionType</type> - */ - [optional, property] short CharacterCompressionType; - - //------------------------------------------------------------------------- - /** specifies if the user-specific settings saved within a document - * should be loaded with the document. - */ - [optional, property] boolean ApplyUserData; - - //------------------------------------------------------------------------- - /** specifies if the contents of links in the global document are - * saved or not. - */ - [optional, property] boolean SaveGlobalDocumentLinks; - - //------------------------------------------------------------------------- - /** The name of the globally registered - * <service scope="com::sun::star::sdb">DataSource</service> - * from which the current data is taken. - */ - [optional, property] string CurrentDatabaseDataSource; - - //------------------------------------------------------------------------- - /** a string value, specifying the name of the object displayed - * currently (or the SQL statement used). - */ - [optional, property] string CurrentDatabaseCommand; - - //------------------------------------------------------------------------- - /** determines the interpretation of the property DataTableName. - * - * @see type<scope ="com::sun::star::sdb">CommandType</type> - */ - [optional, property] long CurrentDatabaseCommandType; - - //------------------------------------------------------------------------- - /** specifies if a new version is created if a document has been - * modified and you want to close it. - */ - [optional, property] boolean SaveVersionOnClose; - - //------------------------------------------------------------------------- - /** specifies if the document should be updated when the - * template it was created from changes. - * - * Applies only for documents that were created from a template. - */ - [optional, property] boolean UpdateFromTemplate; - -}; - -//============================================================================= - -}; }; }; }; - -#endif +{ + /** 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 + <type scope="com::sun::star::i18n">XForbiddenCharacters<\type> + interface to allow retreival and modification of the + forbidden characters set. + */ + [optional, readonly, 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 + <type>LinkUpdateModes</type>.</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 + <service scope="com::sun::star::sdb">DataSource</service> + 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, + <member>IsPrintBookletFront</member> and + <member>IsPrintBookletBack</member> are set to <TRUE/>.</p> + */ + [optional, property] boolean IsPrintBooklet; + + // Draw and Impress + //------------------------------------------------------------------------- + /** is only effective, if <member>IsPrintBooklet</member> 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 <member>IsPrintBooklet</member> 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 + //------------------------------------------------------------------------- + // Note: Define a constant group for that? + /** + */ + [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; +}; + +//============================================================================= + +}; }; }; }; +#endif |