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