offapi/com/sun/star/text/XTextField.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XTextField_idl__
  28 #define __com_sun_star_text_XTextField_idl__
  29
  30 #ifndef __com_sun_star_text_XTextContent_idl__
  31 #include <com/sun/star/text/XTextContent.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module text {
  38
  39 //=============================================================================
  40
  41 // DocMerge from xml: interface com::sun::star::text::XTextField
  42 /** is the base interface for all text fields.
  43
  44
  45
  46     <p>A text field is embedded in text and expands to a sequence of
  47     characters.
  48
  49     </p>@see TextField
  50  */
  51 published interface XTextField: com::sun::star::text::XTextContent
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     // DocMerge from idl: method com::sun::star::text::XTextField::getPresentation
  56     /** @returns the display string of the text field either as the command
  57                  of the field or as the output string.
  58                 @param bShowCommand
  59                     if <TRUE/> the command of the field will be returned
  60      */
  61     string getPresentation( [in] boolean bShowCommand );
  62
  63 };
  64
  65 //=============================================================================
  66
  67 }; }; }; };
  68
  69 #endif