1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_text_TextDocumentSettings_idl__ 24cdf0e10cSrcweir#define __com_sun_star_text_TextDocumentSettings_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 27cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_document_Settings_idl__ 31cdf0e10cSrcweir#include <com/sun/star/document/Settings.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_text_PrintSettings_idl__ 35cdf0e10cSrcweir#include <com/sun/star/text/PrintSettings.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_text_PrintPreviewSettings_idl__ 39cdf0e10cSrcweir#include <com/sun/star/text/PrintPreviewSettings.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir//============================================================================= 43cdf0e10cSrcweir 44cdf0e10cSrcweirmodule com { module sun { module star { module text { 45cdf0e10cSrcweir 46cdf0e10cSrcweir//============================================================================= 47cdf0e10cSrcweir 48cdf0e10cSrcweir/** describes properties that apply to the whole text document. 49cdf0e10cSrcweir */ 50cdf0e10cSrcweirpublished service DocumentSettings 51cdf0e10cSrcweir{ 52cdf0e10cSrcweir service com::sun::star::document::Settings; 53cdf0e10cSrcweir 54cdf0e10cSrcweir [optional] service com::sun::star::text::PrintSettings; 55cdf0e10cSrcweir 56cdf0e10cSrcweir [optional] service com::sun::star::text::PrintPreviewSettings; 57cdf0e10cSrcweir 58cdf0e10cSrcweir //------------------------------------------------------------------------- 59cdf0e10cSrcweir /** gives access to the properties implemented by this service. 60cdf0e10cSrcweir */ 61cdf0e10cSrcweir interface com::sun::star::beans::XPropertySet; 62cdf0e10cSrcweir 63cdf0e10cSrcweir //------------------------------------------------------------------------- 64cdf0e10cSrcweir 65cdf0e10cSrcweir /** specifies if charts in text documents are updated automatically. 66cdf0e10cSrcweir 67cdf0e10cSrcweir This has no effect if 'FieldAutoUpdate' is <FALSE/>. 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir [optional, property] boolean ChartAutoUpdate; 70cdf0e10cSrcweir 71cdf0e10cSrcweir /** specifies if spacing between paragraphs and tables is to be 72cdf0e10cSrcweir added. 73cdf0e10cSrcweir 74cdf0e10cSrcweir <p>If between two paragraphs, two tables, or a paragraph and a 75cdf0e10cSrcweir table, you have defined spacing above and below each object, 76cdf0e10cSrcweir usually only the larger one of the two spaces is used. If the 77cdf0e10cSrcweir spacing between hte objects are to be added this property has 78cdf0e10cSrcweir to be <TRUE/>.</p> 79cdf0e10cSrcweir */ 80cdf0e10cSrcweir [optional, property] boolean AddParaTableSpacing; 81cdf0e10cSrcweir 82cdf0e10cSrcweir /** specifies if top paragraph spacing is applied to paragraphs 83cdf0e10cSrcweir on the first page of text documents. 84cdf0e10cSrcweir 85cdf0e10cSrcweir <p>If <TRUE/>, the paragraph or table spacing to the top will 86cdf0e10cSrcweir also be effective at the beginning of a page or column if the 87cdf0e10cSrcweir paragraph or table is positioned on the first page of the 88cdf0e10cSrcweir document. The same applies for a page break.</p> 89cdf0e10cSrcweir */ 90cdf0e10cSrcweir [optional, property] boolean AddParaTableSpacingAtStart; 91cdf0e10cSrcweir 92cdf0e10cSrcweir /** specifies the alignment of tab stops in text documents. 93cdf0e10cSrcweir 94cdf0e10cSrcweir <p>If <TRUE/> centered and right-aligned paragraphs containing 95cdf0e10cSrcweir tabs are formatted as a whole in the center or aligned to the 96cdf0e10cSrcweir right. If <FALSE/>, only the text to the right of the last 97cdf0e10cSrcweir tab, for example, is aligned to the right, while the text to 98cdf0e10cSrcweir the left remains where it is.</p> 99cdf0e10cSrcweir */ 100cdf0e10cSrcweir [optional, property] boolean AlignTabStopPosition; 101cdf0e10cSrcweir 102cdf0e10cSrcweir // ------------------------------------------------------------ 103cdf0e10cSrcweir /** specifies if the contents of links in the global document 104cdf0e10cSrcweir are saved or not. 105cdf0e10cSrcweir 106cdf0e10cSrcweir <p>This property applies only for master documents.</p> 107cdf0e10cSrcweir 108cdf0e10cSrcweir <p><em>Note</em>: This name is a bit misleading, it should be 109cdf0e10cSrcweir something like <code>SaveLinkedDocumentContent</code>.</p> 110cdf0e10cSrcweir */ 111cdf0e10cSrcweir [optional, property] boolean SaveGlobalDocumentLinks; 112cdf0e10cSrcweir // ------------------------------------------------------------ 113cdf0e10cSrcweir /** specifies if the document has been created as a label document. 114cdf0e10cSrcweir 115cdf0e10cSrcweir <p>This property indicates that the document contains multiple text frames 116cdf0e10cSrcweir and that the content of one frame is duplicated into the other frames 117cdf0e10cSrcweir by internally linked text sections.</p> 118cdf0e10cSrcweir 119cdf0e10cSrcweir */ 120cdf0e10cSrcweir [optional, property] boolean IsLabelDocument; 121cdf0e10cSrcweir // ------------------------------------------------------------ 122cdf0e10cSrcweir /** specifies if the former (till OpenOffice.org 1.1) or the new 123cdf0e10cSrcweir line spacing formatting is applied. 124cdf0e10cSrcweir 125cdf0e10cSrcweir <p>This property controls how a set line spacing at a paragraph 126cdf0e10cSrcweir influences the formatting of the text lines and the spacing between 127cdf0e10cSrcweir paragraphs. 128cdf0e10cSrcweir If <TRUE/>, the formatting till OpenOffice.org 1.1 is 129cdf0e10cSrcweir applied. This means, that a proportional line spacing is applied 130cdf0e10cSrcweir above and below a text line and that the maximum of the line spacing 131cdf0e10cSrcweir value between two paragraph is added respectively reckoned up with the 132cdf0e10cSrcweir paragraph spacing (adding or reckoning up is controlled by document 133cdf0e10cSrcweir option AddParaTableSpacing). 134cdf0e10cSrcweir If <FALSE/> (default for documents since OpenOffice.org 2.0), 135cdf0e10cSrcweir a proportional line spacing is only applied below a text line and 136cdf0e10cSrcweir it's always added to the paragraph spacing between two paragraphs.</p> 137cdf0e10cSrcweir 138*2a413f17SJürgen Schmidt @since OpenOffice 2.0 139cdf0e10cSrcweir */ 140cdf0e10cSrcweir [optional, property] boolean UseFormerLineSpacing; 141cdf0e10cSrcweir // ------------------------------------------------------------ 142cdf0e10cSrcweir /** specifies if paragraph and table spacing is added at the 143cdf0e10cSrcweir bottom of table cells 144cdf0e10cSrcweir 145cdf0e10cSrcweir <p>This property controls, if the spacing of the last paragraph 146cdf0e10cSrcweir respectively table of a table cell is added at the bottom of this 147cdf0e10cSrcweir table cells 148cdf0e10cSrcweir If <TRUE/> (default for documents since OpenOffice.org 2.0), 149cdf0e10cSrcweir the spacing of the last paragraph respectively table of a table 150cdf0e10cSrcweir cell is added at the bottom of this table cell. 151cdf0e10cSrcweir If <FALSE/> (typically for documents till OpenOffice.org 1.1), 152cdf0e10cSrcweir the spacing of the last paragraph respectively table of a table 153cdf0e10cSrcweir cell isn't added at the bottom of this table cell.</p> 154cdf0e10cSrcweir 155*2a413f17SJürgen Schmidt @since OpenOffice 2.0 156cdf0e10cSrcweir */ 157cdf0e10cSrcweir [optional, property] boolean AddParaSpacingToTableCells; 158cdf0e10cSrcweir // ------------------------------------------------------------ 159cdf0e10cSrcweir /** specifies if the former (till OpenOffice.org 1.1) or the new 160cdf0e10cSrcweir object positioning is applied. 161cdf0e10cSrcweir 162cdf0e10cSrcweir <p>This property controls how floating screen objects (Writer 163cdf0e10cSrcweir fly frames and drawing objects are positioned. 164cdf0e10cSrcweir If <TRUE/>, the object positioning till OpenOffice.org 1.1 is 165cdf0e10cSrcweir applied. This means, that the top of a paragraph, at which a 166cdf0e10cSrcweir floating screen object orients its vertical position, includes 167cdf0e10cSrcweir the lower spacing and the line spacing of the previous paragraph. 168cdf0e10cSrcweir If <FALSE/> (default for documents since OpenOffice.org 2.0), 169cdf0e10cSrcweir the top of a paragraph, at which a floating screen object orients 170cdf0e10cSrcweir its vertical position, doesn't include the lower spacing and the 171cdf0e10cSrcweir line spacing of the previous paragraph.</p> 172cdf0e10cSrcweir 173*2a413f17SJürgen Schmidt @since OpenOffice 2.0 174cdf0e10cSrcweir */ 175cdf0e10cSrcweir [optional, property] boolean UseFormerObjectPositioning; 176cdf0e10cSrcweir 177cdf0e10cSrcweir // ------------------------------------------------------------ 178cdf0e10cSrcweir /** specifies if the text wrap of floating screen objects are 179cdf0e10cSrcweir considered in a specified way in the positioning algorithm. 180cdf0e10cSrcweir 181cdf0e10cSrcweir <p>This property controls how floating screen objects (Writer 182cdf0e10cSrcweir fly frames and drawing objects) are positioned. 183cdf0e10cSrcweir If <TRUE/>, the object positioning algorithm will consider 184cdf0e10cSrcweir the text wrap style, set at the floating screen object. 185cdf0e10cSrcweir The attribute <member>BaseFrameProperties::WrapInfluenceOnPosition</member> 186cdf0e10cSrcweir specifies how the text wrap is considered. 187cdf0e10cSrcweir If <FALSE/> (default value), the former object positioning 188cdf0e10cSrcweir algorithm (known from OpenOffice.org 1.1) is applied.</p> 189cdf0e10cSrcweir 190*2a413f17SJürgen Schmidt @since OpenOffice 2.0 191cdf0e10cSrcweir */ 192cdf0e10cSrcweir [optional, property] boolean ConsiderTextWrapOnObjPos; 193cdf0e10cSrcweir 194cdf0e10cSrcweir // ------------------------------------------------------------ 195cdf0e10cSrcweir /** specifies if Math objects should automatically vertically aligned to 196cdf0e10cSrcweir match the baseline of the surrounding text. 197cdf0e10cSrcweir 198cdf0e10cSrcweir <p>If activated formula object that are anchored 'As Character' will be 199cdf0e10cSrcweir vertically aligned to have their baseline match with the one from the text.</p> 200cdf0e10cSrcweir 201*2a413f17SJürgen Schmidt @since OpenOffice 3.4 202cdf0e10cSrcweir */ 203cdf0e10cSrcweir [optional, property] boolean MathBaselineAlignment; 204cdf0e10cSrcweir}; 205cdf0e10cSrcweir 206cdf0e10cSrcweir//============================================================================= 207cdf0e10cSrcweir 208cdf0e10cSrcweir}; }; }; }; 209cdf0e10cSrcweir 210*2a413f17SJürgen Schmidt#endif 211