offapi/com/sun/star/text/textfield/GetReference.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 module com { module sun { module star { module text { module textfield {
  22
  23 /** specifies service of a reference field.
  24     @see com::sun::star::text::TextField
  25 */
  26 published service GetReference
  27 {
  28     service  com::sun::star::text::TextField;
  29
  30     /** contains the current content of the text field.
  31         <p> This property is especially useful for import/export purposes. </p>
  32      */
  33     [property] string CurrentPresentation;
  34     /** contains the source of the reference.
  35         @see com::sun::star::text::ReferenceFieldSource
  36      */
  37     [property] short ReferenceFieldSource;
  38     /** contains the name of the source.
  39      <p> Depending on the property ReferenceFieldSource it may be the name of
  40      a bookmark, a reference mark.</p>
  41      */
  42     [property] string SourceName;
  43     /** contains the type of the reference.
  44         @see com::sun::star::text::ReferenceFieldPart
  45      */
  46     [property] short ReferenceFieldPart;
  47     /** contains the sequence number of a set expression field that is used as sequence field
  48          or the value of the ReferenceId property of a footnote or endnote.
  49         @see com::sun::star::text::Footnote
  50      */
  51     [property] short SequenceNumber;
  52     /** contains the language id of the alternative language-dependent references.
  53         <p> Alternative language-dependent forms of reference types. </p>
  54
  55         @since LibreOffice 6.1
  56
  57         <p> The current set of supported languages is:
  58         <ul>
  59             <li>hu : Hungarian, reference with lowercase article "a" or "az"</li>
  60             <li>Hu : Hungarian, reference with uppercase article "A" or "Az"</li>
  61         </ul>
  62         </p>
  63      */
  64     [optional, property] string ReferenceFieldLanguage;
  65     /** contains extra flags which can modify the behaviour of the field
  66         @since LibreOffice 24.2
  67      */
  68     [optional, property] short ReferenceFieldFlags;
  69 };
  70
  71
  72 }; }; }; }; };
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */