offapi/com/sun/star/text/textfield/Input.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: Input.idl,v $
  10  * $Revision: 1.8 $
  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
  31 #ifndef __com_sun_star_text_textfield_Input_idl__
  32 #define __com_sun_star_text_textfield_Input_idl__
  33
  34 #include <com/sun/star/text/TextField.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module text { module textfield {
  39
  40 //=============================================================================
  41 /**     specifies service of a text input field.
  42     @see com::sun::star::text::TextField
  43 */
  44 published service Input
  45 {
  46     service  com::sun::star::text::TextField;
  47
  48     //-------------------------------------------------------------------------
  49     /** contains the text content of the text field.
  50         <p> The field displays the text content.</p>
  51      */
  52     [optional, property] string Content;
  53
  54     //-------------------------------------------------------------------------
  55     /** contains a hint text.
  56      <p> This hint may be used as help tip or as headline of a corresponding
  57          dialog to edit the field content.</p>
  58      */
  59     [optional, property] string Hint;
  60
  61     //-------------------------------------------------------------------------
  62     /** contains an internal-use-only multi purpose string.
  63      <p>This is an internal multi purpose string used in WW8 import/export.
  64         Usually it holds the help text for form fields.</p>
  65      <p>It's content must NEVER be modified by the user.</p>
  66      */
  67     [optional, property] string Help;
  68
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; }; };
  74
  75 #endif
  76