xref: /AOO41X/main/offapi/com/sun/star/text/textfield/GetReference.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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
24#ifndef __com_sun_star_text_textfield_GetReference_idl__
25#define __com_sun_star_text_textfield_GetReference_idl__
26
27#include <com/sun/star/text/TextField.idl>
28
29//=============================================================================
30
31module com { module sun { module star { module text { module textfield {
32
33//=============================================================================
34/** specifies service of a reference field.
35    @see com::sun::star::text::TextField
36*/
37published service GetReference
38{
39    service  com::sun::star::text::TextField;
40
41    /** contains the current content of the text field.
42        <p> This property is escpecially usefull for import/export purposes. </p>
43     */
44    [property] string CurrentPresentation;
45    /** contains the source of the reference.
46        @see com::sun::star::text::ReferenceFieldSource
47     */
48    [property] short ReferenceFieldSource;
49    /** contains the name of the source.
50     <p> Depending on the property ReferenceFieldSource it may be the name of
51     a bookmark, a reference mark.</p>
52     */
53    [property] string SourceName;
54    /** contains the type of the reference.
55        @see com::sun::star::text::ReferenceFieldPart
56     */
57    [property] short ReferenceFieldPart;
58    /** contains the sequence number of a set expression field that is used as sequence field
59        or the value of the ReferenceId property of a footnote or endnote.
60        @see com::sun::star::text::Footnote
61     */
62    [property] short SequenceNumber;
63};
64
65//=============================================================================
66
67}; }; }; }; };
68
69#endif
70
71