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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: TextField.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_control_TextField_idl__
  32 #define __com_sun_star_form_control_TextField_idl__
  33
  34 #ifndef __com_sun_star_awt_UnoControlEdit_idl__
  35 #include <com/sun/star/awt/UnoControlEdit.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_XBoundControl_idl__
  39 #include <com/sun/star/form/XBoundControl.idl>
  40 #endif
  41 #ifndef __com_sun_star_form_XChangeBroadcaster_idl__
  42 #include <com/sun/star/form/XChangeBroadcaster.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module form {  module control {
  48
  49 //=============================================================================
  50
  51 /** describes a control for entering arbiotrary text which can (but not necessarily has to) be bound
  52     to a database field.
  53
  54     <p>The model of the control has to support the <type scope="com::sun::star::form::component">TextField</type>
  55     service.</p>
  56
  57     <p>In addition, this control can be used in HTML forms. It triggers the
  58     <method scope="com::sun::star::form">XSubmit::submit</method> method of the form it belongs to if
  59     the <em>enter</em> is pressed while it has the focus.</p>
  60
  61     @see com::sun::star::awt::UnoControl
  62     @see com::sun::star::awt::UnoControlModel
  63 */
  64 published service TextField
  65 {
  66     service com::sun::star::awt::UnoControlEdit;
  67
  68     interface com::sun::star::form::XBoundControl;
  69
  70     /** allows broadcasts of HTML-compatible change events.
  71
  72         <p>HTML-compatible means that a change event is broadcasted if and only if all of
  73         the following applies.
  74         <ul>
  75             <li>the control loses the focus</li>
  76             <li>the content of the control has changed, compared to the moment where it got the focus.</li>
  77         </ul>
  78         <p/>
  79     */
  80     interface com::sun::star::form::XChangeBroadcaster;
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; }; };
  86
  87 /*=============================================================================
  88
  89 =============================================================================*/
  90
  91 #endif
  92
  93