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