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