LibreOffice
LibreOffice 25.2 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 
20 module com { module sun { module star { module style {
21 
24 published service PageProperties
25 {
29 
40  [property] string BackGraphicURL;
41 
44  [property] string BackGraphicFilter;
45 
49 
55  [property] boolean BackTransparent;
56 
59  [property] long LeftMargin;
60 
63  [property] long RightMargin;
64 
67  [property] long TopMargin;
68 
71  [property] long BottomMargin;
72 
76 
80 
84 
88 
91  [property] long LeftBorderDistance;
92 
95  [property] long RightBorderDistance;
96 
99  [property] long TopBorderDistance;
100 
103  [property] long BottomBorderDistance;
104 
108 
111  [property] boolean IsLandscape;
112 
115  [property] short NumberingType;
116 
120 
123  [property] string PrinterPaperTray;
124 
127  [optional, property] boolean RegisterModeActive;
128 
131  [optional, property] string RegisterParagraphStyle;
132 
136 
139  [property] long Width;
140 
143  [property] long Height;
144 
148 
154 
158 
169  [property, maybevoid] string HeaderBackGraphicURL;
170 
173  [property, maybevoid] string HeaderBackGraphicFilter;
174 
178 
181  [property, maybevoid] long HeaderLeftMargin;
182 
185  [property, maybevoid] long HeaderRightMargin;
186 
192  [property, maybevoid] boolean HeaderBackTransparent;
193 
197 
201 
205 
209 
212  [property, maybevoid] long HeaderLeftBorderDistance;
213 
216  [property, maybevoid] long HeaderRightBorderDistance;
217 
220  [property, maybevoid] long HeaderTopBorderDistance;
221 
224  [property, maybevoid] long HeaderBottomBorderDistance;
225 
229 
232  [property, maybevoid] long HeaderBodyDistance;
233 
236  [property, maybevoid] boolean HeaderIsShared;
237 
242  [optional, property, maybevoid] boolean FirstIsShared;
243 
246  [property, maybevoid] long HeaderHeight;
247 
250  [property, maybevoid] boolean HeaderIsDynamicHeight;
251 
254  [property] boolean HeaderIsOn;
255 
258  [optional, property, maybevoid] com::sun::star::text::XText HeaderText;
259 
262  [optional, property, maybevoid] com::sun::star::text::XText HeaderTextLeft;
263 
266  [optional, property, maybevoid] com::sun::star::text::XText HeaderTextRight;
267 
271 
282  [property, maybevoid] string FooterBackGraphicURL;
283 
286  [property, maybevoid] string FooterBackGraphicFilter;
287 
291 
294  [property, maybevoid] long FooterLeftMargin;
295 
298  [property, maybevoid] long FooterRightMargin;
299 
302  [property, maybevoid] boolean FooterBackTransparent;
303 
307 
311 
315 
319 
322  [property, maybevoid] long FooterLeftBorderDistance;
323 
326  [property, maybevoid] long FooterRightBorderDistance;
327 
330  [property, maybevoid] long FooterTopBorderDistance;
331 
334  [property, maybevoid] long FooterBottomBorderDistance;
335 
339 
342  [property, maybevoid] long FooterBodyDistance;
343 
346  [property, maybevoid] boolean FooterIsDynamicHeight;
347 
350  [property, maybevoid] boolean FooterIsShared;
351 
354  [property, maybevoid] long FooterHeight;
355 
358  [property] boolean FooterIsOn;
359 
362  [optional, property, maybevoid] com::sun::star::text::XText FooterText;
363 
366  [optional, property, maybevoid] com::sun::star::text::XText FooterTextLeft;
367 
370  [optional, property, maybevoid] com::sun::star::text::XText FooterTextRight;
371 
375  [optional,property] long FootnoteHeight;
376 
379  [optional,property] short FootnoteLineWeight;
380 
386  [optional,property] short FootnoteLineStyle;
387 
391 
394  [optional,property] byte FootnoteLineRelativeWidth;
395 
399  [optional,property] short FootnoteLineAdjust;
400 
404  [optional,property] long FootnoteLineTextDistance;
405 
409  [optional,property] long FootnoteLineDistance;
410 
413  [optional,property] short WritingMode;
414 
418  [optional, property] short GridMode;
419 
422 
424  [optional, property] short GridLines;
425 
427  [optional, property] long GridBaseHeight;
428 
430  [optional, property] long GridRubyHeight;
431 
434  [optional, property] boolean GridRubyBelow;
435 
437  [optional, property] boolean GridPrint;
438 
440  [optional, property] boolean GridDisplay;
441 
443  [optional, property, maybevoid] boolean HeaderDynamicSpacing;
444 
446  [optional, property, maybevoid] boolean FooterDynamicSpacing;
447 
449  [property] long BorderDistance;
450 
452  [property, maybevoid] long FooterBorderDistance;
453 
455  [property, maybevoid] long HeaderBorderDistance;
456 
462 
467  [optional, property, maybevoid] com::sun::star::graphic::XGraphic HeaderBackGraphic;
468 
473  [optional, property, maybevoid] com::sun::star::graphic::XGraphic FooterBackGraphic;
474 
479  [optional, property] long GutterMargin;
480 
486  [optional, property] boolean BackgroundFullSize;
487 
492  [optional, property] boolean RtlGutter;
493 
494 };
495 
496 }; }; }; };
497 
498 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::table::ShadowFormat FooterShadowFormat
determines the shadow of the footer.
Definition: PageProperties.idl:338
boolean HeaderDynamicSpacing
determines whether to use dynamic spacing in header or not.
Definition: PageProperties.idl:443
long FootnoteLineDistance
contains the distance between the footnote area and the separator line between the text and the footn...
Definition: PageProperties.idl:409
string HeaderBackGraphicFilter
contains the filter name of the background graphic of the header.
Definition: PageProperties.idl:173
com::sun::star::table::BorderLine FooterBottomBorder
contains the style of the bottom border line of the footer.
Definition: PageProperties.idl:318
string FooterBackGraphicFilter
contains the filter name of the background graphic in the footer.
Definition: PageProperties.idl:286
long FootnoteHeight
contains the maximum height of the footnote area.
Definition: PageProperties.idl:375
com::sun::star::container::XNameContainer UserDefinedAttributes
contains user defined attributes.
Definition: PageProperties.idl:153
string PrinterPaperTray
contains the name of a paper tray of the selected printer.
Definition: PageProperties.idl:123
boolean FirstIsShared
determines if the header/footer content on the first page and remaining pages is the same...
Definition: PageProperties.idl:242
short WritingMode
contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants ...
Definition: PageProperties.idl:413
boolean BackTransparent
determines if the background color is transparent.
Definition: PageProperties.idl:55
long LeftMargin
determines the left margin of the page.
Definition: PageProperties.idl:59
long HeaderBodyDistance
determines the distance between the header and the body text area.
Definition: PageProperties.idl:232
com::sun::star::style::GraphicLocation FooterBackGraphicLocation
determines the location of the background graphic in the footer.
Definition: PageProperties.idl:290
com::sun::star::table::BorderLine BottomBorder
determines the style of the bottom border line of the page.
Definition: PageProperties.idl:87
com::sun::star::util::Color HeaderBackColor
contains the color of the background of the header.
Definition: PageProperties.idl:157
com::sun::star::text::XText HeaderText
contains the interface to the text of the header.
Definition: PageProperties.idl:258
com::sun::star::table::BorderLine FooterRightBorder
contains the style of the right border line of the footer.
Definition: PageProperties.idl:310
long FooterBorderDistance
contains the distance of all borders of the footer.
Definition: PageProperties.idl:452
com::sun::star::text::XText FooterTextLeft
contains the interface to the text of the footer of a left page.
Definition: PageProperties.idl:366
com::sun::star::table::ShadowFormat ShadowFormat
determines the shadow of the page.
Definition: PageProperties.idl:107
com::sun::star::graphic::XGraphic FooterBackGraphic
contains the graphic of the background of the footer.
Definition: PageProperties.idl:473
long GutterMargin
determines the gutter margin of the page.
Definition: PageProperties.idl:479
long HeaderBorderDistance
determines the distance of all borders of the header.
Definition: PageProperties.idl:455
boolean HeaderIsOn
determines if a header is used on the page.
Definition: PageProperties.idl:254
long HeaderRightBorderDistance
determines the right border distance of the header.
Definition: PageProperties.idl:216
long TopBorderDistance
determines the top border distance of the page.
Definition: PageProperties.idl:99
long FooterRightBorderDistance
contains the right border distance of the footer.
Definition: PageProperties.idl:326
long HeaderLeftMargin
contains the left margin of the header.
Definition: PageProperties.idl:181
com::sun::star::table::BorderLine FooterTopBorder
contains the style of the top border line of the footer.
Definition: PageProperties.idl:314
Definition: Ambiguous.idl:20
long BottomBorderDistance
determines the bottom border distance of the page.
Definition: PageProperties.idl:103
long FooterLeftMargin
determines the left margin of the footer.
Definition: PageProperties.idl:294
com::sun::star::util::Color GridColor
contains the display color of the text grid
Definition: PageProperties.idl:421
boolean GridDisplay
determines whether the text grid lines are visible or not
Definition: PageProperties.idl:440
com::sun::star::style::PageStyleLayout PageStyleLayout
determines the layout of the page.
Definition: PageProperties.idl:119
short FootnoteLineStyle
contains the style of the separator line between the text and the footnote area.
Definition: PageProperties.idl:386
extends a XSimpleText by the capability of inserting XTextContents.
Definition: XText.idl:28
boolean FooterIsDynamicHeight
determines if the height of the footer depends on the content.
Definition: PageProperties.idl:346
long TopMargin
determines the top margin of the page.
Definition: PageProperties.idl:67
boolean HeaderBackTransparent
determines if the background color of the header is transparent.
Definition: PageProperties.idl:192
byte FootnoteLineRelativeWidth
contains the relative width of the separator line between the text and the footnote area...
Definition: PageProperties.idl:394
short NumberingType
determines the default numbering type for this page.
Definition: PageProperties.idl:115
short FootnoteLineWeight
contains the weight of the separator line between the text and the footnote area. ...
Definition: PageProperties.idl:379
boolean FooterDynamicSpacing
determines whether to use dynamic spacing in footer or not.
Definition: PageProperties.idl:446
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:37
long Width
contains the width of the page.
Definition: PageProperties.idl:139
long FooterBottomBorderDistance
contains the bottom border distance of the footer.
Definition: PageProperties.idl:334
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the location of the background graphic.
Definition: PageProperties.idl:48
long BottomMargin
determines the bottom margin of the page.
Definition: PageProperties.idl:71
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:27
com::sun::star::table::BorderLine HeaderRightBorder
determines the style of the right border line of the header.
Definition: PageProperties.idl:200
com::sun::star::table::BorderLine TopBorder
determines the style of the top border line of the page.
Definition: PageProperties.idl:83
long HeaderLeftBorderDistance
determines the left border distance of the header.
Definition: PageProperties.idl:212
string FooterBackGraphicURL
contains the URL of the background graphic in the footer.
Definition: PageProperties.idl:282
com::sun::star::style::GraphicLocation HeaderBackGraphicLocation
determines the location of the background graphic of the header.
Definition: PageProperties.idl:177
long HeaderTopBorderDistance
determines the top border distance of the header.
Definition: PageProperties.idl:220
long HeaderBottomBorderDistance
determines the bottom border distance of the header.
Definition: PageProperties.idl:224
boolean GridPrint
determines whether the text grid lines are printed
Definition: PageProperties.idl:437
boolean GridRubyBelow
determines whether the text grid's ruby line is located below or above the base line ...
Definition: PageProperties.idl:434
boolean RtlGutter
specifies that the page gutter shall be placed on the right side of the page.
Definition: PageProperties.idl:492
com::sun::star::table::BorderLine HeaderTopBorder
determines the style of the top border line of the header.
Definition: PageProperties.idl:204
short GridLines
contains the number of lines in the text grid
Definition: PageProperties.idl:424
describes the style of pages.
Definition: PageProperties.idl:24
long HeaderHeight
contains the height of the header.
Definition: PageProperties.idl:246
string BackGraphicFilter
contains the filter name of the background graphic.
Definition: PageProperties.idl:44
com::sun::star::table::ShadowFormat HeaderShadowFormat
determines the shadow of the header.
Definition: PageProperties.idl:228
com::sun::star::text::XText HeaderTextRight
contains the interface to the text of the header of right pages.
Definition: PageProperties.idl:266
long Height
contains the height of the page.
Definition: PageProperties.idl:143
com::sun::star::util::Color FootnoteLineColor
contains the color of the separator line between the text and the footnote area.
Definition: PageProperties.idl:390
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic of the background.
Definition: PageProperties.idl:461
short GridMode
contains the mode of the text grid (none, lines, ...), as represented by com::sun::star::text::TextGr...
Definition: PageProperties.idl:418
boolean FooterIsOn
determines if a footer is used on the page.
Definition: PageProperties.idl:358
This is the generic interface for supporting the insertion and removal of named elements.
Definition: XNameContainer.idl:28
describes the settings of a cell shadow.
Definition: ShadowFormat.idl:26
boolean RegisterModeActive
determines if the register mode is active on that page.
Definition: PageProperties.idl:127
long BorderDistance
determines the distance of all borders of the page.
Definition: PageProperties.idl:449
long RightMargin
determines the right margin of the page.
Definition: PageProperties.idl:63
com::sun::star::table::BorderLine FooterLeftBorder
contains the style of the left border line of the footer.
Definition: PageProperties.idl:306
PageStyleLayout
specifies the pages for which a page layout is valid.
Definition: PageStyleLayout.idl:26
short FootnoteLineAdjust
contains the adjustment of the separator line between the text and the footnote area.
Definition: PageProperties.idl:399
boolean IsLandscape
determines if the page format is landscape.
Definition: PageProperties.idl:111
long LeftBorderDistance
determines the left border distance of the page.
Definition: PageProperties.idl:91
com::sun::star::text::XTextColumns TextColumns
contains the column settings of the page.
Definition: PageProperties.idl:147
specifies the 2-dimensional size of an area using width and height.
Definition: Size.idl:27
long GridRubyHeight
contains the height of the ruby text line inside the text grid
Definition: PageProperties.idl:430
com::sun::star::text::XText HeaderTextLeft
contains the interface to the text of the header of left pages.
Definition: PageProperties.idl:262
boolean FooterIsShared
determines if the footer content on left and right pages is the same.
Definition: PageProperties.idl:350
long FooterRightMargin
determines the right margin of the footer.
Definition: PageProperties.idl:298
long FooterHeight
determines the height of the footer.
Definition: PageProperties.idl:354
long FooterLeftBorderDistance
contains the left border distance of the footer.
Definition: PageProperties.idl:322
boolean HeaderIsDynamicHeight
determines if the height of the header depends on the content.
Definition: PageProperties.idl:250
string RegisterParagraphStyle
contains the name of the paragraph style that is used as reference of the register mode...
Definition: PageProperties.idl:131
com::sun::star::table::BorderLine LeftBorder
determines the style of the left border line of the page.
Definition: PageProperties.idl:75
long HeaderRightMargin
contains the right margin of the header.
Definition: PageProperties.idl:185
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:34
long FootnoteLineTextDistance
contains the distance between the text and the separator line between the text and the footnote area...
Definition: PageProperties.idl:404
boolean HeaderIsShared
determines if the header content on left and right pages is the same.
Definition: PageProperties.idl:236
string BackGraphicURL
contains the URL of the background graphic.
Definition: PageProperties.idl:40
describes the line type for a single cell edge.
Definition: BorderLine.idl:26
long RightBorderDistance
determines the right border distance of the page.
Definition: PageProperties.idl:95
com::sun::star::text::XText FooterTextRight
contains the interface to the text of the footer of a right page.
Definition: PageProperties.idl:370
com::sun::star::table::BorderLine HeaderLeftBorder
determines the style of the left border line of the header.
Definition: PageProperties.idl:196
long FooterBodyDistance
determines the distance between the footer and the body text area.
Definition: PageProperties.idl:342
com::sun::star::awt::Size Size
contains the paper size of the page.
Definition: PageProperties.idl:135
long FooterTopBorderDistance
contains the top border distance of the footer.
Definition: PageProperties.idl:330
com::sun::star::util::Color BackColor
contains the background color of the page.
Definition: PageProperties.idl:28
long GridBaseHeight
contains the height of the base text line inside the text grid
Definition: PageProperties.idl:427
com::sun::star::graphic::XGraphic HeaderBackGraphic
contains the graphic of the background of the header.
Definition: PageProperties.idl:467
boolean BackgroundFullSize
does the background cover the full page or only inside the margins?
Definition: PageProperties.idl:486
com::sun::star::text::XText FooterText
contains the interface to the text of the footer.
Definition: PageProperties.idl:362
com::sun::star::table::BorderLine RightBorder
determines the style of the right border line of the page.
Definition: PageProperties.idl:79
com::sun::star::util::Color FooterBackColor
contains the color of the background of the footer.
Definition: PageProperties.idl:270
com::sun::star::table::BorderLine HeaderBottomBorder
determines the style of the bottom border line of the header.
Definition: PageProperties.idl:208
manages columns within the object.
Definition: XTextColumns.idl:34
boolean FooterBackTransparent
determines if the background of the footer is transparent.
Definition: PageProperties.idl:302
string HeaderBackGraphicURL
contains the URL of the background graphic of the header.
Definition: PageProperties.idl:169