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 #ifndef __com_sun_star_text_textfield_GetReference_idl__
  21 #define __com_sun_star_text_textfield_GetReference_idl__
  22
  23 #include <com/sun/star/text/TextField.idl>
  24
  25
  26 module com { module sun { module star { module text { module textfield {
  27
  28 /** specifies service of a reference field.
  29     @see com::sun::star::text::TextField
  30 */
  31 published service GetReference
  32 {
  33     service  com::sun::star::text::TextField;
  34
  35     /** contains the current content of the text field.
  36         <p> This property is especially useful for import/export purposes. </p>
  37      */
  38     [property] string CurrentPresentation;
  39     /** contains the source of the reference.
  40         @see com::sun::star::text::ReferenceFieldSource
  41      */
  42     [property] short ReferenceFieldSource;
  43     /** contains the name of the source.
  44      <p> Depending on the property ReferenceFieldSource it may be the name of
  45      a bookmark, a reference mark.</p>
  46      */
  47     [property] string SourceName;
  48     /** contains the type of the reference.
  49         @see com::sun::star::text::ReferenceFieldPart
  50      */
  51     [property] short ReferenceFieldPart;
  52     /** contains the sequence number of a set expression field that is used as sequence field
  53          or the value of the ReferenceId property of a footnote or endnote.
  54         @see com::sun::star::text::Footnote
  55      */
  56     [property] short SequenceNumber;
  57 };
  58
  59
  60 }; }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */