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