LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 
34 
35 
36  module com { module sun { module star { module style {
37 
38 
41 published service ParagraphProperties
42 {
43 
47 
48 
52 
53 
57 
58 
62  [optional, property] boolean ParaBackTransparent;
63 
64 
67  [optional, property] string ParaBackGraphicURL;
68 
69 
72  [optional, property] string ParaBackGraphicFilter;
73 
74 
80 
81 
86  [property] short ParaLastLineAdjust;
87 
88 
94  [optional, property] boolean ParaExpandSingleWord;
95 
96 
99  [property] long ParaLeftMargin;
100 
101 
104  [property] long ParaRightMargin;
105 
106 
116  [property] long ParaTopMargin;
117 
118 
130  [property] long ParaBottomMargin;
131 
139  [optional, property] boolean ParaContextMargin;
140 
149  [optional, property] sequence<com::sun::star::beans::PropertyValue> ParaInteropGrabBag;
150 
154  [optional, property] boolean ParaLineNumberCount;
155 
156 
159  [optional, property] long ParaLineNumberStartValue;
160 
161 
166  [optional, property] string PageDescName;
167 
168 
171  [optional, property] short PageNumberOffset;
172 
173 
182  [optional, property] boolean ParaRegisterModeActive;
183 
184 
188  [optional, property] sequence<com::sun::star::style::TabStop> ParaTabStops;
189 
190 
193  [optional, property] string ParaStyleName;
194 
195 
198  [optional, property, maybevoid, readonly] string PageStyleName;
199 
200 
206 
207 
211  [optional, property] boolean DropCapWholeWord;
212 
213 
221  [optional, property] boolean ParaKeepTogether;
222 
223 
227  [optional, property] boolean ParaSplit;
228 
229 
232  [optional, property] short NumberingLevel;
233 
237 
238 
241  [optional, property] short NumberingStartValue;
242 
245  [optional, property] boolean ParaIsNumberingRestart;
246 
253  [optional, property] string NumberingStyleName;
254 
259  [optional, property] byte ParaOrphans;
260 
265  [optional, property] byte ParaWidows;
273 
277 
281 
285 
288  [property, optional] long BorderDistance;
289 
292  [property, optional] long LeftBorderDistance;
293 
296  [property, optional] long RightBorderDistance;
297 
300  [property, optional] long TopBorderDistance;
301 
304  [property, optional] long BottomBorderDistance;
305 
310 
313  [optional, property] string DropCapCharStyleName;
314 
317  [optional, property] long ParaFirstLineIndent;
318 
321  [optional, property] boolean ParaIsAutoFirstLineIndent;
322 
325  [property] boolean ParaIsHyphenation;
326 
329  [optional, property] short ParaHyphenationMaxHyphens;
330 
334  [optional, property] short ParaHyphenationMaxLeadingChars;
335 
339  [optional, property] short ParaHyphenationMaxTrailingChars;
340 
345  [optional, property] short ParaVertAlignment;
346 
353 
361  [optional, property, maybevoid] boolean NumberingIsNumber;
362 
367  [optional, property, maybevoid] boolean ParaIsConnectBorder;
368 
372  [optional, property] string ListId;
373 
381  [optional, property] short OutlineLevel;
382 };
383 
384 
385 }; }; }; };
386 
387 #endif
388 
389 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
long BottomBorderDistance
contains the distance from the bottom border to the object.
Definition: ParagraphProperties.idl:304
long ParaLeftMargin
determines the left margin of the paragraph in 100th mm.
Definition: ParagraphProperties.idl:99
This structure is used to specify the height of a text line.
Definition: LineSpacing.idl:28
string ParaBackGraphicURL
contains the value of a link for the background graphic of a paragraph.
Definition: ParagraphProperties.idl:67
long BorderDistance
contains the distance from the border to the object.
Definition: ParagraphProperties.idl:288
com::sun::star::table::BorderLine LeftBorder
contains the left border of the object.
Definition: ParagraphProperties.idl:272
This is the generic interface for supporting the replacement of indexed elements. ...
Definition: XIndexReplace.idl:38
sequence< com::sun::star::style::TabStop > ParaTabStops
specifies the positions and kinds of the tab stops within this paragraph.
Definition: ParagraphProperties.idl:188
boolean ParaRegisterModeActive
determines if the register mode is applied to a paragraph.
Definition: ParagraphProperties.idl:182
string ParaStyleName
contains the name of the current paragraph style.
Definition: ParagraphProperties.idl:193
boolean ParaIsAutoFirstLineIndent
determines if the first line should be indented automatically.
Definition: ParagraphProperties.idl:321
string DropCapCharStyleName
specifies the character style name for drop caps.
Definition: ParagraphProperties.idl:313
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:265
This struct describes drop caps at a paragraph object.
Definition: DropCapFormat.idl:28
com::sun::star::table::BorderLine RightBorder
contains the right border of the object.
Definition: ParagraphProperties.idl:276
boolean ParaIsHyphenation
specifies if automatic hyphenation is applied.
Definition: ParagraphProperties.idl:325
boolean ParaContextMargin
determines if contextual spacing is used.
Definition: ParagraphProperties.idl:139
short NumberingStartValue
specifies the start value for numbering if a new numbering starts at this paragraph.
Definition: ParagraphProperties.idl:241
long LeftBorderDistance
contains the distance from the left border to the object.
Definition: ParagraphProperties.idl:292
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:259
com::sun::star::style::ParagraphAdjust ParaAdjust
determines the adjustment of a paragraph.
Definition: ParagraphProperties.idl:46
com::sun::star::table::BorderLine TopBorder
contains the top border of the object.
Definition: ParagraphProperties.idl:280
describes the style of paragraphs.
Definition: ParagraphProperties.idl:41
com::sun::star::style::LineSpacing ParaLineSpacing
contains the type of the line spacing of a paragraph.
Definition: ParagraphProperties.idl:51
com::sun::star::container::XNameContainer ParaUserDefinedAttributes
this property stores xml attributes.
Definition: ParagraphProperties.idl:352
long RightBorderDistance
contains the distance from the right border to the object.
Definition: ParagraphProperties.idl:296
com::sun::star::table::ShadowFormat ParaShadowFormat
determines the type, color, and size of the shadow.
Definition: ParagraphProperties.idl:269
BreakType
These enumeration values are used to specify if and how a page or column break is applied...
Definition: BreakType.idl:29
long ParaTopMargin
determines the top margin of the paragraph in 100th mm.
Definition: ParagraphProperties.idl:116
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:29
short ParaHyphenationMaxTrailingChars
specifies the maximum number of characters to remain after the hyphen character (when hyphenation is ...
Definition: ParagraphProperties.idl:339
boolean ParaKeepTogether
Setting this property to TRUE prevents page or column breaks between this and the following paragraph...
Definition: ParagraphProperties.idl:221
boolean ParaIsNumberingRestart
determines if the numbering rules restart, counting at the current paragraph.
Definition: ParagraphProperties.idl:245
boolean DropCapWholeWord
specifies if the property DropCapFormat is applied to the whole first word.
Definition: ParagraphProperties.idl:211
com::sun::star::container::XIndexReplace NumberingRules
contains the numbering rules applied to this paragraph.
Definition: ParagraphProperties.idl:236
short ParaVertAlignment
specifies the vertical alignment of a paragraph.
Definition: ParagraphProperties.idl:345
ParagraphAdjust
These enumeration values describe the formatting of a text paragraph.
Definition: ParagraphAdjust.idl:28
com::sun::star::style::BreakType BreakType
determines the type of break that is applied at the beginning of the table.
Definition: ParagraphProperties.idl:309
string NumberingStyleName
specifies the name of the style for the numbering.
Definition: ParagraphProperties.idl:253
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 ParaLineNumberCount
determines if the paragraph is included in the line numbering.
Definition: ParagraphProperties.idl:154
boolean ParaIsConnectBorder
the property determines if borders set at a paragraph are merged with the next paragraph.
Definition: ParagraphProperties.idl:367
com::sun::star::util::Color ParaBackColor
contains the paragraph background color.
Definition: ParagraphProperties.idl:56
boolean NumberingIsNumber
returns FALSE if the paragraph is part of a numbering, but has no numbering label.
Definition: ParagraphProperties.idl:361
com::sun::star::table::BorderLine BottomBorder
contains the bottom border of the object.
Definition: ParagraphProperties.idl:284
long ParaBottomMargin
determines the bottom margin of the paragraph in 100th mm.
Definition: ParagraphProperties.idl:130
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:205
com::sun::star::style::GraphicLocation ParaBackGraphicLocation
contains the value for the position of a background graphic.
Definition: ParagraphProperties.idl:79
long ParaLineNumberStartValue
contains the start value for the line numbering.
Definition: ParagraphProperties.idl:159
long ParaRightMargin
determines the right margin of the paragraph in 100th mm.
Definition: ParagraphProperties.idl:104
short ParaHyphenationMaxLeadingChars
specifies the maximum number of characters to remain before the hyphen character (when hyphenation is...
Definition: ParagraphProperties.idl:334
string PageStyleName
contains the name of the current page style.
Definition: ParagraphProperties.idl:198
long TopBorderDistance
contains the distance from the top border to the object.
Definition: ParagraphProperties.idl:300
string ParaBackGraphicFilter
contains the name of the graphic filter for the background graphic of a paragraph.
Definition: ParagraphProperties.idl:72
string ListId
specifies the id of the list to which the paragraph belongs
Definition: ParagraphProperties.idl:372
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
long ParaFirstLineIndent
specifies the indent for the first line.
Definition: ParagraphProperties.idl:317
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:166
short OutlineLevel
specifies the outline level to which the paragraph belongs
Definition: ParagraphProperties.idl:381
describes the line type for a single cell edge.
Definition: BorderLine.idl:31
short NumberingLevel
specifies the numbering level of the paragraph.
Definition: ParagraphProperties.idl:232
boolean ParaExpandSingleWord
determines if single words are stretched.
Definition: ParagraphProperties.idl:94
short ParaLastLineAdjust
determines the adjustment of the last line.
Definition: ParagraphProperties.idl:86
boolean ParaBackTransparent
This value is TRUE if the paragraph background color is set to transparent.
Definition: ParagraphProperties.idl:62
short ParaHyphenationMaxHyphens
specifies the maximum number of consecutive hyphens.
Definition: ParagraphProperties.idl:329
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:171
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:149
boolean ParaSplit
Setting this property to FALSE prevents the paragraph from getting split into two pages or columns...
Definition: ParagraphProperties.idl:227