offapi/com/sun/star/form/control/TextField.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_form_control_TextField_idl__
  21 #define __com_sun_star_form_control_TextField_idl__
  22
  23 #include <com/sun/star/awt/UnoControlEdit.idl>
  24 #include <com/sun/star/form/XBoundControl.idl>
  25 #include <com/sun/star/form/XChangeBroadcaster.idl>
  26
  27
  28  module com {  module sun {  module star {  module form {  module control {
  29
  30
  31 /** describes a control for entering arbitrary text which can (but not necessarily has to) be bound
  32     to a database field.
  33
  34     <p>The model of the control has to support the com::sun::star::form::component::TextField
  35     service.</p>
  36
  37     <p>In addition, this control can be used in HTML forms. It triggers the
  38     com::sun::star::form::XSubmit::submit() method of the form it belongs to if
  39     the <em>enter</em> is pressed while it has the focus.</p>
  40
  41     @see com::sun::star::awt::UnoControl
  42     @see com::sun::star::awt::UnoControlModel
  43 */
  44 published service TextField
  45 {
  46     service com::sun::star::awt::UnoControlEdit;
  47
  48     interface com::sun::star::form::XBoundControl;
  49
  50     /** allows broadcasts of HTML-compatible change events.
  51
  52         <p>HTML-compatible means that a change event is broadcasted if and only if all of
  53         the following applies.
  54         <ul>
  55             <li>the control loses the focus</li>
  56             <li>the content of the control has changed, compared to the moment where it got the focus.</li>
  57         </ul>
  58         </p>
  59     */
  60     interface com::sun::star::form::XChangeBroadcaster;
  61 };
  62
  63
  64 }; }; }; }; };
  65
  66 #endif
  67
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */