offapi/com/sun/star/form/control/FormattedField.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: FormattedField.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_FormattedField_idl__
  32 #define __com_sun_star_form_control_FormattedField_idl__
  33
  34 #ifndef __com_sun_star_awt_UnoControlFormattedField_idl__
  35 #include <com/sun/star/awt/UnoControlFormattedField.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_XBoundControl_idl__
  39 #include <com/sun/star/form/XBoundControl.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module form {  module control {
  45
  46 //=============================================================================
  47
  48 /** describes a control which can be used for inputting values with a arbitrary formatting, and
  49     can (but not necessarily has to) be bound to a database field.
  50
  51     <p>The model of the control has to support the <type scope="com::sun::star::form::component">FormattedField</type>
  52     service.</p>
  53
  54     <p>In addition, this control can be used in HTML forms. It triggers the
  55     <method scope="com::sun::star::form">XSubmit::submit</method> method of the form it belongs to if
  56     the <em>enter</em> key is pressed while it has the focus.</p>
  57
  58     @see com::sun::star::awt::UnoControl
  59     @see com::sun::star::awt::UnoControlModel
  60     @see com::sun::star::util::XNumberFormatsSupplier
  61 */
  62 published service FormattedField
  63 {
  64     service com::sun::star::awt::UnoControlFormattedField;
  65
  66     interface com::sun::star::form::XBoundControl;
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; }; };
  72
  73 /*=============================================================================
  74
  75 =============================================================================*/
  76
  77 #endif
  78
  79