offapi/com/sun/star/text/PageFootnoteInfo.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: PageFootnoteInfo.idl,v $
  10  * $Revision: 1.9 $
  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_PageFootnoteInfo_idl__
  31 #define __com_sun_star_text_PageFootnoteInfo_idl__
  32
  33 #ifndef __com_sun_star_text_HorizontalAdjust_idl__
  34 #include <com/sun/star/text/HorizontalAdjust.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module text {
  41
  42 //=============================================================================
  43
  44 // DocMerge from xml: service com::sun::star::text::PageFootnoteInfo
  45 /** specifies the properties of the footnote area of a page or a
  46     page style.
  47  */
  48 published service PageFootnoteInfo
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     // DocMerge from xml: property com::sun::star::text::PageFootnoteInfo::FootnoteHeight
  53     /** contains the maximum height of the footnote section.
  54
  55
  56
  57         <p>If 0, the maximum is the height of the page.</p>
  58      */
  59     [property] long FootnoteHeight;
  60
  61     //-------------------------------------------------------------------------
  62
  63     // DocMerge from xml: property com::sun::star::text::PageFootnoteInfo::FootnoteSeparatorLineWidth
  64     /** contains the relative width of the footnote separator line.
  65      */
  66     [property] long FootnoteSeparatorLineWidth;
  67
  68     //-------------------------------------------------------------------------
  69
  70     // DocMerge from xml: property com::sun::star::text::PageFootnoteInfo::FootnoteTopDistance
  71     /** contains the distance between the text and footnote section.
  72      */
  73     [property] long FootnoteTopDistance;
  74
  75     //-------------------------------------------------------------------------
  76
  77     // DocMerge from xml: property com::sun::star::text::PageFootnoteInfo::FootnoteBottomDistance
  78     /** contains the distance between the separator line and the footnote section.
  79      */
  80     [property] long FootnoteBottomDistance;
  81
  82     //-------------------------------------------------------------------------
  83
  84     // DocMerge from xml: property com::sun::star::text::PageFootnoteInfo::FootnoteSeparatorLineWidthPercent
  85     /** contains the relative width of the footnote separator line.
  86      */
  87     [property] short FootnoteSeparatorLineWidthPercent;
  88
  89     //-------------------------------------------------------------------------
  90
  91     // DocMerge from xml: property com::sun::star::text::PageFootnoteInfo::FootnoteSeparatorLineAdjust
  92     /** contains the adjustment of the footnote separator line.
  93      */
  94     [property] com::sun::star::text::HorizontalAdjust FootnoteSeparatorLineAdjust;
  95
  96     //-------------------------------------------------------------------------
  97
  98     // DocMerge from xml: property com::sun::star::text::PageFootnoteInfo::FootnoteSeparatorLinePenWidth
  99     /** contains the width of the pen for the footnote separator line.
 100      */
 101     [property] short FootnoteSeparatorLinePenWidth;
 102
 103 };
 104
 105 //=============================================================================
 106
 107 }; }; }; };
 108
 109 #endif