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

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