LibreOffice
LibreOffice 24.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 
20 
21  module com { module sun { module star { module style {
22 
23 
26 published service CharacterProperties
27 {
28 
33  [property] string CharFontName;
34 
35 
40  [property] string CharFontStyleName;
41 
42 
46  [property] short CharFontFamily;
47 
48 
52  [property] short CharFontCharSet;
53 
54 
58  [property] short CharFontPitch;
59 
60 
64 
65 
73  [optional, property] short CharEscapement;
74 
75 
78  [property] float CharHeight;
79 
80 
84  [property] short CharUnderline;
85 
86 
90  [property] float CharWeight;
91 
92 
97 
98 
105  [optional, property] boolean CharAutoKerning;
106 
107 
111 
112 
115  [optional, property] long CharShadingValue;
116 
117 
121  [optional, property] boolean CharBackTransparent;
122 
123 
129  [optional, property] short CharCaseMap;
130 
131 
134  [optional, property] boolean CharCrossedOut;
135 
136 
139  [optional, property] boolean CharFlash;
140 
141 
145  [optional, property] short CharStrikeout;
146 
147 
151  [optional, property] boolean CharWordMode;
152 
153 
157  [optional, property] short CharKerning;
158 
159 
163 
164 
171  [optional, property] boolean CharKeepTogether;
172 
173 
181  [optional, property] boolean CharNoLineBreak;
182 
183 
187  [optional, property] boolean CharShadowed;
188 
189 
193  [optional, property] short CharFontType;
194 
195 
198  [optional, property] string CharStyleName;
199 
200 
204  [optional, property] boolean CharContoured;
205 
206 
211  [optional, property] boolean CharCombineIsOn;
212 
213 
219  [optional, property] string CharCombinePrefix;
220 
221 
227  [optional, property] string CharCombineSuffix;
228 
229 
233  [optional, property] short CharEmphasis;
234 
235 
239  [optional, property] short CharRelief;
240 
241 
244  [optional, property] string RubyText;
245 
246 
250  [optional, property] short RubyAdjust;
251 
252 
256  [optional, property] string RubyCharStyleName;
257 
258 
264  [optional, property] boolean RubyIsAbove;
265 
266 
272  [optional, property] short CharRotation;
273 
274 
278  [optional, property] boolean CharRotationIsFitToLine;
279 
280 
287  [optional, property] short CharScaleWidth;
288 
289 
292  [optional, property] string HyperLinkURL;
293 
294 
297  [optional, property] string HyperLinkTarget;
298 
299 
302  [optional, property] string HyperLinkName;
303 
304 
308  [optional, property] string VisitedCharStyleName;
309 
310 
314  [optional, property] string UnvisitedCharStyleName;
315 
316 
324  [optional, property] byte CharEscapementHeight;
325 
326 
336  [optional, property] boolean CharNoHyphenation;
337 
338 
343 
344 
349  [property] boolean CharUnderlineHasColor;
350 
351 
360  [optional, property] sequence<string> CharStyleNames;
361 
362 
367  [optional, property] boolean CharHidden;
368 
369 
376 
382 
388 
394 
400 
405  [property, optional] long CharBorderDistance;
406 
411  [property, optional] long CharLeftBorderDistance;
412 
417  [property, optional] long CharRightBorderDistance;
418 
423  [property, optional] long CharTopBorderDistance;
424 
429  [property, optional] long CharBottomBorderDistance;
430 
436 
442 
451  [optional, property] sequence<com::sun::star::beans::PropertyValue> CharInteropGrabBag;
452 
457  [optional, property] short RubyPosition;
458 
465  [optional, property] short CharTransparence;
466 
472  [optional, property] short CharColorTheme;
473 
478  [optional, property] short CharColorTintOrShade;
479 };
480 
481 }; }; }; };
482 
483 /* 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:187
string RubyCharStyleName
This optional property contains the name of the character style that is applied to RubyText...
Definition: CharacterProperties.idl:256
com::sun::star::table::BorderLine2 CharBottomBorder
This property contains the bottom border of the object.
Definition: CharacterProperties.idl:399
sequence< string > CharStyleNames
This optional property specifies the names of the all styles applied to the font. ...
Definition: CharacterProperties.idl:360
long CharShadingValue
This optional property contains the text shading value.
Definition: CharacterProperties.idl:115
string CharCombinePrefix
This optional property contains the prefix (usually parenthesis) before text that is formatted in two...
Definition: CharacterProperties.idl:219
short CharFontFamily
This property contains font family.
Definition: CharacterProperties.idl:46
string CharStyleName
This optional property specifies the name of the style of the font.
Definition: CharacterProperties.idl:198
string HyperLinkName
This optional property contains the name of the hyperlink.
Definition: CharacterProperties.idl:302
short CharCaseMap
This optional property contains the value of the case-mapping of the text for formatting and displayi...
Definition: CharacterProperties.idl:129
short CharUnderline
This property contains the value for the character underline.
Definition: CharacterProperties.idl:84
string VisitedCharStyleName
This optional property contains the character style name for visited hyperlinks.
Definition: CharacterProperties.idl:308
com::sun::star::container::XNameContainer TextUserDefinedAttributes
This property stores XML attributes.
Definition: CharacterProperties.idl:375
com::sun::star::util::Color CharUnderlineColor
This property contains the color of the underline for the characters.
Definition: CharacterProperties.idl:342
short CharColorTintOrShade
Tint or shade of the character color.
Definition: CharacterProperties.idl:478
short CharEmphasis
This optional property contains the font emphasis value.
Definition: CharacterProperties.idl:233
string RubyText
This optional property contains the text that is set as ruby.
Definition: CharacterProperties.idl:244
Definition: Ambiguous.idl:20
com::sun::star::util::Color CharHighlight
Determines the color of the highlight.
Definition: CharacterProperties.idl:441
short RubyAdjust
This optional property determines the adjustment of the ruby .
Definition: CharacterProperties.idl:250
byte CharEscapementHeight
This is the relative height used for subscript or superscript characters in units of percent...
Definition: CharacterProperties.idl:324
short CharRotation
This optional property determines the rotation of a character in tenths of a degree.
Definition: CharacterProperties.idl:272
long CharTopBorderDistance
This property contains the distance from the top border to the object.
Definition: CharacterProperties.idl:423
string HyperLinkURL
This optional property contains the URL of a hyperlink.
Definition: CharacterProperties.idl:292
short RubyPosition
This optional property determines the position of the ruby .
Definition: CharacterProperties.idl:457
com::sun::star::awt::FontSlant CharPosture
This property contains the value of the posture of the document.
Definition: CharacterProperties.idl:96
float CharHeight
This value contains the height of the characters in point.
Definition: CharacterProperties.idl:78
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:33
short CharRelief
This optional property contains the relief style of the characters.
Definition: CharacterProperties.idl:239
long CharBorderDistance
This property contains the distance from the border to the object.
Definition: CharacterProperties.idl:405
short CharFontCharSet
This property contains the text encoding of the font.
Definition: CharacterProperties.idl:52
short CharScaleWidth
This optional property determines the percentage value for scaling the width of characters.
Definition: CharacterProperties.idl:287
com::sun::star::util::Color CharColor
This property contains the value of the text color.
Definition: CharacterProperties.idl:63
long CharLeftBorderDistance
This property contains the distance from the left border to the object.
Definition: CharacterProperties.idl:411
boolean CharHidden
If this optional property is TRUE, then the characters are invisible.
Definition: CharacterProperties.idl:367
string CharFontName
This property specifies the name of the font style.
Definition: CharacterProperties.idl:33
boolean CharUnderlineHasColor
This property specifies if the property CharUnderlineColor is used for an underline.
Definition: CharacterProperties.idl:349
boolean RubyIsAbove
This optional property determines whether the ruby text is printed above/left or below/right of the t...
Definition: CharacterProperties.idl:264
boolean CharNoLineBreak
This optional property marks a range of characters to ignore a line break in this area...
Definition: CharacterProperties.idl:181
string HyperLinkTarget
This optional property contains the name of the target for a hyperlink.
Definition: CharacterProperties.idl:297
short CharFontPitch
This property contains the font pitch.
Definition: CharacterProperties.idl:58
float CharWeight
This property contains the value of the font weight.
Definition: CharacterProperties.idl:90
com::sun::star::lang::Locale CharLocale
This property contains the value of the locale.
Definition: CharacterProperties.idl:162
boolean CharCombineIsOn
This optional property determines whether text is formatted in two lines.
Definition: CharacterProperties.idl:211
This is the generic interface for supporting the insertion and removal of named elements.
Definition: XNameContainer.idl:28
describes the settings of a cell shadow.
Definition: ShadowFormat.idl:26
com::sun::star::table::BorderLine2 CharTopBorder
This property contains the top border of the object.
Definition: CharacterProperties.idl:393
com::sun::star::table::ShadowFormat CharShadowFormat
Determines the type, color, and width of the shadow.
Definition: CharacterProperties.idl:435
string CharCombineSuffix
This optional property contains the suffix (usually parenthesis) after text that is formatted in two ...
Definition: CharacterProperties.idl:227
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:451
long CharRightBorderDistance
This property contains the distance from the right border to the object.
Definition: CharacterProperties.idl:417
short CharTransparence
This is the transparency of the character text.
Definition: CharacterProperties.idl:465
boolean CharAutoKerning
This optional property determines whether the kerning tables from the current font are used...
Definition: CharacterProperties.idl:105
string UnvisitedCharStyleName
This optional property contains the character style name for unvisited hyperlinks.
Definition: CharacterProperties.idl:314
short CharStrikeout
This property determines the type of the strike out of the character.
Definition: CharacterProperties.idl:145
This is a set of properties to describe the style of characters.
Definition: CharacterProperties.idl:26
boolean CharCrossedOut
This property is TRUE if the characters are crossed out.
Definition: CharacterProperties.idl:134
boolean CharWordMode
If this property is TRUE, the underline and strike-through properties are not applied to white spaces...
Definition: CharacterProperties.idl:151
boolean CharNoHyphenation
This optional property determines if the word can be hyphenated at the character by automatic hyphena...
Definition: CharacterProperties.idl:336
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:34
com::sun::star::util::Color CharBackColor
This optional property contains the text background color.
Definition: CharacterProperties.idl:110
boolean CharContoured
This optional property specifies if the characters are formatted and displayed with a contour effect...
Definition: CharacterProperties.idl:204
long CharBottomBorderDistance
This property contains the distance from the bottom border to the object.
Definition: CharacterProperties.idl:429
boolean CharKeepTogether
This optional property marks a range of characters to prevent it from being broken into two lines...
Definition: CharacterProperties.idl:171
com::sun::star::table::BorderLine2 CharLeftBorder
This property contains the left border of the object.
Definition: CharacterProperties.idl:381
string CharFontStyleName
This property contains the name of the font style.
Definition: CharacterProperties.idl:40
FontSlant
used to specify the slant of a font.
Definition: FontSlant.idl:27
boolean CharRotationIsFitToLine
This optional property determines whether the text formatting tries to fit rotated text into the surr...
Definition: CharacterProperties.idl:278
A border line, extended with line style.
Definition: BorderLine2.idl:30
short CharEscapement
specifies the percentage by which to raise/lower superscript/subscript characters.
Definition: CharacterProperties.idl:73
short CharKerning
This optional property contains the value of the kerning of the characters.
Definition: CharacterProperties.idl:157
boolean CharBackTransparent
This property determines if the text background color is set to transparent.
Definition: CharacterProperties.idl:121
boolean CharFlash
If this optional property is TRUE, then the characters are flashing.
Definition: CharacterProperties.idl:139
short CharColorTheme
If available, keeps the color theme index, so that the character can be re-colored easily based on a ...
Definition: CharacterProperties.idl:472
com::sun::star::table::BorderLine2 CharRightBorder
This property contains the right border of the object.
Definition: CharacterProperties.idl:387
short CharFontType
This optional property specifies the fundamental technology of the font.
Definition: CharacterProperties.idl:193