1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
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.
14 *
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).
20 *
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.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_form_component_TextField_idl__
28#define __com_sun_star_form_component_TextField_idl__
29
30#ifndef __com_sun_star_awt_UnoControlEditModel_idl__
31#include <com/sun/star/awt/UnoControlEditModel.idl>
32#endif
33
34#ifndef __com_sun_star_form_FormControlModel_idl__
35#include <com/sun/star/form/FormControlModel.idl>
36#endif
37
38#ifndef __com_sun_star_form_component_RichTextControl_idl__
39#include <com/sun/star/form/component/RichTextControl.idl>
40#endif
41
42#ifndef __com_sun_star_form_XReset_idl__
43#include <com/sun/star/form/XReset.idl>
44#endif
45
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module form {  module component {
50
51//=============================================================================
52
53/** specifies a component which allows the input of text, either single- or multi-line.
54 */
55published service TextField
56{
57	service com::sun::star::awt::UnoControlEditModel;
58
59	service com::sun::star::form::FormControlModel;
60
61    /** specifies optional capabilities for displaying and inputting formatted text.
62
63        <p>If the <member>RichTextControl::RichText</member> property is set to <TRUE/>,
64        then the <type>TextField</type> component will disable it's reset capabilities. This means
65        that all calls to <member scope="com::sun::star::form">XReset::reset</member> will be ignored.</p>
66    */
67    [optional] service RichTextControl;
68
69	/** can be used to reset the control to it's default text.
70
71		@see TextField::DefaultText
72	*/
73	interface com::sun::star::form::XReset;
74
75	/** contains a default value for the control.
76
77		<p>This value is used when the control is initially displayed, and for resetting it.</p>
78
79		@see com::sun::star::awt::UnoControlEditModel::Text
80		@see com::sun::star::form::XReset
81	 */
82	[property] string DefaultText;
83};
84
85//=============================================================================
86
87}; }; }; }; };
88
89#endif
90