summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/FootnoteSettings.idl
blob: 3c44f7a7d69b3c53c2845654df862fb516cad61f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/*************************************************************************
 *
 *  $RCSfile: FootnoteSettings.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:22:20 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_text_FootnoteSettings_idl__
#define __com_sun_star_text_FootnoteSettings_idl__


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

// DocMerge from xml: service com::sun::star::text::FootnoteSettings
/** provides access to the settings of footnotes or endnotes in a
    (text) document.
 */
service FootnoteSettings
{
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::text::FootnoteSettings::CharStyleName
    /** contains the name of the character style that is used
            for the label in front of the footnote/endnote text.
     */
    [property] string CharStyleName;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::FootnoteSettings::NumberingType
    /** contains the numbering type for the numbering of the
        footnotes/endnotes.
     */
    [property] short NumberingType;

    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::text::FootnoteSettings::PageStyleName
    /** contains the page style that is used for the page that
            contains the footnote/endnote texts
     */
    [property] string PageStyleName;

    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::text::FootnoteSettings::ParaStyleName
    /** contains the paragraph style that is used for the
            footnote/endnote text.
     */
    [property] string ParaStyleName;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::FootnoteSettings::Prefix
    /** contains the prefix for the footnote/endnote symbol.
     */
    [property] string Prefix;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::FootnoteSettings::StartAt
    /** contains the first number of the automatic numbering
        of footnotes/endnotes.
     */
    [property] short StartAt;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::FootnoteSettings::Suffix
    /** contains the suffix for the footnote/endnote symbol.
     */
    [property] string Suffix;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::FootnoteSettings::BeginNotice
    /** contains the string at the restart of the footnote
        text after a break.



        <p>For footnotes only.</p>
     */
    [optional, property] string BeginNotice;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::FootnoteSettings::EndNotice
    /** contains the string at the end of a footnote part in
        front of a break.



        <p>For footnotes only.</p>
     */
    [optional, property] string EndNotice;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::FootnoteSettings::FootnoteCounting
    /** contains the type of the counting of the footnote numbers.



        <p>For footnotes only.

        </p>@see FootnoteNumbering
     */
    [optional, property] short FootnoteCounting;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::FootnoteSettings::PositionEndOfDoc
    /** If <true></true>, the footnote text is shown at the end of the document.



        <p>For footnotes only.</p>
     */
    [optional, property] boolean PositionEndOfDoc;

};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.2  2000/09/22 07:33:05  os
    #77644# ParagraphStyleName->ParaStyleName

    Revision 1.1.1.1  2000/09/18 23:36:01  hjs
    initial import

    Revision 1.6  2000/09/11 11:52:59  mi
    documentation merged from XML

    Revision 1.4  2000/08/15 15:32:45  os
    #77644# optional parameters and names corrected

    Revision 1.3  2000/02/21 16:18:14  mi
    string documentation from stardiv...*.idl-files

    Revision 1.2  2000/02/07 11:25:01  mi
    zu #70728# missing documentation marked

    Revision 1.1.1.1  1999/11/11 09:48:46  jsc
    new


=============================================================================*/
#endif