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