LibreOffice
LibreOffice 6.4 SDK API Reference
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 #ifndef __com_sun_star_style_ParagraphProperties_idl__
20 #define __com_sun_star_style_ParagraphProperties_idl__
21 
35 
36 module com { module sun { module star { module style {
37 
40 published service ParagraphProperties
41 {
42 
46 
47 
51 
52 
56 
57 
61  [optional, property] boolean ParaBackTransparent;
62 
63 
74  [optional, property] string ParaBackGraphicURL;
75 
78  [optional, property] string ParaBackGraphicFilter;
79 
80 
86 
87 
92  [property] short ParaLastLineAdjust;
93 
94 
100  [optional, property] boolean ParaExpandSingleWord;
101 
102 
105  [property] long ParaLeftMargin;
106 
107 
110  [property] long ParaRightMargin;
111 
112 
122  [property] long ParaTopMargin;
123 
124 
136  [property] long ParaBottomMargin;
137 
145  [optional, property] boolean ParaContextMargin;
146 
155  [optional, property] sequence<com::sun::star::beans::PropertyValue> ParaInteropGrabBag;
156 
160  [optional, property] boolean ParaLineNumberCount;
161 
162 
165  [optional, property] long ParaLineNumberStartValue;
166 
167 
172  [optional, property] string PageDescName;
173 
174 
177  [optional, property] short PageNumberOffset;
178 
179 
188  [optional, property] boolean ParaRegisterModeActive;
189 
190 
194  [optional, property] sequence<com::sun::star::style::TabStop> ParaTabStops;
195 
196 
199  [optional, property] string ParaStyleName;
200 
201 
204  [optional, property, maybevoid, readonly] string PageStyleName;
205 
206 
212 
213 
217  [optional, property] boolean DropCapWholeWord;
218 
219 
227  [optional, property] boolean ParaKeepTogether;
228 
229 
233  [optional, property] boolean ParaSplit;
234 
235 
238  [optional, property] short NumberingLevel;
239 
243 
244 
247  [optional, property] short NumberingStartValue;
248 
251  [optional, property] boolean ParaIsNumberingRestart;
252 
259  [optional, property] string NumberingStyleName;
260 
265  [optional, property] byte ParaOrphans;
266 
271  [optional, property] byte ParaWidows;
279 
283 
287 
291 
294  [property, optional] long BorderDistance;
295 
298  [property, optional] long LeftBorderDistance;
299 
302  [property, optional] long RightBorderDistance;
303 
306  [property, optional] long TopBorderDistance;
307 
310  [property, optional] long BottomBorderDistance;
311 
316 
319  [optional, property] string DropCapCharStyleName;
320 
323  [optional, property] long ParaFirstLineIndent;
324 
327  [optional, property] boolean ParaIsAutoFirstLineIndent;
328 
331  [property] boolean ParaIsHyphenation;
332 
335  [optional, property] short ParaHyphenationMaxHyphens;
336 
340  [optional, property] short ParaHyphenationMaxLeadingChars;
341 
345  [optional, property] short ParaHyphenationMaxTrailingChars;
346 
351  [optional, property] short ParaVertAlignment;
352 
359 
367  [optional, property, maybevoid] boolean NumberingIsNumber;
368 
373  [optional, property, maybevoid] boolean ParaIsConnectBorder;
374 
378  [optional, property] string ListId;
379 
387  [optional, property] short OutlineLevel;
388 
394 
402  [optional, property, readonly] boolean ContinueingPreviousSubTree;
403 
408  [optional, property, readonly] string ListLabelString;
409 
415  [optional, property] boolean ParaHyphenationNoCaps;
416 
417 };
418 
419 
420 }; }; }; };
421 
422 #endif
423 
424 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::style::ParagraphProperties::ParaHyphenationMaxTrailingChars
short ParaHyphenationMaxTrailingChars
specifies the maximum number of characters to remain after the hyphen character (when hyphenation is ...
Definition: ParagraphProperties.idl:345
Color.idl
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:315
com::sun::star::container::XIndexReplace
This is the generic interface for supporting the replacement of indexed elements.
Definition: XIndexReplace.idl:39
com::sun::star::style::ParagraphProperties::ParaBackGraphic
com::sun::star::graphic::XGraphic ParaBackGraphic
contains the graphic for the background of a paragraph.
Definition: ParagraphProperties.idl:393
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:367
com::sun::star::style::ParagraphProperties
describes the style of paragraphs.
Definition: ParagraphProperties.idl:41
com::sun::star::style::DropCapFormat
This struct describes drop caps at a paragraph object.
Definition: DropCapFormat.idl:29
XIndexReplace.idl
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:373
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:30
com::sun::star::style::ParagraphAdjust
ParagraphAdjust
These enumeration values describe the formatting of a text paragraph.
Definition: ParagraphAdjust.idl:29
com::sun::star::style::ParagraphProperties::ParaBackColor
com::sun::star::util::Color ParaBackColor
contains the paragraph background color.
Definition: ParagraphProperties.idl:55
TabStop.idl
com::sun::star::style::ParagraphProperties::NumberingStyleName
string NumberingStyleName
specifies the name of the style for the numbering.
Definition: ParagraphProperties.idl:259
com::sun::star::style::ParagraphProperties::ListLabelString
string ListLabelString
allows reading the generated numbering list label.
Definition: ParagraphProperties.idl:408
com::sun::star::style::LineSpacing
This structure is used to specify the height of a text line.
Definition: LineSpacing.idl:29
com::sun::star::style::ParagraphProperties::ParaRightMargin
long ParaRightMargin
determines the right margin of the paragraph in 100th mm.
Definition: ParagraphProperties.idl:110
com::sun::star::style::ParagraphProperties::ParaLineNumberCount
boolean ParaLineNumberCount
determines if the paragraph is included in the line numbering.
Definition: ParagraphProperties.idl:160
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:85
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:211
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:78
com::sun::star::style::ParagraphProperties::ParaLineNumberStartValue
long ParaLineNumberStartValue
contains the start value for the line numbering.
Definition: ParagraphProperties.idl:165
com::sun::star::style::ParagraphProperties::ParaHyphenationMaxLeadingChars
short ParaHyphenationMaxLeadingChars
specifies the maximum number of characters to remain before the hyphen character (when hyphenation is...
Definition: ParagraphProperties.idl:340
ParagraphAdjust.idl
com::sun::star::style::ParagraphProperties::TopBorderDistance
long TopBorderDistance
contains the distance from the top border to the object.
Definition: ParagraphProperties.idl:306
com::sun::star::style::ParagraphProperties::ParaBottomMargin
long ParaBottomMargin
determines the bottom margin of the paragraph in 100th mm.
Definition: ParagraphProperties.idl:136
com::sun::star::style::ParagraphProperties::OutlineLevel
short OutlineLevel
specifies the outline level to which the paragraph belongs
Definition: ParagraphProperties.idl:387
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:402
com::sun::star::style::ParagraphProperties::BottomBorder
com::sun::star::table::BorderLine BottomBorder
contains the bottom border of the object.
Definition: ParagraphProperties.idl:290
com::sun::star::style::ParagraphProperties::ListId
string ListId
specifies the id of the list to which the paragraph belongs
Definition: ParagraphProperties.idl:378
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:44
com::sun::star::style::ParagraphProperties::PageStyleName
string PageStyleName
contains the name of the current page style.
Definition: ParagraphProperties.idl:204
com::sun::star::style::ParagraphProperties::ParaFirstLineIndent
long ParaFirstLineIndent
specifies the indent for the first line.
Definition: ParagraphProperties.idl:323
com::sun::star::style::ParagraphProperties::ParaLastLineAdjust
short ParaLastLineAdjust
determines the adjustment of the last line.
Definition: ParagraphProperties.idl:92
com::sun::star::table::ShadowFormat
describes the settings of a cell shadow.
Definition: ShadowFormat.idl:33
com::sun::star::container::XNameContainer
This is the generic interface for supporting the insertion and removal of named elements.
Definition: XNameContainer.idl:41
GraphicLocation.idl
com::sun::star::style::ParagraphProperties::NumberingLevel
short NumberingLevel
specifies the numbering level of the paragraph.
Definition: ParagraphProperties.idl:238
com::sun::star::style::ParagraphProperties::ParaHyphenationMaxHyphens
short ParaHyphenationMaxHyphens
specifies the maximum number of consecutive hyphens.
Definition: ParagraphProperties.idl:335
ShadowFormat.idl
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:172
com::sun::star::style::ParagraphProperties::ParaBackTransparent
boolean ParaBackTransparent
This value is TRUE if the paragraph background color is set to transparent.
Definition: ParagraphProperties.idl:61
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:30
com::sun::star::table::BorderLine
describes the line type for a single cell edge.
Definition: BorderLine.idl:32
XNameContainer.idl
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:177
com::sun::star::style::ParagraphProperties::ParaExpandSingleWord
boolean ParaExpandSingleWord
determines if single words are stretched.
Definition: ParagraphProperties.idl:100
DropCapFormat.idl
XGraphic.idl
PropertyValue.idl
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:194
com::sun::star::style::ParagraphProperties::ParaLeftMargin
long ParaLeftMargin
determines the left margin of the paragraph in 100th mm.
Definition: ParagraphProperties.idl:105
com::sun::star::style::ParagraphProperties::LeftBorder
com::sun::star::table::BorderLine LeftBorder
contains the left border of the object.
Definition: ParagraphProperties.idl:278
com::sun::star::style::ParagraphProperties::ParaHyphenationNoCaps
boolean ParaHyphenationNoCaps
Specifies whether words written in CAPS will be hyphenated.
Definition: ParagraphProperties.idl:415
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:233
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:155
com::sun::star::style::ParagraphProperties::ParaBackGraphicURL
string ParaBackGraphicURL
contains the value of a link for the background graphic of a paragraph.
Definition: ParagraphProperties.idl:74
com::sun::star::style::ParagraphProperties::BorderDistance
long BorderDistance
contains the distance from the border to the object.
Definition: ParagraphProperties.idl:294
com::sun::star::style::ParagraphProperties::BottomBorderDistance
long BottomBorderDistance
contains the distance from the bottom border to the object.
Definition: ParagraphProperties.idl:310
BorderLine.idl
com::sun::star::style::ParagraphProperties::ParaStyleName
string ParaStyleName
contains the name of the current paragraph style.
Definition: ParagraphProperties.idl:199
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:271
com::sun::star::style::ParagraphProperties::ParaIsAutoFirstLineIndent
boolean ParaIsAutoFirstLineIndent
determines if the first line should be indented automatically.
Definition: ParagraphProperties.idl:327
com::sun::star::style::ParagraphProperties::ParaRegisterModeActive
boolean ParaRegisterModeActive
determines if the register mode is applied to a paragraph.
Definition: ParagraphProperties.idl:188
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:247
com::sun::star::style::ParagraphProperties::ParaAdjust
com::sun::star::style::ParagraphAdjust ParaAdjust
determines the adjustment of a paragraph.
Definition: ParagraphProperties.idl:45
com::sun::star::style::ParagraphProperties::RightBorder
com::sun::star::table::BorderLine RightBorder
contains the right border of the object.
Definition: ParagraphProperties.idl:282
com::sun::star::style::ParagraphProperties::ParaIsHyphenation
boolean ParaIsHyphenation
specifies if automatic hyphenation is applied.
Definition: ParagraphProperties.idl:331
com::sun::star::style::ParagraphProperties::LeftBorderDistance
long LeftBorderDistance
contains the distance from the left border to the object.
Definition: ParagraphProperties.idl:298
com::sun::star::style::ParagraphProperties::DropCapCharStyleName
string DropCapCharStyleName
specifies the character style name for drop caps.
Definition: ParagraphProperties.idl:319
com::sun::star::style::ParagraphProperties::ParaUserDefinedAttributes
com::sun::star::container::XNameContainer ParaUserDefinedAttributes
this property stores xml attributes.
Definition: ParagraphProperties.idl:358
com::sun::star::style::ParagraphProperties::TopBorder
com::sun::star::table::BorderLine TopBorder
contains the top border of the object.
Definition: ParagraphProperties.idl:286
com
Definition: Ambiguous.idl:22
com::sun::star::style::ParagraphProperties::ParaContextMargin
boolean ParaContextMargin
determines if contextual spacing is used.
Definition: ParagraphProperties.idl:145
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:265
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:50
com::sun::star::style::ParagraphProperties::ParaShadowFormat
com::sun::star::table::ShadowFormat ParaShadowFormat
determines the type, color, and size of the shadow.
Definition: ParagraphProperties.idl:275
com::sun::star::style::ParagraphProperties::ParaIsNumberingRestart
boolean ParaIsNumberingRestart
determines if the numbering rules restart, counting at the current paragraph.
Definition: ParagraphProperties.idl:251
com::sun::star::style::ParagraphProperties::NumberingRules
com::sun::star::container::XIndexReplace NumberingRules
contains the numbering rules applied to this paragraph.
Definition: ParagraphProperties.idl:242
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
com::sun::star::style::ParagraphProperties::ParaTopMargin
long ParaTopMargin
determines the top margin of the paragraph in 100th mm.
Definition: ParagraphProperties.idl:122
com::sun::star::style::ParagraphProperties::RightBorderDistance
long RightBorderDistance
contains the distance from the right border to the object.
Definition: ParagraphProperties.idl:302
LineSpacing.idl
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:227
BreakType.idl
com::sun::star::style::ParagraphProperties::ParaVertAlignment
short ParaVertAlignment
specifies the vertical alignment of a paragraph.
Definition: ParagraphProperties.idl:351
com::sun::star::style::ParagraphProperties::DropCapWholeWord
boolean DropCapWholeWord
specifies if the property DropCapFormat is applied to the whole first word.
Definition: ParagraphProperties.idl:217