1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_text_FootnoteSettings_idl__ 24#define __com_sun_star_text_FootnoteSettings_idl__ 25 26 27//============================================================================= 28 29 module com { module sun { module star { module text { 30 31//============================================================================= 32 33/** provides access to the settings of footnotes or endnotes in a 34 (text) document. 35 */ 36published service FootnoteSettings 37{ 38 //------------------------------------------------------------------------- 39 40 /** contains the name of the character style that is used 41 for the label in front of the footnote/endnote text. 42 */ 43 [property] string CharStyleName; 44 45 //------------------------------------------------------------------------- 46 47 /** contains the numbering type for the numbering of the 48 footnotes/endnotes. 49 */ 50 [property] short NumberingType; 51 52 //------------------------------------------------------------------------- 53 54 /** contains the page style that is used for the page that 55 contains the footnote/endnote texts 56 */ 57 [property] string PageStyleName; 58 59 //------------------------------------------------------------------------- 60 61 /** contains the paragraph style that is used for the 62 footnote/endnote text. 63 */ 64 [property] string ParaStyleName; 65 66 //------------------------------------------------------------------------- 67 68 /** contains the prefix for the footnote/endnote symbol. 69 */ 70 [property] string Prefix; 71 72 //------------------------------------------------------------------------- 73 74 /** contains the first number of the automatic numbering 75 of footnotes/endnotes. 76 */ 77 [property] short StartAt; 78 79 //------------------------------------------------------------------------- 80 81 /** contains the suffix for the footnote/endnote symbol. 82 */ 83 [property] string Suffix; 84 85 //------------------------------------------------------------------------- 86 87 /** contains the string at the restart of the footnote 88 text after a break. 89 90 <p>For footnotes only.</p> 91 */ 92 [optional, property] string BeginNotice; 93 94 //------------------------------------------------------------------------- 95 96 /** contains the string at the end of a footnote part in 97 front of a break. 98 99 <p>For footnotes only.</p> 100 */ 101 [optional, property] string EndNotice; 102 103 //------------------------------------------------------------------------- 104 105 /** contains the type of the counting of the footnote numbers. 106 107 <p>For footnotes only.</p> 108 @see FootnoteNumbering 109 */ 110 [optional, property] short FootnoteCounting; 111 112 //------------------------------------------------------------------------- 113 114 /** If <TRUE/>, the footnote text is shown at the end of the document. 115 116 <p>For footnotes only.</p> 117 */ 118 [optional, property] boolean PositionEndOfDoc; 119 120 //------------------------------------------------------------------------- 121 122 /** contains the name of the character style that is used 123 for footnote/endnote anchor in the text. 124 125 @since OpenOffice 2.0 126 */ 127 [optional, property] string AnchorCharStyleName; 128 129}; 130 131//============================================================================= 132 133}; }; }; }; 134 135#endif 136