offapi/com/sun/star/text/Footnote.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 #ifndef __com_sun_star_text_Footnote_idl__
  20 #define __com_sun_star_text_Footnote_idl__
  21
  22 #include <com/sun/star/text/XFootnote.idl>
  23 #include <com/sun/star/text/XText.idl>
  24
  25
  26
  27 module com { module sun { module star { module text {
  28
  29 /** This service specifies a footnote or an endnote in a
  30     <type>TextDocument</type>.
  31 */
  32 published service Footnote
  33 {
  34
  35     /** provides access to the footnote label, which is the
  36         anchor text range.
  37
  38     */
  39     interface com::sun::star::text::XFootnote;
  40
  41     /** provides access to the text of the footnote (or
  42         endnote).
  43
  44     */
  45     interface com::sun::star::text::XText;
  46     /** contains an internal identifier for the use as SequenceNumber property in reference fields.
  47      @see com.sun.star.text.textfield.GetReference.
  48      */
  49     [optional, readonly, property]short ReferenceId;
  50 };
  51
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */