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