LibreOffice
LibreOffice 24.2 SDK API Reference
TextPageStyle.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 
21 module com { module sun { module star { module text {
22 
23 
30 published service TextPageStyle
31 {
32 
35  [property] boolean RegisterModeActive;
36 
37 
41  [property] string RegisterParagraphStyle;
42 
43 
47 
48 
54 
55 
61 
62 
68 
69 
77 
78 
84 
85 
91 
92 
98 
99 
107 
108 
113  [property] long FootnoteHeight;
114 
115 
119  [property] short FootnoteLineWeight;
120 
121 
126 
127 
131  [property] byte FootnoteLineRelativeWidth;
132 
133 
139  [property] short FootnoteLineAdjust;
140 
141 
145  [property] long FootnoteLineTextDistance;
146 
147 
151  [property] long FootnoteLineDistance;
152 
153 };
154 
155 
156 }; }; }; };
157 
158 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::text::XTextColumns TextColumns
contains the column settings of the page.
Definition: TextPageStyle.idl:46
com::sun::star::text::XText FooterTextLeft
contains the interface to the text of the footer of a left page.
Definition: TextPageStyle.idl:90
long FootnoteLineTextDistance
contains the distance between the text and the separator line between the text and the footnote area ...
Definition: TextPageStyle.idl:145
boolean RegisterModeActive
determines whether the register mode is active on that page.
Definition: TextPageStyle.idl:35
Definition: Ambiguous.idl:20
extends a XSimpleText by the capability of inserting XTextContents.
Definition: XText.idl:28
long FootnoteHeight
contains the maximum height of the footnote area (in 1/100 mm).
Definition: TextPageStyle.idl:113
com::sun::star::text::XText FooterText
contains the interface to the text of the footer.
Definition: TextPageStyle.idl:83
com::sun::star::util::Color FootnoteLineColor
contains the color of the separator line between the text and the footnote area.
Definition: TextPageStyle.idl:125
com::sun::star::text::XText HeaderTextFirst
contains the interface to the text of the header of first pages.
Definition: TextPageStyle.idl:76
byte FootnoteLineRelativeWidth
contains the relative width of the separator line between the text and the footnote area (in percent)...
Definition: TextPageStyle.idl:131
short FootnoteLineAdjust
contains the adjustment of the separator line between the text and the footnote area.
Definition: TextPageStyle.idl:139
com::sun::star::text::XText FooterTextFirst
contains the interface to the text of the footer of a first page.
Definition: TextPageStyle.idl:106
com::sun::star::text::XText HeaderTextRight
contains the interface to the text of the header of right pages.
Definition: TextPageStyle.idl:67
com::sun::star::text::XText HeaderTextLeft
contains the interface to the text of the header of left pages.
Definition: TextPageStyle.idl:60
long FootnoteLineDistance
contains the distance between the footnote area and the separator line between the text and the footn...
Definition: TextPageStyle.idl:151
com::sun::star::text::XText FooterTextRight
contains the interface to the text of the footer of a right page.
Definition: TextPageStyle.idl:97
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:34
represents a page style for a text document.
Definition: TextPageStyle.idl:30
string RegisterParagraphStyle
contains the name of the paragraph style that is used as reference of the register mode...
Definition: TextPageStyle.idl:41
manages columns within the object.
Definition: XTextColumns.idl:34
com::sun::star::text::XText HeaderText
contains the interface to the text of the header.
Definition: TextPageStyle.idl:53
short FootnoteLineWeight
contains the weight of the separator line between the text and the footnote area (in 1/100 mm)...
Definition: TextPageStyle.idl:119