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