offapi/com/sun/star/text/XFootnotesSupplier.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_XFootnotesSupplier_idl__
  28 #define __com_sun_star_text_XFootnotesSupplier_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_XPropertySet_idl__
  39 #include <com/sun/star/beans/XPropertySet.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45  module com {  module sun {  module star {  module text {
  46
  47 //=============================================================================
  48
  49 // DocMerge from xml: interface com::sun::star::text::XFootnotesSupplier
  50 /** makes it possible to access the footnotes within
  51     the context (e.g. document).
  52  */
  53 published interface XFootnotesSupplier: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     // DocMerge from xml: method com::sun::star::text::XFootnotesSupplier::getFootnotes
  58     /** returns a collection of footnotes.
  59      */
  60     com::sun::star::container::XIndexAccess getFootnotes();
  61
  62     //-------------------------------------------------------------------------
  63
  64     // DocMerge from idl: method com::sun::star::text::XFootnotesSupplier::getFootnoteSettings
  65     /** @returns
  66                 the footnotes settings of the document.
  67      */
  68     com::sun::star::beans::XPropertySet getFootnoteSettings();
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif