LibreOffice LibreOffice 25.8 SDK API Reference

Loading...
Searching...
No Matches
ParagraphProperties.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
20module com { module sun { module star { module style {
21
24published service ParagraphProperties
25{
26
29 [property] com::sun::star::style::ParagraphAdjust ParaAdjust;
30
31
34 [optional, property] com::sun::star::style::LineSpacing ParaLineSpacing;
35
36
39 [optional, property] com::sun::star::util::Color ParaBackColor;
40
41
45 [optional, property] boolean ParaBackTransparent;
46
47
58 [optional, property] string ParaBackGraphicURL;
59
62 [optional, property] string ParaBackGraphicFilter;
63
64
69 [optional, property] com::sun::star::style::GraphicLocation ParaBackGraphicLocation;
70
71
76 [property] short ParaLastLineAdjust;
77
78
84 [optional, property] boolean ParaExpandSingleWord;
85
86
89 [property] long ParaLeftMargin;
90
91
94 [property] long ParaRightMargin;
95
96
106 [property] long ParaTopMargin;
107
108
120 [property] long ParaBottomMargin;
121
129 [optional, property] boolean ParaContextMargin;
130
139 [optional, property] sequence<com::sun::star::beans::PropertyValue> ParaInteropGrabBag;
140
144 [optional, property] boolean ParaLineNumberCount;
145
146
149 [optional, property] long ParaLineNumberStartValue;
150
151
156 [optional, property] string PageDescName;
157
158
161 [optional, property] short PageNumberOffset;
162
163
172 [optional, property] boolean ParaRegisterModeActive;
173
174
178 [optional, property] sequence<com::sun::star::style::TabStop> ParaTabStops;
179
180
183 [optional, property] string ParaStyleName;
184
185
188 [optional, property, maybevoid, readonly] string PageStyleName;
189
190
195 [optional, property] com::sun::star::style::DropCapFormat DropCapFormat;
196
197
201 [optional, property] boolean DropCapWholeWord;
202
203
211 [optional, property] boolean ParaKeepTogether;
212
213
217 [optional, property] boolean ParaSplit;
218
219
222 [optional, property] short NumberingLevel;
223
226 [optional, property] com::sun::star::container::XIndexReplace NumberingRules;
227
228
231 [optional, property] short NumberingStartValue;
232
235 [optional, property] boolean ParaIsNumberingRestart;
236
243 [optional, property] string NumberingStyleName;
244
249 [optional, property] byte ParaOrphans;
250
255 [optional, property] byte ParaWidows;
259 [optional, property] com::sun::star::table::ShadowFormat ParaShadowFormat;
262 [property, optional] com::sun::star::table::BorderLine LeftBorder;
263
266 [property, optional] com::sun::star::table::BorderLine RightBorder;
267
270 [property, optional] com::sun::star::table::BorderLine TopBorder;
271
274 [property, optional] com::sun::star::table::BorderLine BottomBorder;
275
278 [property, optional] long BorderDistance;
279
282 [property, optional] long LeftBorderDistance;
283
286 [property, optional] long RightBorderDistance;
287
290 [property, optional] long TopBorderDistance;
291
294 [property, optional] long BottomBorderDistance;
295
299 [optional, property] com::sun::star::style::BreakType BreakType;
300
303 [optional, property] string DropCapCharStyleName;
304
307 [optional, property] long ParaFirstLineIndent;
308
311 [optional, property] boolean ParaIsAutoFirstLineIndent;
312
315 [property] boolean ParaIsHyphenation;
316
319 [optional, property] short ParaHyphenationMaxHyphens;
320
325 [optional, property] short ParaHyphenationMaxLeadingChars;
326
331 [optional, property] short ParaHyphenationMaxTrailingChars;
332
337 [optional, property] short ParaVertAlignment;
338
344 [optional, property] com::sun::star::container::XNameContainer ParaUserDefinedAttributes;
345
353 [optional, property, maybevoid] boolean NumberingIsNumber;
354
359 [optional, property, maybevoid] boolean ParaIsConnectBorder;
360
364 [optional, property] string ListId;
365
373 [optional, property] short OutlineLevel;
374
379 [optional, property] com::sun::star::graphic::XGraphic ParaBackGraphic;
380
388 [optional, property, readonly] boolean ContinueingPreviousSubTree;
389
394 [optional, property, readonly] string ListLabelString;
395
401 [optional, property] boolean ParaHyphenationNoCaps;
402
408 [optional, property] boolean ParaHyphenationNoLastWord;
409
414 [optional, property] short ParaHyphenationMinWordLength;
415
421 [optional, property] long ParaHyphenationZone;
422
430 [optional, property, readonly] long SortedTextId;
431
439 [optional, property] boolean ParaHyphenationKeep;
440
449 [optional, property] long ParaHyphenationKeepType;
450
456 [optional, property] short ParaHyphenationCompoundMinLeadingChars;
457
468 [optional, property] boolean ParaHyphenationKeepLine;
469
479 [optional, property] long ParaHyphenationZoneAlways;
480
490 [optional, property] long ParaHyphenationZoneColumn;
491
501 [optional, property] long ParaHyphenationZonePage;
502
512 [optional, property] long ParaHyphenationZoneSpread;
513
523 [optional, property] long ParaWordSpacing;
524
534 [optional, property] long ParaWordSpacingMinimum;
535
545 [optional, property] long ParaWordSpacingMaximum;
546};
547
548
549}; }; }; };
550
551/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::XIndexReplace
This is the generic interface for supporting the replacement of indexed elements.
Definition XIndexReplace.idl:29
com::sun::star::container::XNameContainer
This is the generic interface for supporting the insertion and removal of named elements.
Definition XNameContainer.idl:29
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition XGraphic.idl:38
com::sun::star::style::BreakType
BreakType
These enumeration values are used to specify if and how a page or column break is applied.
Definition BreakType.idl:28
com::sun::star::style::ParagraphAdjust
ParagraphAdjust
These enumeration values describe the formatting of a text paragraph.
Definition ParagraphAdjust.idl:27
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:28
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition Color.idl:34
com
Definition Ambiguous.idl:20
com::sun::star::style::ParagraphProperties
describes the style of paragraphs.
Definition ParagraphProperties.idl:25
com::sun::star::style::ParagraphProperties::ContinueingPreviousSubTree
boolean ContinueingPreviousSubTree
specifies that a child node of a parent node that is not counted is continuing the numbering of paren...
Definition ParagraphProperties.idl:388
com::sun::star::style::ParagraphProperties::ParaVertAlignment
short ParaVertAlignment
specifies the vertical alignment of a paragraph.
Definition ParagraphProperties.idl:337
com::sun::star::style::ParagraphProperties::ParaUserDefinedAttributes
com::sun::star::container::XNameContainer ParaUserDefinedAttributes
this property stores xml attributes.
Definition ParagraphProperties.idl:344
com::sun::star::style::ParagraphProperties::ParaLineSpacing
com::sun::star::style::LineSpacing ParaLineSpacing
contains the type of the line spacing of a paragraph.
Definition ParagraphProperties.idl:34
com::sun::star::style::ParagraphProperties::ParaTabStops
sequence< com::sun::star::style::TabStop > ParaTabStops
specifies the positions and kinds of the tab stops within this paragraph.
Definition ParagraphProperties.idl:178
com::sun::star::style::ParagraphProperties::TopBorder
com::sun::star::table::BorderLine TopBorder
contains the top border of the object.
Definition ParagraphProperties.idl:270
com::sun::star::style::ParagraphProperties::ParaHyphenationZoneColumn
long ParaHyphenationZoneColumn
specifies the column end zone, i.e.
Definition ParagraphProperties.idl:490
com::sun::star::style::ParagraphProperties::ParaBackGraphicFilter
string ParaBackGraphicFilter
contains the name of the graphic filter for the background graphic of a paragraph.
Definition ParagraphProperties.idl:62
com::sun::star::style::ParagraphProperties::TopBorderDistance
long TopBorderDistance
contains the distance from the top border to the object.
Definition ParagraphProperties.idl:290
com::sun::star::style::ParagraphProperties::ParaExpandSingleWord
boolean ParaExpandSingleWord
determines if single words are stretched.
Definition ParagraphProperties.idl:84
com::sun::star::style::ParagraphProperties::ParaHyphenationZone
long ParaHyphenationZone
specifies the hyphenation zone, i.e.
Definition ParagraphProperties.idl:421
com::sun::star::style::ParagraphProperties::ParaWidows
byte ParaWidows
specifies the minimum number of lines of the paragraph that have to be at top of a page if the paragr...
Definition ParagraphProperties.idl:255
com::sun::star::style::ParagraphProperties::ParaHyphenationZoneAlways
long ParaHyphenationZoneAlways
specifies the paragraph end zone, i.e.
Definition ParagraphProperties.idl:479
com::sun::star::style::ParagraphProperties::PageStyleName
string PageStyleName
contains the name of the current page style.
Definition ParagraphProperties.idl:188
com::sun::star::style::ParagraphProperties::ParaLineNumberCount
boolean ParaLineNumberCount
determines if the paragraph is included in the line numbering.
Definition ParagraphProperties.idl:144
com::sun::star::style::ParagraphProperties::ParaInteropGrabBag
sequence< com::sun::star::beans::PropertyValue > ParaInteropGrabBag
Grab bag of paragraph properties, used as a string-any map for interim interop purposes.
Definition ParagraphProperties.idl:139
com::sun::star::style::ParagraphProperties::ParaRightMargin
long ParaRightMargin
determines the right margin of the paragraph in 100th mm.
Definition ParagraphProperties.idl:94
com::sun::star::style::ParagraphProperties::ListId
string ListId
specifies the id of the list to which the paragraph belongs
Definition ParagraphProperties.idl:364
com::sun::star::style::ParagraphProperties::ParaBottomMargin
long ParaBottomMargin
determines the bottom margin of the paragraph in 100th mm.
Definition ParagraphProperties.idl:120
com::sun::star::style::ParagraphProperties::ParaIsHyphenation
boolean ParaIsHyphenation
specifies if automatic hyphenation is applied.
Definition ParagraphProperties.idl:315
com::sun::star::style::ParagraphProperties::ParaContextMargin
boolean ParaContextMargin
determines if contextual spacing is used.
Definition ParagraphProperties.idl:129
com::sun::star::style::ParagraphProperties::RightBorder
com::sun::star::table::BorderLine RightBorder
contains the right border of the object.
Definition ParagraphProperties.idl:266
com::sun::star::style::ParagraphProperties::ParaHyphenationZoneSpread
long ParaHyphenationZoneSpread
specifies the spread end zone, i.e.
Definition ParagraphProperties.idl:512
com::sun::star::style::ParagraphProperties::ParaHyphenationKeep
boolean ParaHyphenationKeep
This value is TRUE if both parts of a hyphenated word shall lie within a single spread,...
Definition ParagraphProperties.idl:439
com::sun::star::style::ParagraphProperties::ParaLastLineAdjust
short ParaLastLineAdjust
determines the adjustment of the last line.
Definition ParagraphProperties.idl:76
com::sun::star::style::ParagraphProperties::NumberingIsNumber
boolean NumberingIsNumber
returns FALSE if the paragraph is part of a numbering, but has no numbering label.
Definition ParagraphProperties.idl:353
com::sun::star::style::ParagraphProperties::ParaHyphenationKeepType
long ParaHyphenationKeepType
Specifies how last line on a page or on other regions is hyphenated.
Definition ParagraphProperties.idl:449
com::sun::star::style::ParagraphProperties::ParaHyphenationNoCaps
boolean ParaHyphenationNoCaps
Specifies whether words written in CAPS will be hyphenated.
Definition ParagraphProperties.idl:401
com::sun::star::style::ParagraphProperties::ParaOrphans
byte ParaOrphans
specifies the minimum number of lines of the paragraph that have to be at bottom of a page if the par...
Definition ParagraphProperties.idl:249
com::sun::star::style::ParagraphProperties::ParaIsNumberingRestart
boolean ParaIsNumberingRestart
determines if the numbering rules restart, counting at the current paragraph.
Definition ParagraphProperties.idl:235
com::sun::star::style::ParagraphProperties::BottomBorder
com::sun::star::table::BorderLine BottomBorder
contains the bottom border of the object.
Definition ParagraphProperties.idl:274
com::sun::star::style::ParagraphProperties::NumberingStartValue
short NumberingStartValue
specifies the start value for numbering if a new numbering starts at this paragraph.
Definition ParagraphProperties.idl:231
com::sun::star::style::ParagraphProperties::ParaWordSpacingMaximum
long ParaWordSpacingMaximum
specifies the maximum word spacing as percentage value relative to the width of the space character.
Definition ParagraphProperties.idl:545
com::sun::star::style::ParagraphProperties::DropCapFormat
com::sun::star::style::DropCapFormat DropCapFormat
specifies whether the first characters of the paragraph are displayed in capital letters and how they...
Definition ParagraphProperties.idl:195
com::sun::star::style::ParagraphProperties::BreakType
com::sun::star::style::BreakType BreakType
determines the type of break that is applied at the beginning of the table.
Definition ParagraphProperties.idl:299
com::sun::star::style::ParagraphProperties::ParaRegisterModeActive
boolean ParaRegisterModeActive
determines if the register mode is applied to a paragraph.
Definition ParagraphProperties.idl:172
com::sun::star::style::ParagraphProperties::ParaHyphenationCompoundMinLeadingChars
short ParaHyphenationCompoundMinLeadingChars
specifies the minimum number of characters of the compound word part to remain before the hyphen char...
Definition ParagraphProperties.idl:456
com::sun::star::style::ParagraphProperties::SortedTextId
long SortedTextId
contains a paragraph identifier within the actual text, which also shows the position of the paragrap...
Definition ParagraphProperties.idl:430
com::sun::star::style::ParagraphProperties::ParaIsAutoFirstLineIndent
boolean ParaIsAutoFirstLineIndent
determines if the first line should be indented automatically.
Definition ParagraphProperties.idl:311
com::sun::star::style::ParagraphProperties::ParaKeepTogether
boolean ParaKeepTogether
Setting this property to TRUE prevents page or column breaks between this and the following paragraph...
Definition ParagraphProperties.idl:211
com::sun::star::style::ParagraphProperties::ParaHyphenationKeepLine
boolean ParaHyphenationKeepLine
This value is TRUE if ParaHyphenationKeep = TRUE solved by shifting the hyphenated word,...
Definition ParagraphProperties.idl:468
com::sun::star::style::ParagraphProperties::PageNumberOffset
short PageNumberOffset
If a page break property is set at a paragraph, this property contains the new value for the page num...
Definition ParagraphProperties.idl:161
com::sun::star::style::ParagraphProperties::ParaWordSpacingMinimum
long ParaWordSpacingMinimum
specifies the minimum word spacing as percentage value relative to the width of the space character.
Definition ParagraphProperties.idl:534
com::sun::star::style::ParagraphProperties::ParaLeftMargin
long ParaLeftMargin
determines the left margin of the paragraph in 100th mm.
Definition ParagraphProperties.idl:89
com::sun::star::style::ParagraphProperties::BorderDistance
long BorderDistance
contains the distance from the border to the object.
Definition ParagraphProperties.idl:278
com::sun::star::style::ParagraphProperties::ParaFirstLineIndent
long ParaFirstLineIndent
specifies the indent for the first line.
Definition ParagraphProperties.idl:307
com::sun::star::style::ParagraphProperties::OutlineLevel
short OutlineLevel
specifies the outline level to which the paragraph belongs
Definition ParagraphProperties.idl:373
com::sun::star::style::ParagraphProperties::ParaHyphenationMaxTrailingChars
short ParaHyphenationMaxTrailingChars
specifies the minimum number of characters to remain after the hyphen character (when hyphenation is ...
Definition ParagraphProperties.idl:331
com::sun::star::style::ParagraphProperties::NumberingLevel
short NumberingLevel
specifies the numbering level of the paragraph.
Definition ParagraphProperties.idl:222
com::sun::star::style::ParagraphProperties::DropCapCharStyleName
string DropCapCharStyleName
specifies the character style name for drop caps.
Definition ParagraphProperties.idl:303
com::sun::star::style::ParagraphProperties::LeftBorderDistance
long LeftBorderDistance
contains the distance from the left border to the object.
Definition ParagraphProperties.idl:282
com::sun::star::style::ParagraphProperties::ParaWordSpacing
long ParaWordSpacing
specifies the desired word spacing as percentage value relative to the width of the space character.
Definition ParagraphProperties.idl:523
com::sun::star::style::ParagraphProperties::DropCapWholeWord
boolean DropCapWholeWord
specifies if the property DropCapFormat is applied to the whole first word.
Definition ParagraphProperties.idl:201
com::sun::star::style::ParagraphProperties::ParaBackGraphicLocation
com::sun::star::style::GraphicLocation ParaBackGraphicLocation
contains the value for the position of a background graphic.
Definition ParagraphProperties.idl:69
com::sun::star::style::ParagraphProperties::ParaShadowFormat
com::sun::star::table::ShadowFormat ParaShadowFormat
determines the type, color, and size of the shadow.
Definition ParagraphProperties.idl:259
com::sun::star::style::ParagraphProperties::ParaIsConnectBorder
boolean ParaIsConnectBorder
the property determines if borders set at a paragraph are merged with the next paragraph.
Definition ParagraphProperties.idl:359
com::sun::star::style::ParagraphProperties::ParaTopMargin
long ParaTopMargin
determines the top margin of the paragraph in 100th mm.
Definition ParagraphProperties.idl:106
com::sun::star::style::ParagraphProperties::ParaHyphenationNoLastWord
boolean ParaHyphenationNoLastWord
Specifies whether last word of paragraph will be hyphenated.
Definition ParagraphProperties.idl:408
com::sun::star::style::ParagraphProperties::ParaBackColor
com::sun::star::util::Color ParaBackColor
contains the paragraph background color.
Definition ParagraphProperties.idl:39
com::sun::star::style::ParagraphProperties::ParaBackGraphicURL
string ParaBackGraphicURL
contains the value of a link for the background graphic of a paragraph.
Definition ParagraphProperties.idl:58
com::sun::star::style::ParagraphProperties::ParaBackGraphic
com::sun::star::graphic::XGraphic ParaBackGraphic
contains the graphic for the background of a paragraph.
Definition ParagraphProperties.idl:379
com::sun::star::style::ParagraphProperties::ParaHyphenationZonePage
long ParaHyphenationZonePage
specifies the page end zone, i.e.
Definition ParagraphProperties.idl:501
com::sun::star::style::ParagraphProperties::PageDescName
string PageDescName
If this property is set, it creates a page break before the paragraph it belongs to and assigns the v...
Definition ParagraphProperties.idl:156
com::sun::star::style::ParagraphProperties::ParaLineNumberStartValue
long ParaLineNumberStartValue
contains the start value for the line numbering.
Definition ParagraphProperties.idl:149
com::sun::star::style::ParagraphProperties::ParaStyleName
string ParaStyleName
contains the name of the current paragraph style.
Definition ParagraphProperties.idl:183
com::sun::star::style::ParagraphProperties::NumberingStyleName
string NumberingStyleName
specifies the name of the style for the numbering.
Definition ParagraphProperties.idl:243
com::sun::star::style::ParagraphProperties::ParaBackTransparent
boolean ParaBackTransparent
This value is TRUE if the paragraph background color is set to transparent.
Definition ParagraphProperties.idl:45
com::sun::star::style::ParagraphProperties::NumberingRules
com::sun::star::container::XIndexReplace NumberingRules
contains the numbering rules applied to this paragraph.
Definition ParagraphProperties.idl:226
com::sun::star::style::ParagraphProperties::RightBorderDistance
long RightBorderDistance
contains the distance from the right border to the object.
Definition ParagraphProperties.idl:286
com::sun::star::style::ParagraphProperties::ParaHyphenationMaxLeadingChars
short ParaHyphenationMaxLeadingChars
specifies the minimum number of characters to remain before the hyphen character (when hyphenation is...
Definition ParagraphProperties.idl:325
com::sun::star::style::ParagraphProperties::ParaHyphenationMaxHyphens
short ParaHyphenationMaxHyphens
specifies the maximum number of consecutive hyphens.
Definition ParagraphProperties.idl:319
com::sun::star::style::ParagraphProperties::ListLabelString
string ListLabelString
allows reading the generated numbering list label.
Definition ParagraphProperties.idl:394
com::sun::star::style::ParagraphProperties::ParaHyphenationMinWordLength
short ParaHyphenationMinWordLength
specifies the minimum word length in characters, when hyphenation is applied.
Definition ParagraphProperties.idl:414
com::sun::star::style::ParagraphProperties::ParaSplit
boolean ParaSplit
Setting this property to FALSE prevents the paragraph from getting split into two pages or columns.
Definition ParagraphProperties.idl:217
com::sun::star::style::ParagraphProperties::LeftBorder
com::sun::star::table::BorderLine LeftBorder
contains the left border of the object.
Definition ParagraphProperties.idl:262
com::sun::star::style::ParagraphProperties::BottomBorderDistance
long BottomBorderDistance
contains the distance from the bottom border to the object.
Definition ParagraphProperties.idl:294
com::sun::star::style::ParagraphProperties::ParaAdjust
com::sun::star::style::ParagraphAdjust ParaAdjust
determines the adjustment of a paragraph.
Definition ParagraphProperties.idl:29
com::sun::star::style::DropCapFormat
This struct describes drop caps at a paragraph object.
Definition DropCapFormat.idl:27
com::sun::star::style::LineSpacing
This structure is used to specify the height of a text line.
Definition LineSpacing.idl:27
com::sun::star::table::BorderLine
describes the line type for a single cell edge.
Definition BorderLine.idl:27
com::sun::star::table::ShadowFormat
describes the settings of a cell shadow.
Definition ShadowFormat.idl:27