offapi/com/sun/star/text/DocumentSettings.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DocumentSettings.idl,v $
  10  * $Revision: 1.16 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_TextDocumentSettings_idl__
  31 #define __com_sun_star_text_TextDocumentSettings_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_document_Settings_idl__
  38 #include <com/sun/star/document/Settings.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_text_PrintSettings_idl__
  42 #include <com/sun/star/text/PrintSettings.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_text_PrintPreviewSettings_idl__
  46 #include <com/sun/star/text/PrintPreviewSettings.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module text {
  52
  53 //=============================================================================
  54
  55 /** describes properties that apply to the whole text document.
  56  */
  57 published service DocumentSettings
  58 {
  59     service com::sun::star::document::Settings;
  60
  61     [optional] service com::sun::star::text::PrintSettings;
  62
  63     [optional] service com::sun::star::text::PrintPreviewSettings;
  64
  65     //-------------------------------------------------------------------------
  66     /** gives access to the properties implemented by this service.
  67      */
  68     interface com::sun::star::beans::XPropertySet;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** specifies if charts in text documents are updated automatically.
  73
  74         This has no effect if 'FieldAutoUpdate' is <FALSE/>.
  75     */
  76     [optional, property] boolean ChartAutoUpdate;
  77
  78     /** specifies if spacing between paragraphs and tables is to be
  79         added.
  80
  81         <p>If between two paragraphs, two tables, or a paragraph and a
  82         table, you have defined spacing above and below each object,
  83         usually only the larger one of the two spaces is used.  If the
  84         spacing between hte objects are to be added this property has
  85         to be <TRUE/>.</p>
  86     */
  87     [optional, property] boolean AddParaTableSpacing;
  88
  89     /** specifies if top paragraph spacing is applied to paragraphs
  90         on the first page of text documents.
  91
  92         <p>If <TRUE/>, the paragraph or table spacing to the top will
  93         also be effective at the beginning of a page or column if the
  94         paragraph or table is positioned on the first page of the
  95         document.  The same applies for a page break.</p>
  96     */
  97     [optional, property] boolean AddParaTableSpacingAtStart;
  98
  99     /** specifies the alignment of tab stops in text documents.
 100
 101         <p>If <TRUE/> centered and right-aligned paragraphs containing
 102         tabs are formatted as a whole in the center or aligned to the
 103         right. If <FALSE/>, only the text to the right of the last
 104         tab, for example, is aligned to the right, while the text to
 105         the left remains where it is.</p>
 106     */
 107     [optional, property] boolean AlignTabStopPosition;
 108
 109     // ------------------------------------------------------------
 110     /** specifies if the contents of links in the global document
 111         are saved or not.
 112
 113         <p>This property applies only for master documents.</p>
 114
 115         <p><em>Note</em>: This name is a bit misleading, it should be
 116         something like <code>SaveLinkedDocumentContent</code>.</p>
 117     */
 118     [optional, property] boolean SaveGlobalDocumentLinks;
 119     // ------------------------------------------------------------
 120     /** specifies if the document has been created as a label document.
 121
 122         <p>This property indicates that the document contains multiple text frames
 123         and that the content of one frame is duplicated into the other frames
 124         by internally linked text sections.</p>
 125
 126     */
 127     [optional, property] boolean IsLabelDocument;
 128     // ------------------------------------------------------------
 129     /** specifies if the former (till OpenOffice.org 1.1) or the new
 130         line spacing formatting is applied.
 131
 132         <p>This property controls how a set line spacing at a paragraph
 133         influences the formatting of the text lines and the spacing between
 134         paragraphs.
 135         If <TRUE/>, the formatting till OpenOffice.org 1.1 is
 136         applied. This means, that a proportional line spacing is applied
 137         above and below a text line and that the maximum of the line spacing
 138         value between two paragraph is added respectively reckoned up with the
 139         paragraph spacing (adding or reckoning up is controlled by document
 140         option AddParaTableSpacing).
 141         If <FALSE/> (default for documents since OpenOffice.org 2.0),
 142         a proportional line spacing is only applied below a text line and
 143         it's always added to the paragraph spacing between two paragraphs.</p>
 144
 145         @since OOo 2.0.0
 146     */
 147     [optional, property] boolean UseFormerLineSpacing;
 148     // ------------------------------------------------------------
 149     /** specifies if paragraph and table spacing is added at the
 150         bottom of table cells
 151
 152         <p>This property controls, if the spacing of the last paragraph
 153         respectively table of a table cell is added at the bottom of this
 154         table cells
 155         If <TRUE/> (default for documents since OpenOffice.org 2.0),
 156         the spacing of the last paragraph respectively table of a table
 157         cell is added at the bottom of this table cell.
 158         If <FALSE/> (typically for documents till OpenOffice.org 1.1),
 159         the spacing of the last paragraph respectively table of a table
 160         cell isn't added at the bottom of this table cell.</p>
 161
 162         @since OOo 2.0.0
 163     */
 164     [optional, property] boolean AddParaSpacingToTableCells;
 165     // ------------------------------------------------------------
 166     /** specifies if the former (till OpenOffice.org 1.1) or the new
 167         object positioning is applied.
 168
 169         <p>This property controls how floating screen objects (Writer
 170         fly frames and drawing objects are positioned.
 171         If <TRUE/>, the object positioning till OpenOffice.org 1.1 is
 172         applied. This means, that the top of a paragraph, at which a
 173         floating screen object orients its vertical position, includes
 174         the lower spacing and the line spacing of the previous paragraph.
 175         If <FALSE/> (default for documents since OpenOffice.org 2.0),
 176         the top of a paragraph, at which a floating screen object orients
 177         its vertical position, doesn't include the lower spacing and the
 178         line spacing of the previous paragraph.</p>
 179
 180         @since OOo 2.0.0
 181     */
 182     [optional, property] boolean UseFormerObjectPositioning;
 183
 184     // ------------------------------------------------------------
 185     /** specifies if the text wrap of floating screen objects are
 186         considered in a specified way in the positioning algorithm.
 187
 188         <p>This property controls how floating screen objects (Writer
 189         fly frames and drawing objects) are positioned.
 190         If <TRUE/>, the object positioning algorithm will consider
 191         the text wrap style, set at the floating screen object.
 192         The attribute <member>BaseFrameProperties::WrapInfluenceOnPosition</member>
 193         specifies how the text wrap is considered.
 194         If <FALSE/> (default value), the former object positioning
 195         algorithm (known from OpenOffice.org 1.1) is applied.</p>
 196
 197         @since OOo 2.0.0
 198     */
 199     [optional, property] boolean ConsiderTextWrapOnObjPos;
 200
 201 };
 202
 203 //=============================================================================
 204
 205 }; }; }; };
 206
 207 #endif