LibreOffice
LibreOffice 6.0 SDK API Reference
PageProperties.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 #ifndef __com_sun_star_style_PageProperties_idl__
20 #define __com_sun_star_style_PageProperties_idl__
21 
32 
33 
34  module com { module sun { module star { module style {
35 
36 
39 published service PageProperties
40 {
46 //[property] BackGraphic;
49 [property] string BackGraphicURL;
52 [property] string BackGraphicFilter;
61 [property] boolean BackTransparent;
64 [property] long LeftMargin;
67 [property] long RightMargin;
70 [property] long TopMargin;
73 [property] long BottomMargin;
88 [property] long LeftBorderDistance;
91 [property] long RightBorderDistance;
94 [property] long TopBorderDistance;
97 [property] long BottomBorderDistance;
103 [property] boolean IsLandscape;
106 [property] short NumberingType;
112 [property] string PrinterPaperTray;
115 [optional, property] boolean RegisterModeActive;
118 [optional, property] string RegisterParagraphStyle;
124 [property] long Width;
127 [property] long Height;
138 
144 //[property, maybevoid] HeaderBackGraphic;
147 [property, maybevoid] string HeaderBackGraphicURL;
150 [property, maybevoid] string HeaderBackGraphicFilter;
156 [property, maybevoid] long HeaderLeftMargin;
159 [property, maybevoid] long HeaderRightMargin;
165 [property, maybevoid] boolean HeaderBackTransparent;
178 
181 [property, maybevoid] long HeaderLeftBorderDistance;
184 [property, maybevoid] long HeaderRightBorderDistance;
187 [property, maybevoid] long HeaderTopBorderDistance;
190 [property, maybevoid] long HeaderBottomBorderDistance;
196 [property, maybevoid] long HeaderBodyDistance;
199 [property, maybevoid] boolean HeaderIsShared;
204 [optional, property, maybevoid] boolean FirstIsShared;
207 [property, maybevoid] long HeaderHeight;
210 [property, maybevoid] boolean HeaderIsDynamicHeight;
213 [property] boolean HeaderIsOn;
214 
217 [optional, property, maybevoid] com::sun::star::text::XText HeaderText;
220 [optional, property, maybevoid] com::sun::star::text::XText HeaderTextLeft;
223 [optional, property, maybevoid] com::sun::star::text::XText HeaderTextRight;
224 
230 [property, maybevoid] string FooterBackGraphicURL;
233 [property, maybevoid] string FooterBackGraphicFilter;
239 [property, maybevoid] long FooterLeftMargin;
242 [property, maybevoid] long FooterRightMargin;
245 [property, maybevoid] boolean FooterBackTransparent;
260 [property, maybevoid] long FooterLeftBorderDistance;
263 [property, maybevoid] long FooterRightBorderDistance;
266 [property, maybevoid] long FooterTopBorderDistance;
269 [property, maybevoid] long FooterBottomBorderDistance;
275 [property, maybevoid] long FooterBodyDistance;
278 [property, maybevoid] boolean FooterIsDynamicHeight;
281 [property, maybevoid] boolean FooterIsShared;
284 [property, maybevoid] long FooterHeight;
287 [property] boolean FooterIsOn;
290 [optional, property, maybevoid] com::sun::star::text::XText FooterText;
293 [optional, property, maybevoid] com::sun::star::text::XText FooterTextLeft;
296 [optional, property, maybevoid] com::sun::star::text::XText FooterTextRight;
300 [optional,property] long FootnoteHeight;
303 [optional,property] short FootnoteLineWeight;
309 [optional,property] short FootnoteLineStyle;
315 [optional,property] byte FootnoteLineRelativeWidth;
319 [optional,property] short FootnoteLineAdjust;
323 [optional,property] long FootnoteLineTextDistance;
327 [optional,property] long FootnoteLineDistance;
330 [optional,property] short WritingMode;
334 [optional, property] short GridMode;
338 [optional, property] short GridLines;
340 [optional, property] long GridBaseHeight;
342 [optional, property] long GridRubyHeight;
345 [optional, property] boolean GridRubyBelow;
347 [optional, property] boolean GridPrint;
349 [optional, property] boolean GridDisplay;
351 [optional, property, maybevoid] boolean HeaderDynamicSpacing;
353 [optional, property, maybevoid] boolean FooterDynamicSpacing;
355 [property] long BorderDistance;
357 [property, maybevoid] long FooterBorderDistance;
359 [property, maybevoid] long HeaderBorderDistance;
360 
361 };
362 
363 }; }; }; };
364 
365 #endif
366 
367 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::style::PageProperties::BorderDistance
long BorderDistance
determines the distance of all borders of the page.
Definition: PageProperties.idl:355
com::sun::star::style::PageProperties::FooterBottomBorder
com::sun::star::table::BorderLine FooterBottomBorder
contains the style of the bottom border line of the footer.
Definition: PageProperties.idl:257
com::sun::star::style::PageProperties::HeaderRightMargin
long HeaderRightMargin
contains the right margin of the header.
Definition: PageProperties.idl:159
com::sun::star::style::PageProperties::HeaderBottomBorderDistance
long HeaderBottomBorderDistance
determines the bottom border distance of the header.
Definition: PageProperties.idl:190
Color.idl
com::sun::star::style::PageProperties::GridColor
com::sun::star::util::Color GridColor
contains the display color of the text grid
Definition: PageProperties.idl:336
com::sun::star::style::PageProperties::RightBorderDistance
long RightBorderDistance
determines the right border distance of the page.
Definition: PageProperties.idl:91
com::sun::star::style::PageProperties::HeaderHeight
long HeaderHeight
contains the height of the header.
Definition: PageProperties.idl:207
com::sun::star::style::PageProperties::FooterBackGraphicFilter
string FooterBackGraphicFilter
contains the filter name of the background graphic in the footer.
Definition: PageProperties.idl:233
com::sun::star::style::PageProperties::TextColumns
com::sun::star::text::XTextColumns TextColumns
contains the column settings of the page.
Definition: PageProperties.idl:130
com::sun::star::style::GraphicLocation
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:29
com::sun::star::style::PageProperties::GridRubyHeight
long GridRubyHeight
contains the height of the ruby text line inside the text grid
Definition: PageProperties.idl:342
com::sun::star::style::PageProperties::ShadowFormat
com::sun::star::table::ShadowFormat ShadowFormat
determines the shadow of the page.
Definition: PageProperties.idl:100
com::sun::star::style::PageProperties::FooterText
com::sun::star::text::XText FooterText
contains the interface to the text of the footer.
Definition: PageProperties.idl:290
com::sun::star::style::PageStyleLayout
PageStyleLayout
specifies the pages for which a page layout is valid.
Definition: PageStyleLayout.idl:29
com::sun::star::style::PageProperties::GridMode
short GridMode
contains the mode of the text grid (none, lines, ...), as represented by com::sun::star::text::TextGr...
Definition: PageProperties.idl:334
com::sun::star::style::PageProperties::FooterRightBorderDistance
long FooterRightBorderDistance
contains the right border distance of the footer.
Definition: PageProperties.idl:263
com::sun::star::style::PageProperties::FootnoteLineRelativeWidth
byte FootnoteLineRelativeWidth
contains the relative width of the separator line between the text and the footnote area.
Definition: PageProperties.idl:315
com::sun::star::style::PageProperties::TopBorder
com::sun::star::table::BorderLine TopBorder
determines the style of the top border line of the page.
Definition: PageProperties.idl:82
com::sun::star::style::PageProperties::FooterLeftBorder
com::sun::star::table::BorderLine FooterLeftBorder
contains the style of the left border line of the footer.
Definition: PageProperties.idl:248
com::sun::star::style::PageProperties::HeaderRightBorderDistance
long HeaderRightBorderDistance
determines the right border distance of the header.
Definition: PageProperties.idl:184
com::sun::star::style::PageProperties::HeaderBackGraphicURL
string HeaderBackGraphicURL
contains the URL of the background graphic of the header.
Definition: PageProperties.idl:147
com::sun::star::text::XText
extends a XSimpleText by the capability of inserting XTextContents.
Definition: XText.idl:40
com::sun::star::text::XTextColumns
manages columns within the object.
Definition: XTextColumns.idl:40
com::sun::star::style::PageProperties::HeaderBorderDistance
long HeaderBorderDistance
determines the distance of all borders of the header.
Definition: PageProperties.idl:359
com::sun::star::style::PageProperties::GridPrint
boolean GridPrint
determines whether the text grid lines are printed
Definition: PageProperties.idl:347
com::sun::star::style::PageProperties::Height
long Height
contains the height of the page.
Definition: PageProperties.idl:127
com::sun::star::style::PageProperties::BottomBorderDistance
long BottomBorderDistance
determines the bottom border distance of the page.
Definition: PageProperties.idl:97
com::sun::star::style::PageProperties::FooterTopBorder
com::sun::star::table::BorderLine FooterTopBorder
contains the style of the top border line of the footer.
Definition: PageProperties.idl:254
com::sun::star::style::PageProperties::HeaderLeftBorder
com::sun::star::table::BorderLine HeaderLeftBorder
determines the style of the left border line of the header.
Definition: PageProperties.idl:168
com::sun::star::style::PageProperties::UserDefinedAttributes
com::sun::star::container::XNameContainer UserDefinedAttributes
contains user defined attributes.
Definition: PageProperties.idl:137
com::sun::star::style::PageProperties::FooterIsDynamicHeight
boolean FooterIsDynamicHeight
determines if the height of the footer depends on the content.
Definition: PageProperties.idl:278
com::sun::star::table::ShadowFormat
describes the settings of a cell shadow.
Definition: ShadowFormat.idl:32
com::sun::star::style::PageProperties::BackGraphicLocation
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the location of the background graphic.
Definition: PageProperties.idl:55
com::sun::star::style::PageProperties::BackGraphicURL
string BackGraphicURL
contains the URL of the background graphic.
Definition: PageProperties.idl:49
com::sun::star::container::XNameContainer
This is the generic interface for supporting the insertion and removal of named elements.
Definition: XNameContainer.idl:40
com::sun::star::style::PageProperties::BackGraphicFilter
string BackGraphicFilter
contains the filter name of the background graphic.
Definition: PageProperties.idl:52
GraphicLocation.idl
com::sun::star::style::PageProperties::HeaderLeftBorderDistance
long HeaderLeftBorderDistance
determines the left border distance of the header.
Definition: PageProperties.idl:181
ShadowFormat.idl
XText.idl
PageStyleLayout.idl
XTextColumns.idl
com::sun::star::style::PageProperties::RightBorder
com::sun::star::table::BorderLine RightBorder
determines the style of the right border line of the page.
Definition: PageProperties.idl:79
com::sun::star::style::PageProperties::BackColor
com::sun::star::util::Color BackColor
contains the background color of the page.
Definition: PageProperties.idl:43
com::sun::star::style::PageProperties::HeaderTopBorderDistance
long HeaderTopBorderDistance
determines the top border distance of the header.
Definition: PageProperties.idl:187
com::sun::star::style::PageProperties::HeaderBottomBorder
com::sun::star::table::BorderLine HeaderBottomBorder
determines the style of the bottom border line of the header.
Definition: PageProperties.idl:177
com::sun::star::style::PageProperties::FootnoteLineDistance
long FootnoteLineDistance
contains the distance between the footnote area and the separator line between the text and the footn...
Definition: PageProperties.idl:327
Size.idl
com::sun::star::table::BorderLine
describes the line type for a single cell edge.
Definition: BorderLine.idl:31
com::sun::star::style::PageProperties::LeftBorder
com::sun::star::table::BorderLine LeftBorder
determines the style of the left border line of the page.
Definition: PageProperties.idl:76
XNameContainer.idl
com::sun::star::style::PageProperties::GridLines
short GridLines
contains the number of lines in the text grid
Definition: PageProperties.idl:338
com::sun::star::style::PageProperties::HeaderIsShared
boolean HeaderIsShared
determines if the header content on left and right pages is the same.
Definition: PageProperties.idl:199
com::sun::star::style::PageProperties::FootnoteLineWeight
short FootnoteLineWeight
contains the weight of the separator line between the text and the footnote area.
Definition: PageProperties.idl:303
com::sun::star::style::PageProperties::FooterTextRight
com::sun::star::text::XText FooterTextRight
contains the interface to the text of the footer of a right page.
Definition: PageProperties.idl:296
com::sun::star::style::PageProperties::LeftBorderDistance
long LeftBorderDistance
determines the left border distance of the page.
Definition: PageProperties.idl:88
com::sun::star::style::PageProperties::HeaderTopBorder
com::sun::star::table::BorderLine HeaderTopBorder
determines the style of the top border line of the header.
Definition: PageProperties.idl:174
com::sun::star::style::PageProperties::FootnoteLineColor
com::sun::star::util::Color FootnoteLineColor
contains the color of the separator line between the text and the footnote area.
Definition: PageProperties.idl:312
com::sun::star::style::PageProperties::FirstIsShared
boolean FirstIsShared
determines if the header/footer content on the first page and remaining pages is the same.
Definition: PageProperties.idl:204
com::sun::star::style::PageProperties::FooterRightMargin
long FooterRightMargin
determines the right margin of the footer.
Definition: PageProperties.idl:242
com::sun::star::style::PageProperties::FootnoteHeight
long FootnoteHeight
contains the maximum height of the footnote area.
Definition: PageProperties.idl:300
com::sun::star::style::PageProperties::RegisterModeActive
boolean RegisterModeActive
determines if the register mode is active on that page.
Definition: PageProperties.idl:115
com::sun::star::style::PageProperties::HeaderBackTransparent
boolean HeaderBackTransparent
determines if the background color of the header is transparent.
Definition: PageProperties.idl:165
com::sun::star::style::PageProperties
describes the style of pages.
Definition: PageProperties.idl:39
com::sun::star::style::PageProperties::HeaderIsDynamicHeight
boolean HeaderIsDynamicHeight
determines if the height of the header depends on the content.
Definition: PageProperties.idl:210
com::sun::star::style::PageProperties::FooterHeight
long FooterHeight
determines the height of the footer.
Definition: PageProperties.idl:284
com::sun::star::style::PageProperties::FooterLeftBorderDistance
long FooterLeftBorderDistance
contains the left border distance of the footer.
Definition: PageProperties.idl:260
com::sun::star::style::PageProperties::FooterShadowFormat
com::sun::star::table::ShadowFormat FooterShadowFormat
determines the shadow of the footer.
Definition: PageProperties.idl:272
com::sun::star::style::PageProperties::FooterIsOn
boolean FooterIsOn
determines if a footer is used on the page.
Definition: PageProperties.idl:287
com::sun::star::awt::Size
specifies the 2-dimensional size of an area using width and height.
Definition: Size.idl:29
com::sun::star::style::PageProperties::FooterBackTransparent
boolean FooterBackTransparent
determines if the background of the footer is transparent.
Definition: PageProperties.idl:245
com::sun::star::style::PageProperties::BackTransparent
boolean BackTransparent
determines if the background color is transparent.
Definition: PageProperties.idl:61
com::sun::star::style::PageProperties::HeaderBackGraphicFilter
string HeaderBackGraphicFilter
contains the filter name of the background graphic of the header.
Definition: PageProperties.idl:150
com::sun::star::style::PageProperties::HeaderBodyDistance
long HeaderBodyDistance
determines the distance between the header and the body text area.
Definition: PageProperties.idl:196
BorderLine.idl
com::sun::star::style::PageProperties::HeaderText
com::sun::star::text::XText HeaderText
contains the interface to the text of the header.
Definition: PageProperties.idl:217
com::sun::star::style::PageProperties::FooterBackGraphicURL
string FooterBackGraphicURL
contains the URL of the background graphic in the footer.
Definition: PageProperties.idl:230
com::sun::star::style::PageProperties::FootnoteLineTextDistance
long FootnoteLineTextDistance
contains the distance between the text and the separator line between the text and the footnote area.
Definition: PageProperties.idl:323
com::sun::star::style::PageProperties::PrinterPaperTray
string PrinterPaperTray
contains the name of a paper tray of the selected printer.
Definition: PageProperties.idl:112
com::sun::star::style::PageProperties::IsLandscape
boolean IsLandscape
determines if the page format is landscape.
Definition: PageProperties.idl:103
com::sun::star::style::PageProperties::RightMargin
long RightMargin
determines the right margin of the page.
Definition: PageProperties.idl:67
com::sun::star::style::PageProperties::WritingMode
short WritingMode
contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants
Definition: PageProperties.idl:330
com::sun::star::style::PageProperties::TopMargin
long TopMargin
determines the top margin of the page.
Definition: PageProperties.idl:70
com::sun::star::style::PageProperties::FooterRightBorder
com::sun::star::table::BorderLine FooterRightBorder
contains the style of the right border line of the footer.
Definition: PageProperties.idl:251
com::sun::star::style::PageProperties::FooterBackGraphicLocation
com::sun::star::style::GraphicLocation FooterBackGraphicLocation
determines the location of the background graphic in the footer.
Definition: PageProperties.idl:236
com::sun::star::style::PageProperties::FooterBackColor
com::sun::star::util::Color FooterBackColor
contains the color of the background of the footer.
Definition: PageProperties.idl:227
com::sun::star::style::PageProperties::HeaderTextRight
com::sun::star::text::XText HeaderTextRight
contains the interface to the text of the header of right pages.
Definition: PageProperties.idl:223
WritingMode2.idl
com::sun::star::style::PageProperties::NumberingType
short NumberingType
determines the default numbering type for this page.
Definition: PageProperties.idl:106
com::sun::star::style::PageProperties::LeftMargin
long LeftMargin
determines the left margin of the page.
Definition: PageProperties.idl:64
com::sun::star::style::PageProperties::FooterIsShared
boolean FooterIsShared
determines if the footer content on left and right pages is the same.
Definition: PageProperties.idl:281
com::sun::star::style::PageProperties::FooterTextLeft
com::sun::star::text::XText FooterTextLeft
contains the interface to the text of the footer of a left page.
Definition: PageProperties.idl:293
com::sun::star::style::PageProperties::BottomBorder
com::sun::star::table::BorderLine BottomBorder
determines the style of the bottom border line of the page.
Definition: PageProperties.idl:85
com
Definition: Ambiguous.idl:22
com::sun::star::style::PageProperties::HeaderLeftMargin
long HeaderLeftMargin
contains the left margin of the header.
Definition: PageProperties.idl:156
com::sun::star::style::PageProperties::HeaderDynamicSpacing
boolean HeaderDynamicSpacing
determines whether to use dynamic spacing in header or not.
Definition: PageProperties.idl:351
com::sun::star::style::PageProperties::FootnoteLineStyle
short FootnoteLineStyle
contains the style of the separator line between the text and the footnote area.
Definition: PageProperties.idl:309
com::sun::star::style::PageProperties::FooterLeftMargin
long FooterLeftMargin
determines the left margin of the footer.
Definition: PageProperties.idl:239
com::sun::star::style::PageProperties::HeaderRightBorder
com::sun::star::table::BorderLine HeaderRightBorder
determines the style of the right border line of the header.
Definition: PageProperties.idl:171
com::sun::star::style::PageProperties::FooterBottomBorderDistance
long FooterBottomBorderDistance
contains the bottom border distance of the footer.
Definition: PageProperties.idl:269
com::sun::star::style::PageProperties::GridDisplay
boolean GridDisplay
determines whether the text grid lines are visible or not
Definition: PageProperties.idl:349
com::sun::star::style::PageProperties::PageStyleLayout
com::sun::star::style::PageStyleLayout PageStyleLayout
determines the layout of the page.
Definition: PageProperties.idl:109
com::sun::star::style::PageProperties::HeaderBackGraphicLocation
com::sun::star::style::GraphicLocation HeaderBackGraphicLocation
determines the location of the background graphic of the header.
Definition: PageProperties.idl:153
com::sun::star::style::PageProperties::BottomMargin
long BottomMargin
determines the bottom margin of the page.
Definition: PageProperties.idl:73
com::sun::star::style::PageProperties::Width
long Width
contains the width of the page.
Definition: PageProperties.idl:124
com::sun::star::style::PageProperties::FooterBodyDistance
long FooterBodyDistance
determines the distance between the footer and the body text area.
Definition: PageProperties.idl:275
com::sun::star::style::PageProperties::FootnoteLineAdjust
short FootnoteLineAdjust
contains the adjustment of the separator line between the text and the footnote area.
Definition: PageProperties.idl:319
com::sun::star::style::PageProperties::Size
com::sun::star::awt::Size Size
contains the paper size of the page.
Definition: PageProperties.idl:121
com::sun::star::style::PageProperties::FooterTopBorderDistance
long FooterTopBorderDistance
contains the top border distance of the footer.
Definition: PageProperties.idl:266
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
com::sun::star::style::PageProperties::HeaderShadowFormat
com::sun::star::table::ShadowFormat HeaderShadowFormat
determines the shadow of the header.
Definition: PageProperties.idl:193
com::sun::star::style::PageProperties::HeaderBackColor
com::sun::star::util::Color HeaderBackColor
contains the color of the background of the header.
Definition: PageProperties.idl:141
com::sun::star::style::PageProperties::GridBaseHeight
long GridBaseHeight
contains the height of the base text line inside the text grid
Definition: PageProperties.idl:340
com::sun::star::style::PageProperties::HeaderTextLeft
com::sun::star::text::XText HeaderTextLeft
contains the interface to the text of the header of left pages.
Definition: PageProperties.idl:220
com::sun::star::style::PageProperties::RegisterParagraphStyle
string RegisterParagraphStyle
contains the name of the paragraph style that is used as reference of the register mode.
Definition: PageProperties.idl:118
com::sun::star::style::PageProperties::GridRubyBelow
boolean GridRubyBelow
determines whether the text grid's ruby line is located below or above the base line
Definition: PageProperties.idl:345
com::sun::star::style::PageProperties::HeaderIsOn
boolean HeaderIsOn
determines if a header is used on the page.
Definition: PageProperties.idl:213
com::sun::star::style::PageProperties::TopBorderDistance
long TopBorderDistance
determines the top border distance of the page.
Definition: PageProperties.idl:94
com::sun::star::style::PageProperties::FooterDynamicSpacing
boolean FooterDynamicSpacing
determines whether to use dynamic spacing in footer or not.
Definition: PageProperties.idl:353
com::sun::star::style::PageProperties::FooterBorderDistance
long FooterBorderDistance
contains the distance of all borders of the footer.
Definition: PageProperties.idl:357