offapi/com/sun/star/form/component/TextField.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: TextField.idl,v $
  10  * $Revision: 1.11 $
  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 #ifndef __com_sun_star_form_component_TextField_idl__
  31 #define __com_sun_star_form_component_TextField_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControlEditModel_idl__
  34 #include <com/sun/star/awt/UnoControlEditModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_FormControlModel_idl__
  38 #include <com/sun/star/form/FormControlModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_form_component_RichTextControl_idl__
  42 #include <com/sun/star/form/component/RichTextControl.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_form_XReset_idl__
  46 #include <com/sun/star/form/XReset.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module form {  module component {
  53
  54 //=============================================================================
  55
  56 /** specifies a component which allows the input of text, either single- or multi-line.
  57  */
  58 published service TextField
  59 {
  60     service com::sun::star::awt::UnoControlEditModel;
  61
  62     service com::sun::star::form::FormControlModel;
  63
  64     /** specifies optional capabilities for displaying and inputting formatted text.
  65
  66         <p>If the <member>RichTextControl::RichText</member> property is set to <TRUE/>,
  67         then the <type>TextField</type> component will disable it's reset capabilities. This means
  68         that all calls to <member scope="com::sun::star::form">XReset::reset</member> will be ignored.</p>
  69     */
  70     [optional] service RichTextControl;
  71
  72     /** can be used to reset the control to it's default text.
  73
  74         @see TextField::DefaultText
  75     */
  76     interface com::sun::star::form::XReset;
  77
  78     /** contains a default value for the control.
  79
  80         <p>This value is used when the control is initially displayed, and for resetting it.</p>
  81
  82         @see com::sun::star::awt::UnoControlEditModel::Text
  83         @see com::sun::star::form::XReset
  84      */
  85     [property] string DefaultText;
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; }; };
  91
  92 #endif