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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module text {
  22
  23
  24 /** describes properties that apply to the whole text document.
  25  */
  26 published service DocumentSettings
  27 {
  28     service com::sun::star::document::Settings;
  29
  30     [optional] service com::sun::star::text::PrintSettings;
  31
  32     /** gives access to the properties implemented by this service.
  33      */
  34     interface com::sun::star::beans::XPropertySet;
  35
  36
  37     /** specifies if charts in text documents are updated automatically.
  38
  39         This has no effect if "FieldAutoUpdate" is `FALSE`.
  40     */
  41     [optional, property] boolean ChartAutoUpdate;
  42
  43     /** specifies if spacing between paragraphs and tables is to be
  44         added.
  45
  46         <p>If between two paragraphs, two tables, or a paragraph and a
  47         table, you have defined spacing above and below each object,
  48         usually only the larger one of the two spaces is used.  If the
  49         spacing between the objects are to be added this property has
  50         to be `TRUE`.</p>
  51     */
  52     [optional, property] boolean AddParaTableSpacing;
  53
  54     /** specifies if top paragraph spacing is applied to paragraphs
  55         on the first page of text documents.
  56
  57         <p>If `TRUE`, the paragraph or table spacing to the top will
  58         also be effective at the beginning of a page or column if the
  59         paragraph or table is positioned on the first page of the
  60         document.  The same applies for a page break.</p>
  61     */
  62     [optional, property] boolean AddParaTableSpacingAtStart;
  63
  64     /** specifies the alignment of tab stops in text documents.
  65
  66         <p>If `TRUE` centered and right-aligned paragraphs containing
  67         tabs are formatted as a whole in the center or aligned to the
  68         right. If `FALSE`, only the text to the right of the last
  69         tab, for example, is aligned to the right, while the text to
  70         the left remains where it is.</p>
  71     */
  72     [optional, property] boolean AlignTabStopPosition;
  73
  74     /** specifies if the contents of links in the global document
  75         are saved or not.
  76
  77         <p>This property applies only for master documents.</p>
  78
  79         <p><em>Note</em>: This name is a bit misleading, it should be
  80         something like <code>SaveLinkedDocumentContent</code>.</p>
  81     */
  82     [optional, property] boolean SaveGlobalDocumentLinks;
  83     /** specifies if the document has been created as a label document.
  84
  85         <p>This property indicates that the document contains multiple text frames
  86         and that the content of one frame is duplicated into the other frames
  87         by internally linked text sections.</p>
  88
  89     */
  90     [optional, property] boolean IsLabelDocument;
  91     /** specifies if the former (till OpenOffice.org 1.1) or the new
  92         line spacing formatting is applied.
  93
  94         <p>This property controls how a set line spacing at a paragraph
  95         influences the formatting of the text lines and the spacing between
  96         paragraphs.
  97         If `TRUE`, the formatting till OpenOffice.org 1.1 is
  98         applied. This means, that a proportional line spacing is applied
  99         above and below a text line and that the maximum of the line spacing
 100         value between two paragraphs is added respectively reckoned up with the
 101         paragraph spacing (adding or reckoning up is controlled by document
 102         option AddParaTableSpacing).
 103         If `FALSE` (default for documents since OpenOffice.org 2.0),
 104         a proportional line spacing is only applied below a text line and
 105         it's always added to the paragraph spacing between two paragraphs.</p>
 106
 107         @since OOo 2.0
 108     */
 109     [optional, property] boolean UseFormerLineSpacing;
 110     /** specifies if paragraph and table spacing is added at the
 111         bottom of table cells
 112
 113         <p>This property controls, if the spacing of the last paragraph
 114         respectively table of a table cell is added at the bottom of this
 115         table cells
 116         If `TRUE` (default for documents since OpenOffice.org 2.0),
 117         the spacing of the last paragraph respectively table of a table
 118         cell is added at the bottom of this table cell.
 119         If `FALSE` (typically for documents till OpenOffice.org 1.1),
 120         the spacing of the last paragraph respectively table of a table
 121         cell isn't added at the bottom of this table cell.</p>
 122
 123         @since OOo 2.0
 124     */
 125     [optional, property] boolean AddParaSpacingToTableCells;
 126     /** specifies if the former (till OpenOffice.org 1.1) or the new
 127         object positioning is applied.
 128
 129         <p>This property controls how floating screen objects (Writer
 130         fly frames and drawing objects are positioned.
 131         If `TRUE`, the object positioning till OpenOffice.org 1.1 is
 132         applied. This means, that the top of a paragraph, at which a
 133         floating screen object orients its vertical position, includes
 134         the lower spacing and the line spacing of the previous paragraph.
 135         If `FALSE` (default for documents since OpenOffice.org 2.0),
 136         the top of a paragraph, at which a floating screen object orients
 137         its vertical position, doesn't include the lower spacing and the
 138         line spacing of the previous paragraph.</p>
 139
 140         @since OOo 2.0
 141     */
 142     [optional, property] boolean UseFormerObjectPositioning;
 143
 144     /** specifies if the text wrap of floating screen objects are
 145         considered in a specified way in the positioning algorithm.
 146
 147         <p>This property controls how floating screen objects (Writer
 148         fly frames and drawing objects) are positioned.
 149         If `TRUE`, the object positioning algorithm will consider
 150         the text wrap style, set at the floating screen object.
 151         The attribute BaseFrameProperties::WrapInfluenceOnPosition
 152         specifies how the text wrap is considered.
 153         If `FALSE` (default value), the former object positioning
 154         algorithm (known from OpenOffice.org 1.1) is applied.</p>
 155
 156         @since OOo 2.0
 157     */
 158     [optional, property] boolean ConsiderTextWrapOnObjPos;
 159
 160     /** specifies if Math objects should automatically vertically aligned to
 161         match the baseline of the surrounding text.
 162
 163         <p>If activated formula object that are anchored 'As Character' will be
 164         vertically aligned to have their baseline match with the one from the text.</p>
 165
 166         @since OOo 3.4
 167     */
 168     [optional, property] boolean MathBaselineAlignment;
 169 };
 170
 171
 172 }; }; }; };
 173
 174 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */