diff options
Diffstat (limited to 'offapi/com/sun/star/form/control/TextField.idl')
-rw-r--r-- | offapi/com/sun/star/form/control/TextField.idl | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/control/TextField.idl b/offapi/com/sun/star/form/control/TextField.idl new file mode 100644 index 000000000..1d88cecdf --- /dev/null +++ b/offapi/com/sun/star/form/control/TextField.idl @@ -0,0 +1,69 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 . + */ + +#ifndef __com_sun_star_form_control_TextField_idl__ +#define __com_sun_star_form_control_TextField_idl__ + +#include <com/sun/star/awt/UnoControlEdit.idl> +#include <com/sun/star/form/XBoundControl.idl> +#include <com/sun/star/form/XChangeBroadcaster.idl> + + + module com { module sun { module star { module form { module control { + + +/** describes a control for entering arbitrary text which can (but not necessarily has to) be bound + to a database field. + + <p>The model of the control has to support the com::sun::star::form::component::TextField + service.</p> + + <p>In addition, this control can be used in HTML forms. It triggers the + com::sun::star::form::XSubmit::submit() method of the form it belongs to if + the <em>enter</em> is pressed while it has the focus.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel +*/ +published service TextField +{ + service com::sun::star::awt::UnoControlEdit; + + interface com::sun::star::form::XBoundControl; + + /** allows broadcasts of HTML-compatible change events. + + <p>HTML-compatible means that a change event is broadcasted if and only if all of + the following applies. + <ul> + <li>the control loses the focus</li> + <li>the content of the control has changed, compared to the moment where it got the focus.</li> + </ul> + </p> + */ + interface com::sun::star::form::XChangeBroadcaster; +}; + + +}; }; }; }; }; + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |