xref: /trunk/main/offapi/com/sun/star/form/control/FormattedField.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_form_control_FormattedField_idl__
#define __com_sun_star_form_control_FormattedField_idl__

#ifndef __com_sun_star_awt_UnoControlFormattedField_idl__
#include <com/sun/star/awt/UnoControlFormattedField.idl>
#endif

#ifndef __com_sun_star_form_XBoundControl_idl__
#include <com/sun/star/form/XBoundControl.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module form {  module control {

//=============================================================================

/** describes a control which can be used for inputting values with a arbitrary formatting, and
	can (but not necessarily has to) be bound to a database field.

	<p>The model of the control has to support the <type scope="com::sun::star::form::component">FormattedField</type>
	service.</p>

	<p>In addition, this control can be used in HTML forms. It triggers the
	<method scope="com::sun::star::form">XSubmit::submit</method> method of the form it belongs to if
	the <em>enter</em> key is pressed while it has the focus.</p>

	@see com::sun::star::awt::UnoControl
	@see com::sun::star::awt::UnoControlModel
	@see com::sun::star::util::XNumberFormatsSupplier
*/
published service FormattedField
{
	service com::sun::star::awt::UnoControlFormattedField;

	interface com::sun::star::form::XBoundControl;
};

//=============================================================================

}; }; }; }; };

/*=============================================================================

=============================================================================*/

#endif