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