offapi/com/sun/star/form/control/FormattedField.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_FormattedField_idl__
  21 #define __com_sun_star_form_control_FormattedField_idl__
  22
  23 #include <com/sun/star/awt/UnoControlFormattedField.idl>
  24 #include <com/sun/star/form/XBoundControl.idl>
  25
  26
  27  module com {  module sun {  module star {  module form {  module control {
  28
  29
  30 /** describes a control which can be used for inputting values with a arbitrary formatting, and
  31     can (but not necessarily has to) be bound to a database field.
  32
  33     <p>The model of the control has to support the com::sun::star::form::component::FormattedField
  34     service.</p>
  35
  36     <p>In addition, this control can be used in HTML forms. It triggers the
  37     com::sun::star::form::XSubmit::submit() method of the form it belongs to if
  38     the <em>enter</em> key is pressed while it has the focus.</p>
  39
  40     @see com::sun::star::awt::UnoControl
  41     @see com::sun::star::awt::UnoControlModel
  42     @see com::sun::star::util::XNumberFormatsSupplier
  43 */
  44 published service FormattedField
  45 {
  46     service com::sun::star::awt::UnoControlFormattedField;
  47
  48     interface com::sun::star::form::XBoundControl;
  49 };
  50
  51
  52 }; }; }; }; };
  53
  54 #endif
  55
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */