offapi/com/sun/star/text/XTextField.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: XTextField.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_text_XTextField_idl__
  31 #define __com_sun_star_text_XTextField_idl__
  32
  33 #ifndef __com_sun_star_text_XTextContent_idl__
  34 #include <com/sun/star/text/XTextContent.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module text {
  41
  42 //=============================================================================
  43
  44 // DocMerge from xml: interface com::sun::star::text::XTextField
  45 /** is the base interface for all text fields.
  46
  47
  48
  49     <p>A text field is embedded in text and expands to a sequence of
  50     characters.
  51
  52     </p>@see TextField
  53  */
  54 published interface XTextField: com::sun::star::text::XTextContent
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     // DocMerge from idl: method com::sun::star::text::XTextField::getPresentation
  59     /** @returns the display string of the text field either as the command
  60                  of the field or as the output string.
  61                 @param bShowCommand
  62                     if <TRUE/> the command of the field will be returned
  63      */
  64     string getPresentation( [in] boolean bShowCommand );
  65
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; };
  71
  72 #endif