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

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