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