xref: /aoo41x/main/offapi/com/sun/star/text/XTextField.idl (revision d1766043)
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_XTextField_idl__
24#define __com_sun_star_text_XTextField_idl__
25
26#ifndef __com_sun_star_text_XTextContent_idl__
27#include <com/sun/star/text/XTextContent.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module text {
34
35//=============================================================================
36
37// DocMerge from xml: interface com::sun::star::text::XTextField
38/** is the base interface for all text fields.
39
40
41
42	<p>A text field is embedded in text and expands to a sequence of
43	characters.
44
45	</p>@see TextField
46 */
47published interface XTextField: com::sun::star::text::XTextContent
48{
49	//-------------------------------------------------------------------------
50
51	// DocMerge from idl: method com::sun::star::text::XTextField::getPresentation
52	/** @returns the display string of the text field either as the command
53			 	of the field or as the output string.
54				@param bShowCommand
55					if <TRUE/> the command of the field will be returned
56	 */
57	string getPresentation( [in] boolean bShowCommand );
58
59};
60
61//=============================================================================
62
63}; }; }; };
64
65#endif
66