LibreOffice
LibreOffice 4.2 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 
28 
29 
30  module com { module sun { module star { module style {
31 
32 
35 published service CharacterProperties
36 {
37 
42  [property] string CharFontName;
43 
44 
49  [property] string CharFontStyleName;
50 
51 
55  [property] short CharFontFamily;
56 
57 
61  [property] short CharFontCharSet;
62 
63 
67  [property] short CharFontPitch;
68 
69 
73 
74 
82  [optional, property] short CharEscapement;
83 
84 
87  [property] float CharHeight;
88 
89 
93  [property] short CharUnderline;
94 
95 
99  [property] float CharWeight;
100 
101 
106 
107 
114  [optional, property] boolean CharAutoKerning;
115 
116 
120 
121 
124  [optional, property] long CharShadingValue;
125 
126 
130  [optional, property] boolean CharBackTransparent;
131 
132 
138  [optional, property] short CharCaseMap;
139 
140 
143  [optional, property] boolean CharCrossedOut;
144 
145 
148  [optional, property] boolean CharFlash;
149 
150 
154  [optional, property] short CharStrikeout;
155 
156 
160  [optional, property] boolean CharWordMode;
161 
162 
166  [optional, property] short CharKerning;
167 
168 
172 
173 
180  [optional, property] boolean CharKeepTogether;
181 
182 
190  [optional, property] boolean CharNoLineBreak;
191 
192 
196  [optional, property] boolean CharShadowed;
197 
198 
202  [optional, property] short CharFontType;
203 
204 
207  [optional, property] string CharStyleName;
208 
209 
213  [optional, property] boolean CharContoured;
214 
215 
220  [optional, property] boolean CharCombineIsOn;
221 
222 
228  [optional, property] string CharCombinePrefix;
229 
230 
236  [optional, property] string CharCombineSuffix;
237 
238 
242  [optional, property] short CharEmphasis;
243 
244 
248  [optional, property] short CharRelief;
249 
250 
253  [optional, property] string RubyText;
254 
255 
259  [optional, property] short RubyAdjust;
260 
261 
265  [optional, property] string RubyCharStyleName;
266 
267 
271  [optional, property] boolean RubyIsAbove;
272 
273 
279  [optional, property] short CharRotation;
280 
281 
285  [optional, property] boolean CharRotationIsFitToLine;
286 
287 
294  [optional, property] short CharScaleWidth;
295 
296 
299  [optional, property] string HyperLinkURL;
300 
301 
304  [optional, property] string HyperLinkTarget;
305 
306 
309  [optional, property] string HyperLinkName;
310 
311 
315  [optional, property] string VisitedCharStyleName;
316 
317 
321  [optional, property] string UnvisitedCharStyleName;
322 
323 
331  [optional, property] byte CharEscapementHeight;
332 
333 
337  [optional, property] boolean CharNoHyphenation;
338 
339 
344 
345 
350  [property] boolean CharUnderlineHasColor;
351 
352 
361  [optional, property] sequence<string> CharStyleNames;
362 
363 
368  [optional, property] boolean CharHidden;
369 
370 
377 
383 
389 
395 
401 
406  [property, optional] long CharBorderDistance;
407 
412  [property, optional] long CharLeftBorderDistance;
413 
418  [property, optional] long CharRightBorderDistance;
419 
424  [property, optional] long CharTopBorderDistance;
425 
430  [property, optional] long CharBottomBorderDistance;
431 
437 
443 
444 };
445 
446 }; }; }; };
447 
448 #endif
449 
450 /* 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:196
string RubyCharStyleName
This optional property contains the name of the character style that is applied to RubyText...
Definition: CharacterProperties.idl:265
com::sun::star::table::BorderLine2 CharBottomBorder
This property contains the bottom border of the object.
Definition: CharacterProperties.idl:400
sequence< string > CharStyleNames
This optional property specifies the names of the all styles applied to the font. ...
Definition: CharacterProperties.idl:361
long CharShadingValue
This optional property contains the text shading value.
Definition: CharacterProperties.idl:124
string CharCombinePrefix
This optional property contains the prefix (usually parenthesis) before text that is formatted in two...
Definition: CharacterProperties.idl:228
short CharFontFamily
This property contains font family.
Definition: CharacterProperties.idl:55
string CharStyleName
This optional property specifies the name of the style of the font.
Definition: CharacterProperties.idl:207
string HyperLinkName
This optional property contains the name of the hyperlink.
Definition: CharacterProperties.idl:309
short CharCaseMap
This optional property contains the value of the case-mapping of the text for formatting and displayi...
Definition: CharacterProperties.idl:138
short CharUnderline
This property contains the value for the character underline.
Definition: CharacterProperties.idl:93
string VisitedCharStyleName
This optional property contains the character style name for visited hyperlinks.
Definition: CharacterProperties.idl:315
com::sun::star::container::XNameContainer TextUserDefinedAttributes
This property stores XML attributes.
Definition: CharacterProperties.idl:376
com::sun::star::util::Color CharUnderlineColor
This property contains the color of the underline for the characters.
Definition: CharacterProperties.idl:343
short CharEmphasis
This optional property contains the font emphasis value.
Definition: CharacterProperties.idl:242
string RubyText
This optional property contains the text that is set as ruby.
Definition: CharacterProperties.idl:253
com::sun::star::util::Color CharHighlight
Determines the color of the highlight.
Definition: CharacterProperties.idl:442
short RubyAdjust
This optional property determines the adjustment of the ruby .
Definition: CharacterProperties.idl:259
byte CharEscapementHeight
This is the relative height used for subscript or superscript characters in units of percent...
Definition: CharacterProperties.idl:331
short CharRotation
This optional property determines the rotation of a character in tenths of a degree.
Definition: CharacterProperties.idl:279
long CharTopBorderDistance
This property contains the distance from the top border to the object.
Definition: CharacterProperties.idl:424
string HyperLinkURL
This optional property contains the URL of a hyperlink.
Definition: CharacterProperties.idl:299
com::sun::star::awt::FontSlant CharPosture
This property contains the value of the posture of the document.
Definition: CharacterProperties.idl:105
float CharHeight
This value contains the height of the characters in point.
Definition: CharacterProperties.idl:87
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:52
short CharRelief
This optional property contains the relief style of the characters.
Definition: CharacterProperties.idl:248
long CharBorderDistance
This property contains the distance from the border to the object.
Definition: CharacterProperties.idl:406
short CharFontCharSet
This property contains the text encoding of the font.
Definition: CharacterProperties.idl:61
short CharScaleWidth
This optional property determines the percentage value for scaling the width of characters.
Definition: CharacterProperties.idl:294
com::sun::star::util::Color CharColor
This property contains the value of the text color.
Definition: CharacterProperties.idl:72
long CharLeftBorderDistance
This property contains the distance from the left border to the object.
Definition: CharacterProperties.idl:412
boolean CharHidden
If this optional property is TRUE, then the characters are invisible.
Definition: CharacterProperties.idl:368
string CharFontName
This property specifies the name of the font style.
Definition: CharacterProperties.idl:42
boolean CharUnderlineHasColor
This property specifies if the property CharUnderlineColor is used for an underline.
Definition: CharacterProperties.idl:350
boolean RubyIsAbove
This optional property determines whether the ruby text is printed above/left or below/right of the t...
Definition: CharacterProperties.idl:271
boolean CharNoLineBreak
This optional property marks a range of characters to ignore a line break in this area...
Definition: CharacterProperties.idl:190
string HyperLinkTarget
This optional property contains the name of the target for a hyperlink.
Definition: CharacterProperties.idl:304
short CharFontPitch
This property contains the font pitch.
Definition: CharacterProperties.idl:67
float CharWeight
This property contains the value of the font weight.
Definition: CharacterProperties.idl:99
com::sun::star::lang::Locale CharLocale
This property contains the value of the locale.
Definition: CharacterProperties.idl:171
boolean CharCombineIsOn
This optional property determines whether text is formatted in two lines.
Definition: CharacterProperties.idl:220
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:394
com::sun::star::table::ShadowFormat CharShadowFormat
Determines the type, color, and width of the shadow.
Definition: CharacterProperties.idl:436
string CharCombineSuffix
This optional property contains the suffix (usually parenthesis) after text that is formatted in two ...
Definition: CharacterProperties.idl:236
long CharRightBorderDistance
This property contains the distance from the right border to the object.
Definition: CharacterProperties.idl:418
boolean CharAutoKerning
This optional property determines whether the kerning tables from the current font are used...
Definition: CharacterProperties.idl:114
string UnvisitedCharStyleName
This optional property contains the character style name for unvisited hyperlinks.
Definition: CharacterProperties.idl:321
short CharStrikeout
This property determines the type of the strike out of the character.
Definition: CharacterProperties.idl:154
This is a set of properties to describe the style of characters.
Definition: CharacterProperties.idl:35
boolean CharCrossedOut
This property is TRUE if the characters are crossed out.
Definition: CharacterProperties.idl:143
boolean CharWordMode
If this property is TRUE, the underline and strike-through properties are not applied to white spaces...
Definition: CharacterProperties.idl:160
boolean CharNoHyphenation
This optional property determines if the word can be hyphenated at the character. ...
Definition: CharacterProperties.idl:337
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:119
boolean CharContoured
This optional property specifies if the characters are formatted and displayed with a contour effect...
Definition: CharacterProperties.idl:213
long CharBottomBorderDistance
This property contains the distance from the bottom border to the object.
Definition: CharacterProperties.idl:430
boolean CharKeepTogether
This optional property marks a range of characters to prevent it from being broken into two lines...
Definition: CharacterProperties.idl:180
com::sun::star::table::BorderLine2 CharLeftBorder
This property contains the left border of the object.
Definition: CharacterProperties.idl:382
string CharFontStyleName
This property contains the name of the font style.
Definition: CharacterProperties.idl:49
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:285
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:82
short CharKerning
This optional property contains the value of the kerning of the characters.
Definition: CharacterProperties.idl:166
boolean CharBackTransparent
This property determines if the text background color is set to transparent.
Definition: CharacterProperties.idl:130
boolean CharFlash
If this optional property is TRUE, then the characters are flashing.
Definition: CharacterProperties.idl:148
com::sun::star::table::BorderLine2 CharRightBorder
This property contains the right border of the object.
Definition: CharacterProperties.idl:388
short CharFontType
This optional property specifies the fundamental technology of the font.
Definition: CharacterProperties.idl:202