offapi/com/sun/star/text/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.122.1 $
  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_TextField_idl__
  31 #define __com_sun_star_text_TextField_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_TextContent_idl__
  38 #include <com/sun/star/text/TextContent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_text_XTextField_idl__
  42 #include <com/sun/star/text/XTextField.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module text {
  49
  50 //=============================================================================
  51
  52 /** A <type>TextField</type> is a <type>TextContent</type> which fades its
  53     textual representation into the text range to which it is anchored.
  54  */
  55 published service TextField
  56 {
  57     service com::sun::star::text::TextContent;
  58
  59
  60     /** This interface is used to access the textual representation of
  61         this field.
  62      */
  63     interface com::sun::star::text::XTextField;
  64
  65     /** makes it possible to access the properties of the field, if any.
  66     */
  67     [optional] interface com::sun::star::beans::XPropertySet;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** specifies if the text field is actually used in the document.
  72
  73         <p>Not all available text fields are used, for example fields
  74         that are part of unused styles.</p>
  75
  76         @since  OOo 2.0.1
  77      */
  78     [optional, property, readonly] boolean IsFieldUsed;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** specifies if the text field is actually displayed.
  83
  84         <p>Not all available text fields are actually displayed
  85         even when they are used. For example hidden fields or fields
  86         in hidden text are used in the document but get not displayed.</p>
  87
  88         @since  OOo 2.0.1
  89      */
  90     [optional, property, readonly] boolean IsFieldDisplayed;
  91
  92     //-------------------------------------------------------------------------
  93
  94 };
  95
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif