offapi/com/sun/star/text/FootnoteSettings.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_FootnoteSettings_idl__
  28 #define __com_sun_star_text_FootnoteSettings_idl__
  29
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module text {
  34
  35 //=============================================================================
  36
  37 /** provides access to the settings of footnotes or endnotes in a
  38     (text) document.
  39  */
  40 published service FootnoteSettings
  41 {
  42     //-------------------------------------------------------------------------
  43
  44     /** contains the name of the character style that is used
  45             for the label in front of the footnote/endnote text.
  46      */
  47     [property] string CharStyleName;
  48
  49     //-------------------------------------------------------------------------
  50
  51     /** contains the numbering type for the numbering of the
  52         footnotes/endnotes.
  53      */
  54     [property] short NumberingType;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** contains the page style that is used for the page that
  59             contains the footnote/endnote texts
  60      */
  61     [property] string PageStyleName;
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** contains the paragraph style that is used for the
  66             footnote/endnote text.
  67      */
  68     [property] string ParaStyleName;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** contains the prefix for the footnote/endnote symbol.
  73      */
  74     [property] string Prefix;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** contains the first number of the automatic numbering
  79         of footnotes/endnotes.
  80      */
  81     [property] short StartAt;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** contains the suffix for the footnote/endnote symbol.
  86      */
  87     [property] string Suffix;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** contains the string at the restart of the footnote
  92         text after a break.
  93
  94         <p>For footnotes only.</p>
  95      */
  96     [optional, property] string BeginNotice;
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** contains the string at the end of a footnote part in
 101         front of a break.
 102
 103         <p>For footnotes only.</p>
 104      */
 105     [optional, property] string EndNotice;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** contains the type of the counting of the footnote numbers.
 110
 111         <p>For footnotes only.</p>
 112         @see FootnoteNumbering
 113      */
 114     [optional, property] short FootnoteCounting;
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** If <TRUE/>, the footnote text is shown at the end of the document.
 119
 120         <p>For footnotes only.</p>
 121      */
 122     [optional, property] boolean PositionEndOfDoc;
 123
 124     //-------------------------------------------------------------------------
 125
 126     /** contains the name of the character style that is used
 127         for footnote/endnote anchor in the text.
 128
 129         @since OOo 2.0.0
 130      */
 131     [optional, property] string AnchorCharStyleName;
 132
 133 };
 134
 135 //=============================================================================
 136
 137 }; }; }; };
 138
 139 #endif