xref: /aoo4110/main/offapi/com/sun/star/text/Footnote.idl (revision b1cdbd2c) 
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_Footnote_idl__
24#define __com_sun_star_text_Footnote_idl__
25
26#ifndef __com_sun_star_text_XFootnote_idl__
27#include <com/sun/star/text/XFootnote.idl>
28#endif
29
30#ifndef __com_sun_star_text_XText_idl__
31#include <com/sun/star/text/XText.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module text {
38
39//=============================================================================
40/** This service specifies a footnote or an endnote in a
41	<type>TextDocument</type>.
42*/
43published service Footnote
44{
45
46	/** provides access to the footnote label, which is the
47		anchor text range.
48
49	*/
50	interface com::sun::star::text::XFootnote;
51
52	/** provides access to the text of the footnote (or
53		endnote).
54
55	*/
56	interface com::sun::star::text::XText;
57	/**	contains an internal identifier for the use as SequenceNumber property in reference fields.
58	 @see com.sun.star.text.textfield.GetReference.
59	 */
60	[optional, readonly, property]short ReferenceId;
61};
62
63//=============================================================================
64
65}; }; }; };
66
67#endif
68