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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module text {
  23
  24
  25 /** A TextField is a TextContent which fades its
  26     textual representation into the text range to which it is anchored.
  27  */
  28 published service TextField
  29 {
  30     service com::sun::star::text::TextContent;
  31
  32
  33     /** This interface is used to access the textual representation of
  34         this field.
  35      */
  36     interface com::sun::star::text::XTextField;
  37
  38     /** makes it possible to access the properties of the field, if any.
  39     */
  40     [optional] interface com::sun::star::beans::XPropertySet;
  41
  42
  43     /** specifies if the text field is actually used in the document.
  44
  45         <p>Not all available text fields are used, for example fields
  46         that are part of unused styles.</p>
  47
  48         @since  OOo 2.0.1
  49      */
  50     [optional, property, readonly] boolean IsFieldUsed;
  51
  52
  53     /** specifies if the text field is actually displayed.
  54
  55         <p>Not all available text fields are actually displayed
  56         even when they are used. For example hidden fields or fields
  57         in hidden text are used in the document but get not displayed.</p>
  58
  59         @since  OOo 2.0.1
  60      */
  61     [optional, property, readonly] boolean IsFieldDisplayed;
  62
  63     /** Contains short title for the field, used to for tooltip purposes if it's non-empty.
  64
  65         @since LibreOffice 7.4
  66     */
  67     [optional, property] string Title;
  68
  69
  70 };
  71
  72
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */