offapi/com/sun/star/text/TextSection.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 module com { module sun { module star { module text {
  21
  22 /** A TextSection is a range of complete paragraphs within a text.
  23
  24     <p>The content of the section may be the content of a link into another
  25     document, a link from the same document, or the result of a DDE
  26     operation.
  27
  28     <p>TextSection instances can be linked from and to other
  29     texts.
  30
  31 */
  32 published service TextSection
  33 {
  34     service com::sun::star::text::TextContent;
  35
  36     [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
  37
  38     interface com::sun::star::text::XTextSection;
  39     interface com::sun::star::container::XNamed;
  40     interface com::sun::star::beans::XPropertySet;
  41     interface com::sun::star::beans::XPropertyState;
  42
  43     /**  This property contains a conditional expression.
  44
  45     <p>If the result of the conditional expression is `TRUE` and the property
  46     TextSection::IsVisible is `FALSE`, then the section is hidden.</p>
  47     */
  48     [property] string Condition;
  49
  50     /** If this property is `FALSE`, the text section is hidden.
  51     */
  52     [property] boolean IsVisible;
  53
  54     /** If this property is `TRUE`, the text section is protected
  55         and cannot be modified from the user interface.
  56     */
  57     [property] boolean IsProtected;
  58
  59     /** If this property is set, then the content of the section is read
  60         from the specified document.
  61
  62     */
  63     [property] com::sun::star::text::SectionFileLink FileLink;
  64
  65     /**  specifies the source of a file link in the document that is
  66     specified in TextSection::FileLink.
  67
  68     <p>The source may be a text section or a bookmark.
  69     If TextSection::FileLink is empty, then the
  70     current document is searched for the source. If this property
  71     is empty and TextSection::FileLink is set,
  72     then the complete document content is linked into this section.</p>
  73     */
  74     [property] string LinkRegion;
  75
  76     /**  specifies the type of the command string for a DDE operation.
  77      <p>The type can be the name of the application that provides a DDE source.</p>
  78     */
  79     [property] string DDECommandType;
  80
  81     /**  specifies the source file name of the command string for a DDE operation.
  82     */
  83     [property] string DDECommandFile;
  84
  85     /**  specifies the source element of the command string for a DDE operation.
  86      <p>The element can be i.e. a name of a cell in a sheet or a bookmark.</p>
  87     */
  88     [property] string DDECommandElement;
  89
  90     /** contains the URL for the background graphic.
  91
  92         @deprecated as of LibreOffice 6.1 - use BackGraphic instead
  93
  94         Note the new behaviour since it this was deprecated:
  95         This property can only be set and only external URLs are
  96         supported (no more vnd.sun.star.GraphicObject scheme). When an
  97         URL is set, then it will load the graphic and set the BackGraphic
  98         property.
  99     */
 100     [property] string BackGraphicURL;
 101
 102     /**  contains the name of the file filter for the background graphic.
 103     */
 104     [property] string BackGraphicFilter;
 105
 106     /** determines the position of the background graphic.
 107
 108         @see GraphicLocation
 109     */
 110     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
 111     /** determines whether footnotes inside the section are displayed at the end of the
 112      section text.
 113     */
 114     [property] boolean FootnoteIsCollectAtTextEnd;
 115     /** determines whether the footnotes numbering restarts within the section.
 116      This is only valid if <code>FootnoteIsRestartNumbering</code> is set.
 117     */
 118     [property] boolean FootnoteIsRestartNumbering;
 119     /** determines at which number the footnote numbering inside of the section starts.
 120      This is only valid if <code>FootnoteIsRestartNumbering</code> is set.
 121     */
 122     [property] short FootnoteRestartNumberingAt;
 123     /** determines whether the footnotes within the section use an own numbering format.
 124      This is only valid if <code>FootnoteIsRestartNumbering</code> is set.
 125     */
 126     [property] boolean FootnoteIsOwnNumbering;
 127     /** determines the numbering type of the footnote numbering as a value of
 128      com::sun::star::style::NumberingType.
 129      This is only valid if <code>FootnoteIsOwnNumbering</code> is set.
 130     */
 131     [property] short FootnoteNumberingType;
 132     /** determines the prefix that is display before the footnote number.
 133      This is only valid if <code>FootnoteIsOwnNumbering</code> is set.
 134     */
 135     [property] string FootnoteNumberingPrefix;
 136     /** determines the suffix that is display after of the footnote number.
 137      This is only valid if <code>FootnoteIsOwnNumbering</code> is set.
 138     */
 139     [property] string FootnoteNumberingSuffix;
 140     /** determines whether endnotes inside the section are displayed at the end of the
 141      section text.
 142     */
 143     [property] boolean EndnoteIsCollectAtTextEnd;
 144     /** determines whether the endnotes numbering restarts within the section.
 145      This is only valid if <code>EndnoteIsRestartNumbering</code> is set.
 146     */
 147     [property] boolean EndnoteIsRestartNumbering;
 148     /** determines at which number the endnote numbering inside of the section starts.
 149      This is only valid if <code>EndnoteIsRestartNumbering</code> is set.
 150     */
 151     [property] short EndnoteRestartNumberingAt;
 152     /** determines whether the endnotes within the section use an own numbering format.
 153      This is only valid if <code>EndnoteIsRestartNumbering</code> is set.
 154     */
 155     [property] boolean EndnoteIsOwnNumbering;
 156     /** determines the numbering type of the endnote numbering as a value of
 157      com::sun::star::style::NumberingType.
 158      This is only valid if <code>EndoteIsOwnNumbering</code> is set.
 159     */
 160     [property] short EndnoteNumberingType;
 161     /** determines the prefix that is display before the endnote number.
 162      This is only valid if <code>EndnoteIsOwnNumbering</code> is set.
 163     */
 164     [property] string EndnoteNumberingPrefix;
 165     /** determines the suffix that is display after the endnote number.
 166      This is only valid if <code>EndnoteIsOwnNumbering</code> is set.
 167     */
 168     [property] string EndnoteNumberingSuffix;
 169     /** determines if a DDE link is updated automatically.
 170     */
 171     [property] boolean IsAutomaticUpdate;
 172     /** allows columns to be set into the text section
 173     */
 174     [property] com::sun::star::text::XTextColumns TextColumns;
 175     /** determines the left margin of the section
 176      */
 177     [optional, property] long SectionLeftMargin;
 178     /** determines the left margin of the section
 179      */
 180     [optional, property] long SectionRightMargin;
 181
 182     /** contains the graphic of the background.
 183
 184         @since LibreOffice 6.1
 185      */
 186     [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
 187 };
 188
 189
 190 }; }; }; };
 191
 192 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */