summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/TextPageStyle.idl
blob: d93a4bba641fb8ea4361551f5110447abd29a8a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_text_TextPageStyle_idl__
#define __com_sun_star_text_TextPageStyle_idl__

#include <com/sun/star/util/Color.idl>
#include <com/sun/star/table/ShadowFormat.idl>
#include <com/sun/star/table/BorderLine.idl>
#include <com/sun/star/style/PageStyleLayout.idl>
#include <com/sun/star/style/GraphicLocation.idl>
#include <com/sun/star/awt/Size.idl>
#include <com/sun/star/text/XText.idl>
#include <com/sun/star/text/XTextColumns.idl>
#include <com/sun/star/container/XNameContainer.idl>


module com {  module sun {  module star {  module text {


/** represents a page style for a text document.

    <p>This service extends the service
    <type scope="com::sun::star::style">PageStyle</type> with specific
    properties for text documents.</p>
 */
published service TextPageStyle
{

    /** determines whether the register mode is active on that page.
      */
    [property] boolean RegisterModeActive;


    /** contains the name of the paragraph style that is used as
        reference of the register mode.
      */
    [property] string RegisterParagraphStyle;


    /** contains the column settings of the page.
      */
    [property] com::sun::star::text::XTextColumns TextColumns;


    /** contains the interface to the text of the header.

        @see com::sun::star::text::Text
      */
    [property] com::sun::star::text::XText HeaderText;


    /** contains the interface to the text of the header of left pages.

        @see com::sun::star::text::Text
      */
    [property] com::sun::star::text::XText HeaderTextLeft;


    /** contains the interface to the text of the header of right pages.

        @see com::sun::star::text::Text
      */
    [property] com::sun::star::text::XText HeaderTextRight;


    /** contains the interface to the text of the header of first pages.

        @see com::sun::star::text::Text

        @since LibreOffice 4.0
      */
    [optional, property] com::sun::star::text::XText HeaderTextFirst;


    /** contains the interface to the text of the footer.

        @see com::sun::star::text::Text
      */
    [property] com::sun::star::text::XText FooterText;


    /** contains the interface to the text of the footer of a left page.

        @see com::sun::star::text::Text
      */
    [property] com::sun::star::text::XText FooterTextLeft;


    /** contains the interface to the text of the footer of a right page.

        @see com::sun::star::text::Text
      */
    [property] com::sun::star::text::XText FooterTextRight;


    /** contains the interface to the text of the footer of a first page.

        @see com::sun::star::text::Text

        @since LibreOffice 4.0
      */
    [optional, property] com::sun::star::text::XText FooterTextFirst;


    /** contains the maximum height of the footnote area (in 1/100 mm).

        <p>If set to zero, the height of the current page is used as limit.</p>
     */
    [property] long FootnoteHeight;


    /** contains the weight of the separator line between the text and
        the footnote area (in 1/100 mm).
      */
    [property] short FootnoteLineWeight;


    /** contains the color of the separator line between the text and
        the footnote area.
      */
    [property] com::sun::star::util::Color FootnoteLineColor;


    /** contains the relative width of the separator line between the
        text and the footnote area (in percent).
      */
    [property] byte FootnoteLineRelativeWidth;


    /** contains the adjustment of the separator line between the text
        and the footnote area.

        @see com::sun::star::text::HorizontalAdjust
      */
    [property] short FootnoteLineAdjust;


    /** contains the distance between the text and the separator line
        between the text and the footnote area (in 1/100 mm).
      */
    [property] long FootnoteLineTextDistance;


    /** contains the distance between the footnote area and the separator
        line between the text and the footnote area (in 1/100 mm).
     */
    [property] long FootnoteLineDistance;

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */