LibreOffice
LibreOffice 6.2 SDK API Reference
CharacterProperties.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_CharacterProperties_idl__
20 #define __com_sun_star_style_CharacterProperties_idl__
21 
29 
30 
31  module com { module sun { module star { module style {
32 
33 
36 published service CharacterProperties
37 {
38 
43  [property] string CharFontName;
44 
45 
50  [property] string CharFontStyleName;
51 
52 
56  [property] short CharFontFamily;
57 
58 
62  [property] short CharFontCharSet;
63 
64 
68  [property] short CharFontPitch;
69 
70 
74 
75 
83  [optional, property] short CharEscapement;
84 
85 
88  [property] float CharHeight;
89 
90 
94  [property] short CharUnderline;
95 
96 
100  [property] float CharWeight;
101 
102 
107 
108 
115  [optional, property] boolean CharAutoKerning;
116 
117 
121 
122 
125  [optional, property] long CharShadingValue;
126 
127 
131  [optional, property] boolean CharBackTransparent;
132 
133 
139  [optional, property] short CharCaseMap;
140 
141 
144  [optional, property] boolean CharCrossedOut;
145 
146 
149  [optional, property] boolean CharFlash;
150 
151 
155  [optional, property] short CharStrikeout;
156 
157 
161  [optional, property] boolean CharWordMode;
162 
163 
167  [optional, property] short CharKerning;
168 
169 
173 
174 
181  [optional, property] boolean CharKeepTogether;
182 
183 
191  [optional, property] boolean CharNoLineBreak;
192 
193 
197  [optional, property] boolean CharShadowed;
198 
199 
203  [optional, property] short CharFontType;
204 
205 
208  [optional, property] string CharStyleName;
209 
210 
214  [optional, property] boolean CharContoured;
215 
216 
221  [optional, property] boolean CharCombineIsOn;
222 
223 
229  [optional, property] string CharCombinePrefix;
230 
231 
237  [optional, property] string CharCombineSuffix;
238 
239 
243  [optional, property] short CharEmphasis;
244 
245 
249  [optional, property] short CharRelief;
250 
251 
254  [optional, property] string RubyText;
255 
256 
260  [optional, property] short RubyAdjust;
261 
262 
266  [optional, property] string RubyCharStyleName;
267 
268 
274  [optional, property] boolean RubyIsAbove;
275 
276 
282  [optional, property] short CharRotation;
283 
284 
288  [optional, property] boolean CharRotationIsFitToLine;
289 
290 
297  [optional, property] short CharScaleWidth;
298 
299 
302  [optional, property] string HyperLinkURL;
303 
304 
307  [optional, property] string HyperLinkTarget;
308 
309 
312  [optional, property] string HyperLinkName;
313 
314 
318  [optional, property] string VisitedCharStyleName;
319 
320 
324  [optional, property] string UnvisitedCharStyleName;
325 
326 
334  [optional, property] byte CharEscapementHeight;
335 
336 
340  [optional, property] boolean CharNoHyphenation;
341 
342 
347 
348 
353  [property] boolean CharUnderlineHasColor;
354 
355 
364  [optional, property] sequence<string> CharStyleNames;
365 
366 
371  [optional, property] boolean CharHidden;
372 
373 
380 
386 
392 
398 
404 
409  [property, optional] long CharBorderDistance;
410 
415  [property, optional] long CharLeftBorderDistance;
416 
421  [property, optional] long CharRightBorderDistance;
422 
427  [property, optional] long CharTopBorderDistance;
428 
433  [property, optional] long CharBottomBorderDistance;
434 
440 
446 
455  [optional, property] sequence<com::sun::star::beans::PropertyValue> CharInteropGrabBag;
456 
461  [optional, property] short RubyPosition;
462 
463 };
464 
465 }; }; }; };
466 
467 #endif
468 
469 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
boolean CharShadowed
This optional property specifies if the characters are formatted and displayed with a shadow effect...
Definition: CharacterProperties.idl:197
string RubyCharStyleName
This optional property contains the name of the character style that is applied to RubyText...
Definition: CharacterProperties.idl:266
com::sun::star::table::BorderLine2 CharBottomBorder
This property contains the bottom border of the object.
Definition: CharacterProperties.idl:403
sequence< string > CharStyleNames
This optional property specifies the names of the all styles applied to the font. ...
Definition: CharacterProperties.idl:364
long CharShadingValue
This optional property contains the text shading value.
Definition: CharacterProperties.idl:125
string CharCombinePrefix
This optional property contains the prefix (usually parenthesis) before text that is formatted in two...
Definition: CharacterProperties.idl:229
short CharFontFamily
This property contains font family.
Definition: CharacterProperties.idl:56
string CharStyleName
This optional property specifies the name of the style of the font.
Definition: CharacterProperties.idl:208
string HyperLinkName
This optional property contains the name of the hyperlink.
Definition: CharacterProperties.idl:312
short CharCaseMap
This optional property contains the value of the case-mapping of the text for formatting and displayi...
Definition: CharacterProperties.idl:139
short CharUnderline
This property contains the value for the character underline.
Definition: CharacterProperties.idl:94
string VisitedCharStyleName
This optional property contains the character style name for visited hyperlinks.
Definition: CharacterProperties.idl:318
com::sun::star::container::XNameContainer TextUserDefinedAttributes
This property stores XML attributes.
Definition: CharacterProperties.idl:379
com::sun::star::util::Color CharUnderlineColor
This property contains the color of the underline for the characters.
Definition: CharacterProperties.idl:346
short CharEmphasis
This optional property contains the font emphasis value.
Definition: CharacterProperties.idl:243
string RubyText
This optional property contains the text that is set as ruby.
Definition: CharacterProperties.idl:254
Definition: Ambiguous.idl:22
com::sun::star::util::Color CharHighlight
Determines the color of the highlight.
Definition: CharacterProperties.idl:445
short RubyAdjust
This optional property determines the adjustment of the ruby .
Definition: CharacterProperties.idl:260
byte CharEscapementHeight
This is the relative height used for subscript or superscript characters in units of percent...
Definition: CharacterProperties.idl:334
short CharRotation
This optional property determines the rotation of a character in tenths of a degree.
Definition: CharacterProperties.idl:282
long CharTopBorderDistance
This property contains the distance from the top border to the object.
Definition: CharacterProperties.idl:427
string HyperLinkURL
This optional property contains the URL of a hyperlink.
Definition: CharacterProperties.idl:302
short RubyPosition
This optional property determines the position of the ruby .
Definition: CharacterProperties.idl:461
com::sun::star::awt::FontSlant CharPosture
This property contains the value of the posture of the document.
Definition: CharacterProperties.idl:106
float CharHeight
This value contains the height of the characters in point.
Definition: CharacterProperties.idl:88
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:47
short CharRelief
This optional property contains the relief style of the characters.
Definition: CharacterProperties.idl:249
long CharBorderDistance
This property contains the distance from the border to the object.
Definition: CharacterProperties.idl:409
short CharFontCharSet
This property contains the text encoding of the font.
Definition: CharacterProperties.idl:62
short CharScaleWidth
This optional property determines the percentage value for scaling the width of characters.
Definition: CharacterProperties.idl:297
com::sun::star::util::Color CharColor
This property contains the value of the text color.
Definition: CharacterProperties.idl:73
long CharLeftBorderDistance
This property contains the distance from the left border to the object.
Definition: CharacterProperties.idl:415
boolean CharHidden
If this optional property is TRUE, then the characters are invisible.
Definition: CharacterProperties.idl:371
string CharFontName
This property specifies the name of the font style.
Definition: CharacterProperties.idl:43
boolean CharUnderlineHasColor
This property specifies if the property CharUnderlineColor is used for an underline.
Definition: CharacterProperties.idl:353
boolean RubyIsAbove
This optional property determines whether the ruby text is printed above/left or below/right of the t...
Definition: CharacterProperties.idl:274
boolean CharNoLineBreak
This optional property marks a range of characters to ignore a line break in this area...
Definition: CharacterProperties.idl:191
string HyperLinkTarget
This optional property contains the name of the target for a hyperlink.
Definition: CharacterProperties.idl:307
short CharFontPitch
This property contains the font pitch.
Definition: CharacterProperties.idl:68
float CharWeight
This property contains the value of the font weight.
Definition: CharacterProperties.idl:100
com::sun::star::lang::Locale CharLocale
This property contains the value of the locale.
Definition: CharacterProperties.idl:172
boolean CharCombineIsOn
This optional property determines whether text is formatted in two lines.
Definition: CharacterProperties.idl:221
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
com::sun::star::table::BorderLine2 CharTopBorder
This property contains the top border of the object.
Definition: CharacterProperties.idl:397
com::sun::star::table::ShadowFormat CharShadowFormat
Determines the type, color, and width of the shadow.
Definition: CharacterProperties.idl:439
string CharCombineSuffix
This optional property contains the suffix (usually parenthesis) after text that is formatted in two ...
Definition: CharacterProperties.idl:237
sequence< com::sun::star::beans::PropertyValue > CharInteropGrabBag
Grab bag of character properties, used as a string-any map for interim interop purposes.
Definition: CharacterProperties.idl:455
long CharRightBorderDistance
This property contains the distance from the right border to the object.
Definition: CharacterProperties.idl:421
boolean CharAutoKerning
This optional property determines whether the kerning tables from the current font are used...
Definition: CharacterProperties.idl:115
string UnvisitedCharStyleName
This optional property contains the character style name for unvisited hyperlinks.
Definition: CharacterProperties.idl:324
short CharStrikeout
This property determines the type of the strike out of the character.
Definition: CharacterProperties.idl:155
This is a set of properties to describe the style of characters.
Definition: CharacterProperties.idl:36
boolean CharCrossedOut
This property is TRUE if the characters are crossed out.
Definition: CharacterProperties.idl:144
boolean CharWordMode
If this property is TRUE, the underline and strike-through properties are not applied to white spaces...
Definition: CharacterProperties.idl:161
boolean CharNoHyphenation
This optional property determines if the word can be hyphenated at the character. ...
Definition: CharacterProperties.idl:340
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
com::sun::star::util::Color CharBackColor
This optional property contains the text background color.
Definition: CharacterProperties.idl:120
boolean CharContoured
This optional property specifies if the characters are formatted and displayed with a contour effect...
Definition: CharacterProperties.idl:214
long CharBottomBorderDistance
This property contains the distance from the bottom border to the object.
Definition: CharacterProperties.idl:433
boolean CharKeepTogether
This optional property marks a range of characters to prevent it from being broken into two lines...
Definition: CharacterProperties.idl:181
com::sun::star::table::BorderLine2 CharLeftBorder
This property contains the left border of the object.
Definition: CharacterProperties.idl:385
string CharFontStyleName
This property contains the name of the font style.
Definition: CharacterProperties.idl:50
FontSlant
used to specify the slant of a font.
Definition: FontSlant.idl:29
boolean CharRotationIsFitToLine
This optional property determines whether the text formatting tries to fit rotated text into the surr...
Definition: CharacterProperties.idl:288
A border line, extended with line style.
Definition: BorderLine2.idl:35
short CharEscapement
specifies the percentage by which to raise/lower superscript/subscript characters.
Definition: CharacterProperties.idl:83
short CharKerning
This optional property contains the value of the kerning of the characters.
Definition: CharacterProperties.idl:167
boolean CharBackTransparent
This property determines if the text background color is set to transparent.
Definition: CharacterProperties.idl:131
boolean CharFlash
If this optional property is TRUE, then the characters are flashing.
Definition: CharacterProperties.idl:149
com::sun::star::table::BorderLine2 CharRightBorder
This property contains the right border of the object.
Definition: CharacterProperties.idl:391
short CharFontType
This optional property specifies the fundamental technology of the font.
Definition: CharacterProperties.idl:203