offapi/com/sun/star/text/FootnoteSettings.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
  22  module com {  module sun {  module star {  module text {
  23
  24
  25 /** provides access to the settings of footnotes or endnotes in a
  26     (text) document.
  27  */
  28 published service FootnoteSettings
  29 {
  30
  31     /** contains the name of the character style that is used
  32             for the label in front of the footnote/endnote text.
  33      */
  34     [property] string CharStyleName;
  35
  36
  37     /** contains the numbering type for the numbering of the
  38         footnotes/endnotes.
  39      */
  40     [property] short NumberingType;
  41
  42
  43     /** contains the page style that is used for the page that
  44             contains the footnote/endnote texts
  45      */
  46     [property] string PageStyleName;
  47
  48
  49     /** contains the paragraph style that is used for the
  50             footnote/endnote text.
  51      */
  52     [property] string ParaStyleName;
  53
  54
  55     /** contains the prefix for the footnote/endnote symbol.
  56      */
  57     [property] string Prefix;
  58
  59
  60     /** contains the first number of the automatic numbering
  61         of footnotes/endnotes.
  62      */
  63     [property] short StartAt;
  64
  65
  66     /** contains the suffix for the footnote/endnote symbol.
  67      */
  68     [property] string Suffix;
  69
  70
  71     /** contains the string at the restart of the footnote
  72         text after a break.
  73
  74         <p>For footnotes only.</p>
  75      */
  76     [optional, property] string BeginNotice;
  77
  78
  79     /** contains the string at the end of a footnote part in
  80         front of a break.
  81
  82         <p>For footnotes only.</p>
  83      */
  84     [optional, property] string EndNotice;
  85
  86
  87     /** contains the type of the counting of the footnote numbers.
  88
  89         <p>For footnotes only.</p>
  90         @see FootnoteNumbering
  91      */
  92     [optional, property] short FootnoteCounting;
  93
  94
  95     /** If `TRUE`, the footnote text is shown at the end of the document.
  96
  97         <p>For footnotes only.</p>
  98      */
  99     [optional, property] boolean PositionEndOfDoc;
 100
 101
 102     /** contains the name of the character style that is used
 103         for footnote/endnote anchor in the text.
 104
 105         @since OOo 2.0
 106      */
 107     [optional, property] string AnchorCharStyleName;
 108
 109 };
 110
 111
 112 }; }; }; };
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */