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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_Footnote_idl__
  28 #define __com_sun_star_text_Footnote_idl__
  29
  30 #ifndef __com_sun_star_text_XFootnote_idl__
  31 #include <com/sun/star/text/XFootnote.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_text_XText_idl__
  35 #include <com/sun/star/text/XText.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module text {
  42
  43 //=============================================================================
  44 /** This service specifies a footnote or an endnote in a
  45     <type>TextDocument</type>.
  46 */
  47 published service Footnote
  48 {
  49
  50     /** provides access to the footnote label, which is the
  51         anchor text range.
  52
  53     */
  54     interface com::sun::star::text::XFootnote;
  55
  56     /** provides access to the text of the footnote (or
  57         endnote).
  58
  59     */
  60     interface com::sun::star::text::XText;
  61     /** contains an internal identifier for the use as SequenceNumber property in reference fields.
  62      @see com.sun.star.text.textfield.GetReference.
  63      */
  64     [optional, readonly, property]short ReferenceId;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif