1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_text_TextField_idl__ 24#define __com_sun_star_text_TextField_idl__ 25 26#ifndef __com_sun_star_beans_XPropertySet_idl__ 27#include <com/sun/star/beans/XPropertySet.idl> 28#endif 29 30#ifndef __com_sun_star_text_TextContent_idl__ 31#include <com/sun/star/text/TextContent.idl> 32#endif 33 34#ifndef __com_sun_star_text_XTextField_idl__ 35#include <com/sun/star/text/XTextField.idl> 36#endif 37 38 39//============================================================================= 40 41 module com { module sun { module star { module text { 42 43//============================================================================= 44 45/** A <type>TextField</type> is a <type>TextContent</type> which fades its 46 textual representation into the text range to which it is anchored. 47 */ 48published service TextField 49{ 50 service com::sun::star::text::TextContent; 51 52 53 /** This interface is used to access the textual representation of 54 this field. 55 */ 56 interface com::sun::star::text::XTextField; 57 58 /** makes it possible to access the properties of the field, if any. 59 */ 60 [optional] interface com::sun::star::beans::XPropertySet; 61 62 //------------------------------------------------------------------------- 63 64 /** specifies if the text field is actually used in the document. 65 66 <p>Not all available text fields are used, for example fields 67 that are part of unused styles.</p> 68 69 @since OpenOffice 2.0.1 70 */ 71 [optional, property, readonly] boolean IsFieldUsed; 72 73 //------------------------------------------------------------------------- 74 75 /** specifies if the text field is actually displayed. 76 77 <p>Not all available text fields are actually displayed 78 even when they are used. For example hidden fields or fields 79 in hidden text are used in the document but get not displayed.</p> 80 81 @since OpenOffice 2.0.1 82 */ 83 [optional, property, readonly] boolean IsFieldDisplayed; 84 85 //------------------------------------------------------------------------- 86 87}; 88 89 90//============================================================================= 91 92}; }; }; }; 93 94#endif 95