offapi/com/sun/star/form/component/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 #ifndef __com_sun_star_form_component_TextField_idl__
  20 #define __com_sun_star_form_component_TextField_idl__
  21
  22 #include <com/sun/star/awt/UnoControlEditModel.idl>
  23
  24 #include <com/sun/star/form/FormControlModel.idl>
  25 #include <com/sun/star/form/component/RichTextControl.idl>
  26 #include <com/sun/star/form/XReset.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module form {  module component {
  31
  32
  33 /** specifies a component which allows the input of text, either single- or multi-line.
  34  */
  35 published service TextField
  36 {
  37     service com::sun::star::awt::UnoControlEditModel;
  38
  39     service com::sun::star::form::FormControlModel;
  40
  41     /** specifies optional capabilities for displaying and inputting formatted text.
  42
  43         <p>If the RichTextControl::RichText property is set to `TRUE`,
  44         then the TextField component will disable it's reset capabilities. This means
  45         that all calls to com::sun::star::form::XReset::reset() will be ignored.</p>
  46     */
  47     [optional] service RichTextControl;
  48
  49     /** can be used to reset the control to its default text.
  50
  51         @see TextField::DefaultText
  52     */
  53     interface com::sun::star::form::XReset;
  54
  55     /** contains a default value for the control.
  56
  57         <p>This value is used when the control is initially displayed, and for resetting it.</p>
  58
  59         @see com::sun::star::awt::UnoControlEditModel::Text
  60         @see com::sun::star::form::XReset
  61      */
  62     [property] string DefaultText;
  63 };
  64
  65
  66 }; }; }; }; };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */