merged tag ooo/OOO330_m14
[LibreOffice.git] / offapi / com / sun / star / text / textfield / GetReference.idl
blob27e38613d3dded572a83428f8fc9f532b32eac16
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org. If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
26 ************************************************************************/
28 #ifndef __com_sun_star_text_textfield_GetReference_idl__
29 #define __com_sun_star_text_textfield_GetReference_idl__
31 #include <com/sun/star/text/TextField.idl>
33 //=============================================================================
35 module com { module sun { module star { module text { module textfield {
37 //=============================================================================
38 /** specifies service of a reference field.
39 @see com::sun::star::text::TextField
41 published service GetReference
43 service com::sun::star::text::TextField;
45 /** contains the current content of the text field.
46 <p> This property is escpecially usefull for import/export purposes. </p>
48 [property] string CurrentPresentation;
49 /** contains the source of the reference.
50 @see com::sun::star::text::ReferenceFieldSource
52 [property] short ReferenceFieldSource;
53 /** contains the name of the source.
54 <p> Depending on the property ReferenceFieldSource it may be the name of
55 a bookmark, a reference mark.</p>
57 [property] string SourceName;
58 /** contains the type of the reference.
59 @see com::sun::star::text::ReferenceFieldPart
61 [property] short ReferenceFieldPart;
62 /** contains the sequence number of a set expression field that is used as sequence field
63 or the value of the ReferenceId property of a footnote or endnote.
64 @see com::sun::star::text::Footnote
66 [property] short SequenceNumber;
69 //=============================================================================
71 }; }; }; }; };
73 #endif