LibreOffice
LibreOffice 7.4 SDK API Reference
Loading...
Searching...
No Matches
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
33
34module com { module sun { module star { module style {
35
38published service PageProperties
39{
43
54 [property] string BackGraphicURL;
55
58 [property] string BackGraphicFilter;
59
63
69 [property] boolean BackTransparent;
70
73 [property] long LeftMargin;
74
77 [property] long RightMargin;
78
81 [property] long TopMargin;
82
85 [property] long BottomMargin;
86
90
94
98
102
105 [property] long LeftBorderDistance;
106
109 [property] long RightBorderDistance;
110
113 [property] long TopBorderDistance;
114
117 [property] long BottomBorderDistance;
118
122
125 [property] boolean IsLandscape;
126
129 [property] short NumberingType;
130
134
137 [property] string PrinterPaperTray;
138
141 [optional, property] boolean RegisterModeActive;
142
145 [optional, property] string RegisterParagraphStyle;
146
150
153 [property] long Width;
154
157 [property] long Height;
158
162
170
174
185 [property, maybevoid] string HeaderBackGraphicURL;
186
189 [property, maybevoid] string HeaderBackGraphicFilter;
190
194
197 [property, maybevoid] long HeaderLeftMargin;
198
201 [property, maybevoid] long HeaderRightMargin;
202
208 [property, maybevoid] boolean HeaderBackTransparent;
209
213
217
221
225
228 [property, maybevoid] long HeaderLeftBorderDistance;
229
232 [property, maybevoid] long HeaderRightBorderDistance;
233
236 [property, maybevoid] long HeaderTopBorderDistance;
237
240 [property, maybevoid] long HeaderBottomBorderDistance;
241
245
248 [property, maybevoid] long HeaderBodyDistance;
249
252 [property, maybevoid] boolean HeaderIsShared;
253
258 [optional, property, maybevoid] boolean FirstIsShared;
259
262 [property, maybevoid] long HeaderHeight;
263
266 [property, maybevoid] boolean HeaderIsDynamicHeight;
267
270 [property] boolean HeaderIsOn;
271
274 [optional, property, maybevoid] com::sun::star::text::XText HeaderText;
275
278 [optional, property, maybevoid] com::sun::star::text::XText HeaderTextLeft;
279
282 [optional, property, maybevoid] com::sun::star::text::XText HeaderTextRight;
283
287
298 [property, maybevoid] string FooterBackGraphicURL;
299
302 [property, maybevoid] string FooterBackGraphicFilter;
303
307
310 [property, maybevoid] long FooterLeftMargin;
311
314 [property, maybevoid] long FooterRightMargin;
315
318 [property, maybevoid] boolean FooterBackTransparent;
319
323
327
331
335
338 [property, maybevoid] long FooterLeftBorderDistance;
339
342 [property, maybevoid] long FooterRightBorderDistance;
343
346 [property, maybevoid] long FooterTopBorderDistance;
347
350 [property, maybevoid] long FooterBottomBorderDistance;
351
355
358 [property, maybevoid] long FooterBodyDistance;
359
362 [property, maybevoid] boolean FooterIsDynamicHeight;
363
366 [property, maybevoid] boolean FooterIsShared;
367
370 [property, maybevoid] long FooterHeight;
371
374 [property] boolean FooterIsOn;
375
378 [optional, property, maybevoid] com::sun::star::text::XText FooterText;
379
382 [optional, property, maybevoid] com::sun::star::text::XText FooterTextLeft;
383
386 [optional, property, maybevoid] com::sun::star::text::XText FooterTextRight;
387
391 [optional,property] long FootnoteHeight;
392
395 [optional,property] short FootnoteLineWeight;
396
402 [optional,property] short FootnoteLineStyle;
403
407
410 [optional,property] byte FootnoteLineRelativeWidth;
411
415 [optional,property] short FootnoteLineAdjust;
416
420 [optional,property] long FootnoteLineTextDistance;
421
425 [optional,property] long FootnoteLineDistance;
426
429 [optional,property] short WritingMode;
430
434 [optional, property] short GridMode;
435
438
440 [optional, property] short GridLines;
441
443 [optional, property] long GridBaseHeight;
444
446 [optional, property] long GridRubyHeight;
447
450 [optional, property] boolean GridRubyBelow;
451
453 [optional, property] boolean GridPrint;
454
456 [optional, property] boolean GridDisplay;
457
459 [optional, property, maybevoid] boolean HeaderDynamicSpacing;
460
462 [optional, property, maybevoid] boolean FooterDynamicSpacing;
463
465 [property] long BorderDistance;
466
468 [property, maybevoid] long FooterBorderDistance;
469
471 [property, maybevoid] long HeaderBorderDistance;
472
478
484
490
495 [optional, property] long GutterMargin;
496
502 [optional, property] boolean BackgroundFullSize;
503
508 [optional, property] boolean RtlGutter;
509
510};
511
512}; }; }; };
513
514#endif
515
516/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This is the generic interface for supporting the insertion and removal of named elements.
Definition XNameContainer.idl:41
This interface acts as a container for the loaded graphic.
Definition XGraphic.idl:44
manages columns within the object.
Definition XTextColumns.idl:41
extends a XSimpleText by the capability of inserting XTextContents.
Definition XText.idl:41
PageStyleLayout
specifies the pages for which a page layout is valid.
Definition PageStyleLayout.idl:30
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition GraphicLocation.idl:30
long Color
describes an RGB color value with an optional alpha channel.
Definition Color.idl:36
Definition Ambiguous.idl:22
describes the style of pages.
Definition PageProperties.idl:39
short WritingMode
contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants
Definition PageProperties.idl:429
string FooterBackGraphicFilter
contains the filter name of the background graphic in the footer.
Definition PageProperties.idl:302
com::sun::star::table::ShadowFormat FooterShadowFormat
determines the shadow of the footer.
Definition PageProperties.idl:354
com::sun::star::table::BorderLine HeaderRightBorder
determines the style of the right border line of the header.
Definition PageProperties.idl:216
boolean HeaderIsOn
determines if a header is used on the page.
Definition PageProperties.idl:270
long HeaderRightBorderDistance
determines the right border distance of the header.
Definition PageProperties.idl:232
com::sun::star::table::BorderLine FooterRightBorder
contains the style of the right border line of the footer.
Definition PageProperties.idl:326
com::sun::star::awt::Size Size
contains the paper size of the page.
Definition PageProperties.idl:149
long RightMargin
determines the right margin of the page.
Definition PageProperties.idl:77
com::sun::star::table::BorderLine TopBorder
determines the style of the top border line of the page.
Definition PageProperties.idl:97
com::sun::star::table::BorderLine FooterBottomBorder
contains the style of the bottom border line of the footer.
Definition PageProperties.idl:334
long Width
contains the width of the page.
Definition PageProperties.idl:153
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the location of the background graphic.
Definition PageProperties.idl:62
long TopBorderDistance
determines the top border distance of the page.
Definition PageProperties.idl:113
com::sun::star::text::XText HeaderText
contains the interface to the text of the header.
Definition PageProperties.idl:274
boolean RegisterModeActive
determines if the register mode is active on that page.
Definition PageProperties.idl:141
boolean HeaderIsShared
determines if the header content on left and right pages is the same.
Definition PageProperties.idl:252
com::sun::star::text::XText HeaderTextRight
contains the interface to the text of the header of right pages.
Definition PageProperties.idl:282
long HeaderBorderDistance
determines the distance of all borders of the header.
Definition PageProperties.idl:471
boolean FooterBackTransparent
determines if the background of the footer is transparent.
Definition PageProperties.idl:318
com::sun::star::util::Color GridColor
contains the display color of the text grid
Definition PageProperties.idl:437
boolean FooterDynamicSpacing
determines whether to use dynamic spacing in footer or not.
Definition PageProperties.idl:462
boolean FooterIsDynamicHeight
determines if the height of the footer depends on the content.
Definition PageProperties.idl:362
short GridMode
contains the mode of the text grid (none, lines, ...), as represented by com::sun::star::text::TextGr...
Definition PageProperties.idl:434
long FooterLeftBorderDistance
contains the left border distance of the footer.
Definition PageProperties.idl:338
boolean IsLandscape
determines if the page format is landscape.
Definition PageProperties.idl:125
long FootnoteLineDistance
contains the distance between the footnote area and the separator line between the text and the footn...
Definition PageProperties.idl:425
long FooterLeftMargin
determines the left margin of the footer.
Definition PageProperties.idl:310
com::sun::star::table::ShadowFormat ShadowFormat
determines the shadow of the page.
Definition PageProperties.idl:121
com::sun::star::style::GraphicLocation FooterBackGraphicLocation
determines the location of the background graphic in the footer.
Definition PageProperties.idl:306
com::sun::star::util::Color FooterBackColor
contains the color of the background of the footer.
Definition PageProperties.idl:286
com::sun::star::table::BorderLine RightBorder
determines the style of the right border line of the page.
Definition PageProperties.idl:93
boolean GridDisplay
determines whether the text grid lines are visible or not
Definition PageProperties.idl:456
com::sun::star::util::Color BackColor
contains the background color of the page.
Definition PageProperties.idl:42
long HeaderTopBorderDistance
determines the top border distance of the header.
Definition PageProperties.idl:236
com::sun::star::table::ShadowFormat HeaderShadowFormat
determines the shadow of the header.
Definition PageProperties.idl:244
boolean FooterIsOn
determines if a footer is used on the page.
Definition PageProperties.idl:374
com::sun::star::text::XText FooterTextRight
contains the interface to the text of the footer of a right page.
Definition PageProperties.idl:386
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic of the background.
Definition PageProperties.idl:477
com::sun::star::graphic::XGraphic HeaderBackGraphic
contains the graphic of the background of the header.
Definition PageProperties.idl:483
string BackGraphicURL
contains the URL of the background graphic.
Definition PageProperties.idl:54
long TopMargin
determines the top margin of the page.
Definition PageProperties.idl:81
boolean HeaderBackTransparent
determines if the background color of the header is transparent.
Definition PageProperties.idl:208
com::sun::star::container::XNameContainer UserDefinedAttributes
contains user defined attributes.
Definition PageProperties.idl:169
boolean FirstIsShared
determines if the header/footer content on the first page and remaining pages is the same.
Definition PageProperties.idl:258
string RegisterParagraphStyle
contains the name of the paragraph style that is used as reference of the register mode.
Definition PageProperties.idl:145
boolean GridPrint
determines whether the text grid lines are printed
Definition PageProperties.idl:453
com::sun::star::table::BorderLine BottomBorder
determines the style of the bottom border line of the page.
Definition PageProperties.idl:101
long BottomMargin
determines the bottom margin of the page.
Definition PageProperties.idl:85
long FooterHeight
determines the height of the footer.
Definition PageProperties.idl:370
short GridLines
contains the number of lines in the text grid
Definition PageProperties.idl:440
long FooterBodyDistance
determines the distance between the footer and the body text area.
Definition PageProperties.idl:358
short FootnoteLineStyle
contains the style of the separator line between the text and the footnote area.
Definition PageProperties.idl:402
string HeaderBackGraphicURL
contains the URL of the background graphic of the header.
Definition PageProperties.idl:185
string HeaderBackGraphicFilter
contains the filter name of the background graphic of the header.
Definition PageProperties.idl:189
long HeaderBodyDistance
determines the distance between the header and the body text area.
Definition PageProperties.idl:248
long GridRubyHeight
contains the height of the ruby text line inside the text grid
Definition PageProperties.idl:446
string PrinterPaperTray
contains the name of a paper tray of the selected printer.
Definition PageProperties.idl:137
long FooterTopBorderDistance
contains the top border distance of the footer.
Definition PageProperties.idl:346
com::sun::star::text::XText FooterText
contains the interface to the text of the footer.
Definition PageProperties.idl:378
boolean HeaderIsDynamicHeight
determines if the height of the header depends on the content.
Definition PageProperties.idl:266
long FooterBottomBorderDistance
contains the bottom border distance of the footer.
Definition PageProperties.idl:350
string FooterBackGraphicURL
contains the URL of the background graphic in the footer.
Definition PageProperties.idl:298
long BorderDistance
determines the distance of all borders of the page.
Definition PageProperties.idl:465
long FooterRightMargin
determines the right margin of the footer.
Definition PageProperties.idl:314
short FootnoteLineWeight
contains the weight of the separator line between the text and the footnote area.
Definition PageProperties.idl:395
long LeftBorderDistance
determines the left border distance of the page.
Definition PageProperties.idl:105
com::sun::star::table::BorderLine FooterLeftBorder
contains the style of the left border line of the footer.
Definition PageProperties.idl:322
long FootnoteLineTextDistance
contains the distance between the text and the separator line between the text and the footnote area.
Definition PageProperties.idl:420
boolean RtlGutter
specifies that the page gutter shall be placed on the right side of the page.
Definition PageProperties.idl:508
boolean HeaderDynamicSpacing
determines whether to use dynamic spacing in header or not.
Definition PageProperties.idl:459
com::sun::star::util::Color HeaderBackColor
contains the color of the background of the header.
Definition PageProperties.idl:173
long GridBaseHeight
contains the height of the base text line inside the text grid
Definition PageProperties.idl:443
boolean FooterIsShared
determines if the footer content on left and right pages is the same.
Definition PageProperties.idl:366
long LeftMargin
determines the left margin of the page.
Definition PageProperties.idl:73
short FootnoteLineAdjust
contains the adjustment of the separator line between the text and the footnote area.
Definition PageProperties.idl:415
long HeaderRightMargin
contains the right margin of the header.
Definition PageProperties.idl:201
long GutterMargin
determines the gutter margin of the page.
Definition PageProperties.idl:495
com::sun::star::util::Color FootnoteLineColor
contains the color of the separator line between the text and the footnote area.
Definition PageProperties.idl:406
com::sun::star::table::BorderLine HeaderLeftBorder
determines the style of the left border line of the header.
Definition PageProperties.idl:212
com::sun::star::text::XTextColumns TextColumns
contains the column settings of the page.
Definition PageProperties.idl:161
long FooterBorderDistance
contains the distance of all borders of the footer.
Definition PageProperties.idl:468
com::sun::star::text::XText FooterTextLeft
contains the interface to the text of the footer of a left page.
Definition PageProperties.idl:382
long FootnoteHeight
contains the maximum height of the footnote area.
Definition PageProperties.idl:391
boolean GridRubyBelow
determines whether the text grid's ruby line is located below or above the base line
Definition PageProperties.idl:450
long HeaderHeight
contains the height of the header.
Definition PageProperties.idl:262
com::sun::star::table::BorderLine FooterTopBorder
contains the style of the top border line of the footer.
Definition PageProperties.idl:330
long FooterRightBorderDistance
contains the right border distance of the footer.
Definition PageProperties.idl:342
com::sun::star::table::BorderLine HeaderTopBorder
determines the style of the top border line of the header.
Definition PageProperties.idl:220
string BackGraphicFilter
contains the filter name of the background graphic.
Definition PageProperties.idl:58
long HeaderBottomBorderDistance
determines the bottom border distance of the header.
Definition PageProperties.idl:240
long HeaderLeftMargin
contains the left margin of the header.
Definition PageProperties.idl:197
com::sun::star::graphic::XGraphic FooterBackGraphic
contains the graphic of the background of the footer.
Definition PageProperties.idl:489
short NumberingType
determines the default numbering type for this page.
Definition PageProperties.idl:129
boolean BackgroundFullSize
does the background cover the full page or only inside the margins?
Definition PageProperties.idl:502
long Height
contains the height of the page.
Definition PageProperties.idl:157
boolean BackTransparent
determines if the background color is transparent.
Definition PageProperties.idl:69
com::sun::star::table::BorderLine HeaderBottomBorder
determines the style of the bottom border line of the header.
Definition PageProperties.idl:224
com::sun::star::text::XText HeaderTextLeft
contains the interface to the text of the header of left pages.
Definition PageProperties.idl:278
long HeaderLeftBorderDistance
determines the left border distance of the header.
Definition PageProperties.idl:228
com::sun::star::style::PageStyleLayout PageStyleLayout
determines the layout of the page.
Definition PageProperties.idl:133
long RightBorderDistance
determines the right border distance of the page.
Definition PageProperties.idl:109
com::sun::star::style::GraphicLocation HeaderBackGraphicLocation
determines the location of the background graphic of the header.
Definition PageProperties.idl:193
com::sun::star::table::BorderLine LeftBorder
determines the style of the left border line of the page.
Definition PageProperties.idl:89
long BottomBorderDistance
determines the bottom border distance of the page.
Definition PageProperties.idl:117
byte FootnoteLineRelativeWidth
contains the relative width of the separator line between the text and the footnote area.
Definition PageProperties.idl:410
specifies the 2-dimensional size of an area using width and height.
Definition Size.idl:30
describes the line type for a single cell edge.
Definition BorderLine.idl:32
describes the settings of a cell shadow.
Definition ShadowFormat.idl:33