LibreOffice
LibreOffice 24.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 
156 
160 
171  [property, maybevoid] string HeaderBackGraphicURL;
172 
175  [property, maybevoid] string HeaderBackGraphicFilter;
176 
180 
183  [property, maybevoid] long HeaderLeftMargin;
184 
187  [property, maybevoid] long HeaderRightMargin;
188 
194  [property, maybevoid] boolean HeaderBackTransparent;
195 
199 
203 
207 
211 
214  [property, maybevoid] long HeaderLeftBorderDistance;
215 
218  [property, maybevoid] long HeaderRightBorderDistance;
219 
222  [property, maybevoid] long HeaderTopBorderDistance;
223 
226  [property, maybevoid] long HeaderBottomBorderDistance;
227 
231 
234  [property, maybevoid] long HeaderBodyDistance;
235 
238  [property, maybevoid] boolean HeaderIsShared;
239 
244  [optional, property, maybevoid] boolean FirstIsShared;
245 
248  [property, maybevoid] long HeaderHeight;
249 
252  [property, maybevoid] boolean HeaderIsDynamicHeight;
253 
256  [property] boolean HeaderIsOn;
257 
260  [optional, property, maybevoid] com::sun::star::text::XText HeaderText;
261 
264  [optional, property, maybevoid] com::sun::star::text::XText HeaderTextLeft;
265 
268  [optional, property, maybevoid] com::sun::star::text::XText HeaderTextRight;
269 
273 
284  [property, maybevoid] string FooterBackGraphicURL;
285 
288  [property, maybevoid] string FooterBackGraphicFilter;
289 
293 
296  [property, maybevoid] long FooterLeftMargin;
297 
300  [property, maybevoid] long FooterRightMargin;
301 
304  [property, maybevoid] boolean FooterBackTransparent;
305 
309 
313 
317 
321 
324  [property, maybevoid] long FooterLeftBorderDistance;
325 
328  [property, maybevoid] long FooterRightBorderDistance;
329 
332  [property, maybevoid] long FooterTopBorderDistance;
333 
336  [property, maybevoid] long FooterBottomBorderDistance;
337 
341 
344  [property, maybevoid] long FooterBodyDistance;
345 
348  [property, maybevoid] boolean FooterIsDynamicHeight;
349 
352  [property, maybevoid] boolean FooterIsShared;
353 
356  [property, maybevoid] long FooterHeight;
357 
360  [property] boolean FooterIsOn;
361 
364  [optional, property, maybevoid] com::sun::star::text::XText FooterText;
365 
368  [optional, property, maybevoid] com::sun::star::text::XText FooterTextLeft;
369 
372  [optional, property, maybevoid] com::sun::star::text::XText FooterTextRight;
373 
377  [optional,property] long FootnoteHeight;
378 
381  [optional,property] short FootnoteLineWeight;
382 
388  [optional,property] short FootnoteLineStyle;
389 
393 
396  [optional,property] byte FootnoteLineRelativeWidth;
397 
401  [optional,property] short FootnoteLineAdjust;
402 
406  [optional,property] long FootnoteLineTextDistance;
407 
411  [optional,property] long FootnoteLineDistance;
412 
415  [optional,property] short WritingMode;
416 
420  [optional, property] short GridMode;
421 
424 
426  [optional, property] short GridLines;
427 
429  [optional, property] long GridBaseHeight;
430 
432  [optional, property] long GridRubyHeight;
433 
436  [optional, property] boolean GridRubyBelow;
437 
439  [optional, property] boolean GridPrint;
440 
442  [optional, property] boolean GridDisplay;
443 
445  [optional, property, maybevoid] boolean HeaderDynamicSpacing;
446 
448  [optional, property, maybevoid] boolean FooterDynamicSpacing;
449 
451  [property] long BorderDistance;
452 
454  [property, maybevoid] long FooterBorderDistance;
455 
457  [property, maybevoid] long HeaderBorderDistance;
458 
464 
469  [optional, property, maybevoid] com::sun::star::graphic::XGraphic HeaderBackGraphic;
470 
475  [optional, property, maybevoid] com::sun::star::graphic::XGraphic FooterBackGraphic;
476 
481  [optional, property] long GutterMargin;
482 
488  [optional, property] boolean BackgroundFullSize;
489 
494  [optional, property] boolean RtlGutter;
495 
496 };
497 
498 }; }; }; };
499 
500 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::table::ShadowFormat FooterShadowFormat
determines the shadow of the footer.
Definition: PageProperties.idl:340
boolean HeaderDynamicSpacing
determines whether to use dynamic spacing in header or not.
Definition: PageProperties.idl:445
long FootnoteLineDistance
contains the distance between the footnote area and the separator line between the text and the footn...
Definition: PageProperties.idl:411
string HeaderBackGraphicFilter
contains the filter name of the background graphic of the header.
Definition: PageProperties.idl:175
com::sun::star::table::BorderLine FooterBottomBorder
contains the style of the bottom border line of the footer.
Definition: PageProperties.idl:320
string FooterBackGraphicFilter
contains the filter name of the background graphic in the footer.
Definition: PageProperties.idl:288
long FootnoteHeight
contains the maximum height of the footnote area.
Definition: PageProperties.idl:377
com::sun::star::container::XNameContainer UserDefinedAttributes
contains user defined attributes.
Definition: PageProperties.idl:155
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:244
short WritingMode
contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants ...
Definition: PageProperties.idl:415
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:234
com::sun::star::style::GraphicLocation FooterBackGraphicLocation
determines the location of the background graphic in the footer.
Definition: PageProperties.idl:292
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:159
com::sun::star::text::XText HeaderText
contains the interface to the text of the header.
Definition: PageProperties.idl:260
com::sun::star::table::BorderLine FooterRightBorder
contains the style of the right border line of the footer.
Definition: PageProperties.idl:312
long FooterBorderDistance
contains the distance of all borders of the footer.
Definition: PageProperties.idl:454
com::sun::star::text::XText FooterTextLeft
contains the interface to the text of the footer of a left page.
Definition: PageProperties.idl:368
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:475
long GutterMargin
determines the gutter margin of the page.
Definition: PageProperties.idl:481
long HeaderBorderDistance
determines the distance of all borders of the header.
Definition: PageProperties.idl:457
boolean HeaderIsOn
determines if a header is used on the page.
Definition: PageProperties.idl:256
long HeaderRightBorderDistance
determines the right border distance of the header.
Definition: PageProperties.idl:218
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:328
long HeaderLeftMargin
contains the left margin of the header.
Definition: PageProperties.idl:183
com::sun::star::table::BorderLine FooterTopBorder
contains the style of the top border line of the footer.
Definition: PageProperties.idl:316
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:296
com::sun::star::util::Color GridColor
contains the display color of the text grid
Definition: PageProperties.idl:423
boolean GridDisplay
determines whether the text grid lines are visible or not
Definition: PageProperties.idl:442
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:388
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:348
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:194
byte FootnoteLineRelativeWidth
contains the relative width of the separator line between the text and the footnote area...
Definition: PageProperties.idl:396
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:381
boolean FooterDynamicSpacing
determines whether to use dynamic spacing in footer or not.
Definition: PageProperties.idl:448
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:336
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:202
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:214
string FooterBackGraphicURL
contains the URL of the background graphic in the footer.
Definition: PageProperties.idl:284
com::sun::star::style::GraphicLocation HeaderBackGraphicLocation
determines the location of the background graphic of the header.
Definition: PageProperties.idl:179
long HeaderTopBorderDistance
determines the top border distance of the header.
Definition: PageProperties.idl:222
long HeaderBottomBorderDistance
determines the bottom border distance of the header.
Definition: PageProperties.idl:226
boolean GridPrint
determines whether the text grid lines are printed
Definition: PageProperties.idl:439
boolean GridRubyBelow
determines whether the text grid's ruby line is located below or above the base line ...
Definition: PageProperties.idl:436
boolean RtlGutter
specifies that the page gutter shall be placed on the right side of the page.
Definition: PageProperties.idl:494
com::sun::star::table::BorderLine HeaderTopBorder
determines the style of the top border line of the header.
Definition: PageProperties.idl:206
short GridLines
contains the number of lines in the text grid
Definition: PageProperties.idl:426
describes the style of pages.
Definition: PageProperties.idl:24
long HeaderHeight
contains the height of the header.
Definition: PageProperties.idl:248
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:230
com::sun::star::text::XText HeaderTextRight
contains the interface to the text of the header of right pages.
Definition: PageProperties.idl:268
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:392
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic of the background.
Definition: PageProperties.idl:463
short GridMode
contains the mode of the text grid (none, lines, ...), as represented by com::sun::star::text::TextGr...
Definition: PageProperties.idl:420
boolean FooterIsOn
determines if a footer is used on the page.
Definition: PageProperties.idl:360
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:451
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:308
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:401
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:432
com::sun::star::text::XText HeaderTextLeft
contains the interface to the text of the header of left pages.
Definition: PageProperties.idl:264
boolean FooterIsShared
determines if the footer content on left and right pages is the same.
Definition: PageProperties.idl:352
long FooterRightMargin
determines the right margin of the footer.
Definition: PageProperties.idl:300
long FooterHeight
determines the height of the footer.
Definition: PageProperties.idl:356
long FooterLeftBorderDistance
contains the left border distance of the footer.
Definition: PageProperties.idl:324
boolean HeaderIsDynamicHeight
determines if the height of the header depends on the content.
Definition: PageProperties.idl:252
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:187
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:406
boolean HeaderIsShared
determines if the header content on left and right pages is the same.
Definition: PageProperties.idl:238
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:372
com::sun::star::table::BorderLine HeaderLeftBorder
determines the style of the left border line of the header.
Definition: PageProperties.idl:198
long FooterBodyDistance
determines the distance between the footer and the body text area.
Definition: PageProperties.idl:344
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:332
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:429
com::sun::star::graphic::XGraphic HeaderBackGraphic
contains the graphic of the background of the header.
Definition: PageProperties.idl:469
boolean BackgroundFullSize
does the background cover the full page or only inside the margins?
Definition: PageProperties.idl:488
com::sun::star::text::XText FooterText
contains the interface to the text of the footer.
Definition: PageProperties.idl:364
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:272
com::sun::star::table::BorderLine HeaderBottomBorder
determines the style of the bottom border line of the header.
Definition: PageProperties.idl:210
manages columns within the object.
Definition: XTextColumns.idl:34
boolean FooterBackTransparent
determines if the background of the footer is transparent.
Definition: PageProperties.idl:304
string HeaderBackGraphicURL
contains the URL of the background graphic of the header.
Definition: PageProperties.idl:171