xref: /aoo41x/main/offapi/com/sun/star/text/textfield/GetReference.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_text_textfield_GetReference_idl__
#define __com_sun_star_text_textfield_GetReference_idl__

#include <com/sun/star/text/TextField.idl>

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

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

//=============================================================================
/**	specifies service of a reference field.
	@see com::sun::star::text::TextField
*/
published service GetReference
{
	service  com::sun::star::text::TextField;

	/** contains the current content of the text field.
		<p> This property is escpecially usefull for import/export purposes. </p>
	 */
	[property] string CurrentPresentation;
	/** contains the source of the reference.
        @see com::sun::star::text::ReferenceFieldSource
	 */
	[property] short ReferenceFieldSource;
	/** contains the name of the source.
	 <p> Depending on the property ReferenceFieldSource it may be the name of
	 a bookmark, a reference mark.</p>
	 */
	[property] string SourceName;
	/** contains the type of the reference.
        @see com::sun::star::text::ReferenceFieldPart
	 */
	[property] short ReferenceFieldPart;
	/** contains the sequence number of a set expression field that is used as sequence field
	 	or the value of the ReferenceId property of a footnote or endnote.
        @see com::sun::star::text::Footnote
	 */
	[property] short SequenceNumber;
};

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

}; }; }; }; };

#endif