offapi/com/sun/star/style/CharacterProperties.idl

   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
  24 /** This is a set of properties to describe the style of characters.@see ParagraphProperties
  25  */
  26 published service CharacterProperties
  27 {
  28
  29     /** This property specifies the name of the font style.
  30
  31         <p>It may contain more than one name separated by comma.</p>
  32      */
  33     [property] string CharFontName;
  34
  35
  36     /** This property contains the name of the font style.
  37
  38         <p>This property may be empty.</p>
  39      */
  40     [property] string CharFontStyleName;
  41
  42
  43     /** This property contains font family.
  44         @see com::sun::star::awt::FontFamily
  45      */
  46     [property] short CharFontFamily;
  47
  48
  49     /** This property contains the text encoding of the font.
  50         @see com::sun::star::awt::CharSet
  51      */
  52     [property] short CharFontCharSet;
  53
  54
  55     /** This property contains the font pitch.
  56         @see com::sun::star::awt::FontPitch
  57      */
  58     [property] short CharFontPitch;
  59
  60
  61     /** This property contains the value of the text color.
  62      */
  63     [property] com::sun::star::util::Color CharColor;
  64
  65
  66     /** specifies the percentage by which to raise/lower superscript/subscript
  67         characters.
  68
  69         <p>Negative values denote subscripts and positive values superscripts.</p>
  70
  71         @see CharEscapementHeight
  72      */
  73     [optional, property] short CharEscapement;
  74
  75
  76     /** This value contains the height of the characters in point.
  77      */
  78     [property] float CharHeight;
  79
  80
  81     /** This property contains the value for the character underline.
  82         @see com::sun::star::awt::FontUnderline
  83      */
  84     [property] short CharUnderline;
  85
  86
  87     /** This property contains the value of the font weight.
  88         @see com::sun::star::awt::FontWeight
  89      */
  90     [property] float CharWeight;
  91
  92
  93     /** This property contains the value of the posture of the document.
  94         @see com::sun::star::awt::FontSlant
  95      */
  96     [property] com::sun::star::awt::FontSlant CharPosture;
  97
  98
  99     /** This optional property determines whether the kerning tables from the
 100         current font are used.
 101
 102         <p>Automatic <em>kerning</em> applies a spacing in between certain
 103         pairs of characters to make the text look better.</p>
 104      */
 105     [optional, property] boolean CharAutoKerning;
 106
 107
 108     /** This optional property contains the text background color.
 109      */
 110     [optional, property] com::sun::star::util::Color CharBackColor;
 111
 112
 113     /** This optional property contains the text shading value.
 114      */
 115     [optional, property] long CharShadingValue;
 116
 117
 118     /** This property determines if the text background color is set to
 119         transparent.
 120      */
 121     [optional, property] boolean CharBackTransparent;
 122
 123
 124     /** This optional property contains the value of the case-mapping of the
 125         text for formatting and displaying.
 126
 127         @see CaseMap
 128      */
 129     [optional, property] short CharCaseMap;
 130
 131
 132     /** This property is `TRUE` if the characters are crossed out.
 133      */
 134     [optional, property] boolean CharCrossedOut;
 135
 136
 137     /** If this optional property is `TRUE`, then the characters are flashing.
 138      */
 139     [optional, property] boolean CharFlash;
 140
 141
 142     /** This property determines the type of the strike out of the character.
 143         @see com::sun::star::awt::FontStrikeout
 144     */
 145     [optional, property] short CharStrikeout;
 146
 147
 148     /** If this property is `TRUE`, the underline and strike-through
 149         properties are not applied to white spaces.
 150      */
 151     [optional, property] boolean CharWordMode;
 152
 153
 154     /** This optional property contains the value of the kerning of the
 155         characters.
 156      */
 157     [optional, property] short CharKerning;
 158
 159
 160     /** This property contains the value of the locale.
 161      */
 162     [property] com::sun::star::lang::Locale CharLocale;
 163
 164
 165     /** This optional property marks a range of characters to prevent it from
 166         being broken into two lines.
 167
 168         <p> A line break is applied before the range of characters if
 169         the layout makes a break necessary within the range.</p>
 170     */
 171     [optional, property] boolean CharKeepTogether;
 172
 173
 174     /** This optional property marks a range of characters to ignore a line
 175         break in this area.
 176
 177         <p> A line break is applied behind the range of characters if
 178         the layout makes a break necessary within the range. That means that
 179         the text may go through the border.</p>
 180      */
 181     [optional, property] boolean CharNoLineBreak;
 182
 183
 184     /** This optional property specifies if the characters are formatted and
 185         displayed with a shadow effect.
 186      */
 187     [optional, property] boolean CharShadowed;
 188
 189
 190     /** This optional property specifies the fundamental technology of the font.
 191         @see com::sun::star::awt::FontType
 192      */
 193     [optional, property] short CharFontType;
 194
 195
 196     /** This optional property specifies the name of the style of the font.
 197      */
 198     [optional, property] string CharStyleName;
 199
 200
 201     /** This optional property specifies if the characters are formatted and
 202         displayed with a contour effect.
 203      */
 204     [optional, property] boolean CharContoured;
 205
 206
 207     /** This optional property determines whether text is formatted in two lines.
 208
 209         <p>It is linked to the properties CharCombinePrefix and CharCombineSuffix.</p>
 210      */
 211     [optional, property] boolean CharCombineIsOn;
 212
 213
 214     /** This optional property contains the prefix (usually parenthesis) before
 215         text that is formatted in two lines.
 216
 217         <p>It is linked to the properties CharCombineIsOn and CharCombineSuffix.</p>
 218      */
 219     [optional, property] string CharCombinePrefix;
 220
 221
 222     /** This optional property contains the suffix (usually parenthesis) after
 223         text that is formatted in two lines.
 224
 225         <p>It is linked to the properties CharCombineIsOn and CharCombinePrefix.</p>
 226      */
 227     [optional, property] string CharCombineSuffix;
 228
 229
 230     /** This optional property contains the font emphasis value.
 231         @see com::sun::star::text::FontEmphasis
 232      */
 233     [optional, property] short CharEmphasis;
 234
 235
 236     /** This optional property contains the relief style of the characters.
 237         @see com::sun::star::text::FontRelief
 238      */
 239     [optional, property] short CharRelief;
 240
 241
 242     /** This optional property contains the text that is set as ruby.
 243      */
 244     [optional, property] string RubyText;
 245
 246
 247     /** This optional property determines the adjustment of the ruby .
 248         @see com::sun::star::text::RubyAdjust
 249      */
 250     [optional, property] short RubyAdjust;
 251
 252
 253     /** This optional property contains the name of the character style that is
 254         applied to RubyText.
 255      */
 256     [optional, property] string RubyCharStyleName;
 257
 258
 259     /** This optional property determines whether the ruby text is printed
 260         above/left or below/right of the text.
 261        <p>This property is replaced by RubyPosition.</p>
 262         @deprecated
 263      */
 264     [optional, property] boolean RubyIsAbove;
 265
 266
 267     /** This optional property determines the rotation of a character in tenths
 268         of a degree.
 269
 270        <p>Depending on the implementation only certain values may be allowed.</p>
 271      */
 272     [optional, property] short CharRotation;
 273
 274
 275     /** This optional property determines whether the text formatting tries to
 276         fit rotated text into the surrounded line height.
 277      */
 278     [optional, property] boolean CharRotationIsFitToLine;
 279
 280
 281     /** This optional property determines the percentage value for scaling the
 282         width of characters.
 283
 284         <p>The value refers to the original width which is denoted by 100,
 285         and it has to be greater than 0.</p>
 286    */
 287     [optional, property] short CharScaleWidth;
 288
 289
 290     /** This optional property contains the URL of a hyperlink.
 291      */
 292     [optional, property] string HyperLinkURL;
 293
 294
 295     /** This optional property contains the name of the target for a hyperlink.
 296      */
 297     [optional, property] string HyperLinkTarget;
 298
 299
 300     /** This optional property contains the name of the hyperlink.
 301      */
 302     [optional, property] string HyperLinkName;
 303
 304
 305     /** This optional property contains the character style name for visited
 306         hyperlinks.
 307      */
 308     [optional, property] string VisitedCharStyleName;
 309
 310
 311     /** This optional property contains the character style name for unvisited
 312         hyperlinks.
 313      */
 314     [optional, property] string UnvisitedCharStyleName;
 315
 316
 317     /** This is the relative height used for subscript or superscript
 318         characters in units of percent.
 319
 320         <p>The value 100 denotes the original height of the characters.</p>
 321
 322         @see CharEscapement
 323      */
 324     [optional, property] byte CharEscapementHeight;
 325
 326
 327     /** This optional property determines if the word can be hyphenated at the
 328         character.
 329      */
 330     [optional, property] boolean CharNoHyphenation;
 331
 332
 333     /** This property contains the color of the underline for the characters.
 334         @see CharUnderlineHasColor
 335      */
 336     [property] com::sun::star::util::Color CharUnderlineColor;
 337
 338
 339     /** This property specifies if the property CharUnderlineColor is used for
 340         an underline.
 341         @see CharUnderlineColor
 342      */
 343     [property] boolean CharUnderlineHasColor;
 344
 345
 346     /** This optional property specifies the names of the all styles applied to
 347         the font.
 348
 349         <p> It is not guaranteed that the order in the sequence reflects
 350         the order of the evaluation of the character style attributes.</p>
 351
 352         @since OOo 1.1.2
 353      */
 354     [optional, property] sequence<string> CharStyleNames;
 355
 356
 357     /** If this optional property is `TRUE`, then the characters are invisible.
 358
 359         @since OOo 2.0
 360      */
 361     [optional, property] boolean CharHidden;
 362
 363
 364     /** This property stores XML attributes. They will be saved to and restored
 365         from automatic styles inside XML files.
 366
 367         @see com::sun::star::xml::AttributeContainer
 368      */
 369     [optional, property] com::sun::star::container::XNameContainer  TextUserDefinedAttributes;
 370
 371     /** This property contains the left border of the object.
 372      *
 373      *  @since LibreOffice 4.2
 374     **/
 375     [property, optional] com::sun::star::table::BorderLine2 CharLeftBorder;
 376
 377     /** This property contains the right border of the object.
 378      *
 379      *  @since LibreOffice 4.2
 380     **/
 381     [property, optional] com::sun::star::table::BorderLine2 CharRightBorder;
 382
 383     /** This property contains the top border of the object.
 384      *
 385      *  @since LibreOffice 4.2
 386     **/
 387     [property, optional] com::sun::star::table::BorderLine2 CharTopBorder;
 388
 389     /** This property contains the bottom border of the object.
 390      *
 391      *  @since LibreOffice 4.2
 392     **/
 393     [property, optional] com::sun::star::table::BorderLine2 CharBottomBorder;
 394
 395     /** This property contains the distance from the border to the object.
 396      *
 397      *  @since LibreOffice 4.2
 398     **/
 399     [property, optional] long CharBorderDistance;
 400
 401     /** This property contains the distance from the left border to the object.
 402      *
 403      *  @since LibreOffice 4.2
 404     **/
 405     [property, optional] long CharLeftBorderDistance;
 406
 407     /** This property contains the distance from the right border to the object.
 408      *
 409      *  @since LibreOffice 4.2
 410     **/
 411     [property, optional] long CharRightBorderDistance;
 412
 413     /** This property contains the distance from the top border to the object.
 414      *
 415      *  @since LibreOffice 4.2
 416     **/
 417     [property, optional] long CharTopBorderDistance;
 418
 419     /** This property contains the distance from the bottom border to the object.
 420      *
 421      *  @since LibreOffice 4.2
 422     **/
 423     [property, optional] long CharBottomBorderDistance;
 424
 425     /** Determines the type, color, and width of the shadow.
 426      *
 427      *  @since LibreOffice 4.2
 428     **/
 429     [optional, property] com::sun::star::table::ShadowFormat CharShadowFormat;
 430
 431     /** Determines the color of the highlight.
 432      *
 433      *  @since LibreOffice 4.2
 434     **/
 435     [optional, property] com::sun::star::util::Color CharHighlight;
 436
 437     /** Grab bag of character properties, used as a string-any map for interim interop purposes.
 438
 439         @since LibreOffice 4.3
 440
 441         <p>This property is intentionally not handled by the ODF filter. Any
 442         member that should be handled there should be first moved out from this grab
 443         bag to a separate property.</p>
 444     */
 445     [optional, property] sequence<com::sun::star::beans::PropertyValue> CharInteropGrabBag;
 446
 447     /** This optional property determines the position of the ruby .
 448         @see com::sun::star::text::RubyPosition
 449         @since LibreOffice 6.1
 450      */
 451     [optional, property] short RubyPosition;
 452
 453     /** This is the transparency of the character text.
 454
 455         @since LibreOffice 7.0
 456
 457         <p>The value 100 means entirely transparent, while 0 means not transparent at all.</p>
 458     */
 459     [optional, property] short CharTransparence;
 460
 461     /** If available, keeps the color theme index, so that the character can
 462      *  be re-colored easily based on a theme.
 463      *
 464      *  @since LibreOffice 7.3
 465      **/
 466     [optional, property] short CharColorTheme;
 467
 468     /** Tint or shade of the character color.
 469      *
 470      *  @since LibreOffice 7.3
 471      **/
 472     [optional, property] short CharColorTintOrShade;
 473 };
 474
 475 }; }; }; };
 476
 477 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */