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 applied
 197         character style.
 198      */
 199     [optional, property] string CharStyleName;
 200
 201
 202     /** This optional property specifies if the characters are formatted and
 203         displayed with a contour effect.
 204      */
 205     [optional, property] boolean CharContoured;
 206
 207
 208     /** This optional property determines whether text is formatted in two lines.
 209
 210         <p>It is linked to the properties CharCombinePrefix and CharCombineSuffix.</p>
 211      */
 212     [optional, property] boolean CharCombineIsOn;
 213
 214
 215     /** This optional property contains the prefix (usually parenthesis) before
 216         text that is formatted in two lines.
 217
 218         <p>It is linked to the properties CharCombineIsOn and CharCombineSuffix.</p>
 219      */
 220     [optional, property] string CharCombinePrefix;
 221
 222
 223     /** This optional property contains the suffix (usually parenthesis) after
 224         text that is formatted in two lines.
 225
 226         <p>It is linked to the properties CharCombineIsOn and CharCombinePrefix.</p>
 227      */
 228     [optional, property] string CharCombineSuffix;
 229
 230
 231     /** This optional property contains the font emphasis value.
 232         @see com::sun::star::text::FontEmphasis
 233      */
 234     [optional, property] short CharEmphasis;
 235
 236
 237     /** This optional property contains the relief style of the characters.
 238         @see com::sun::star::text::FontRelief
 239      */
 240     [optional, property] short CharRelief;
 241
 242
 243     /** This optional property contains the text that is set as ruby.
 244      */
 245     [optional, property] string RubyText;
 246
 247
 248     /** This optional property determines the adjustment of the ruby .
 249         @see com::sun::star::text::RubyAdjust
 250      */
 251     [optional, property] short RubyAdjust;
 252
 253
 254     /** This optional property contains the name of the character style that is
 255         applied to RubyText.
 256      */
 257     [optional, property] string RubyCharStyleName;
 258
 259
 260     /** This optional property determines whether the ruby text is printed
 261         above/left or below/right of the text.
 262        <p>This property is replaced by RubyPosition.</p>
 263         @deprecated
 264      */
 265     [optional, property] boolean RubyIsAbove;
 266
 267
 268     /** This optional property determines the rotation of a character in tenths
 269         of a degree.
 270
 271        <p>Depending on the implementation only certain values may be allowed.</p>
 272      */
 273     [optional, property] short CharRotation;
 274
 275
 276     /** This optional property determines whether the text formatting tries to
 277         fit rotated text into the surrounded line height.
 278      */
 279     [optional, property] boolean CharRotationIsFitToLine;
 280
 281
 282     /** This optional property determines the percentage value for scaling the
 283         width of characters.
 284
 285         <p>The value refers to the original width which is denoted by 100,
 286         and it has to be greater than 0.</p>
 287    */
 288     [optional, property] short CharScaleWidth;
 289
 290
 291     /** This optional property contains the URL of a hyperlink.
 292      */
 293     [optional, property] string HyperLinkURL;
 294
 295
 296     /** This optional property contains the name of the target for a hyperlink.
 297      */
 298     [optional, property] string HyperLinkTarget;
 299
 300
 301     /** This optional property contains the name of the hyperlink.
 302      */
 303     [optional, property] string HyperLinkName;
 304
 305
 306     /** This optional property contains the character style name for visited
 307         hyperlinks.
 308      */
 309     [optional, property] string VisitedCharStyleName;
 310
 311
 312     /** This optional property contains the character style name for unvisited
 313         hyperlinks.
 314      */
 315     [optional, property] string UnvisitedCharStyleName;
 316
 317
 318     /** This is the relative height used for subscript or superscript
 319         characters in units of percent.
 320
 321         <p>The value 100 denotes the original height of the characters.</p>
 322
 323         @see CharEscapement
 324      */
 325     [optional, property] byte CharEscapementHeight;
 326
 327
 328     /** This optional property determines if the word can be hyphenated at the
 329         character by automatic hyphenation.
 330
 331         <p>Setting to `true` will disable hyphenation enabled by ParaIsHyphenation.</p>
 332
 333         <p>Note: implemented since LibreOffice 24.2.</p>
 334
 335         @see ParaIsHyphenation
 336      */
 337     [optional, property] boolean CharNoHyphenation;
 338
 339
 340     /** This property contains the color of the underline for the characters.
 341         @see CharUnderlineHasColor
 342      */
 343     [property] com::sun::star::util::Color CharUnderlineColor;
 344
 345
 346     /** This property specifies if the property CharUnderlineColor is used for
 347         an underline.
 348         @see CharUnderlineColor
 349      */
 350     [property] boolean CharUnderlineHasColor;
 351
 352
 353     /** This optional property specifies the names of the all styles applied to
 354         the font.
 355
 356         <p> It is not guaranteed that the order in the sequence reflects
 357         the order of the evaluation of the character style attributes.</p>
 358
 359         @since OOo 1.1.2
 360      */
 361     [optional, property] sequence<string> CharStyleNames;
 362
 363
 364     /** If this optional property is `TRUE`, then the characters are invisible.
 365
 366         @since OOo 2.0
 367      */
 368     [optional, property] boolean CharHidden;
 369
 370
 371     /** This property stores XML attributes. They will be saved to and restored
 372         from automatic styles inside XML files.
 373
 374         @see com::sun::star::xml::AttributeContainer
 375      */
 376     [optional, property] com::sun::star::container::XNameContainer  TextUserDefinedAttributes;
 377
 378     /** This property contains the left border of the object.
 379      *
 380      *  @since LibreOffice 4.2
 381     **/
 382     [property, optional] com::sun::star::table::BorderLine2 CharLeftBorder;
 383
 384     /** This property contains the right border of the object.
 385      *
 386      *  @since LibreOffice 4.2
 387     **/
 388     [property, optional] com::sun::star::table::BorderLine2 CharRightBorder;
 389
 390     /** This property contains the top border of the object.
 391      *
 392      *  @since LibreOffice 4.2
 393     **/
 394     [property, optional] com::sun::star::table::BorderLine2 CharTopBorder;
 395
 396     /** This property contains the bottom border of the object.
 397      *
 398      *  @since LibreOffice 4.2
 399     **/
 400     [property, optional] com::sun::star::table::BorderLine2 CharBottomBorder;
 401
 402     /** This property contains the distance from the border to the object.
 403      *
 404      *  @since LibreOffice 4.2
 405     **/
 406     [property, optional] long CharBorderDistance;
 407
 408     /** This property contains the distance from the left border to the object.
 409      *
 410      *  @since LibreOffice 4.2
 411     **/
 412     [property, optional] long CharLeftBorderDistance;
 413
 414     /** This property contains the distance from the right border to the object.
 415      *
 416      *  @since LibreOffice 4.2
 417     **/
 418     [property, optional] long CharRightBorderDistance;
 419
 420     /** This property contains the distance from the top border to the object.
 421      *
 422      *  @since LibreOffice 4.2
 423     **/
 424     [property, optional] long CharTopBorderDistance;
 425
 426     /** This property contains the distance from the bottom border to the object.
 427      *
 428      *  @since LibreOffice 4.2
 429     **/
 430     [property, optional] long CharBottomBorderDistance;
 431
 432     /** Determines the type, color, and width of the shadow.
 433      *
 434      *  @since LibreOffice 4.2
 435     **/
 436     [optional, property] com::sun::star::table::ShadowFormat CharShadowFormat;
 437
 438     /** Determines the color of the highlight.
 439      *
 440      *  @since LibreOffice 4.2
 441     **/
 442     [optional, property] com::sun::star::util::Color CharHighlight;
 443
 444     /** Grab bag of character properties, used as a string-any map for interim interop purposes.
 445
 446         @since LibreOffice 4.3
 447
 448         <p>This property is intentionally not handled by the ODF filter. Any
 449         member that should be handled there should be first moved out from this grab
 450         bag to a separate property.</p>
 451     */
 452     [optional, property] sequence<com::sun::star::beans::PropertyValue> CharInteropGrabBag;
 453
 454     /** This optional property determines the position of the ruby .
 455         @see com::sun::star::text::RubyPosition
 456         @since LibreOffice 6.1
 457      */
 458     [optional, property] short RubyPosition;
 459
 460     /** This is the transparency of the character text.
 461
 462         @since LibreOffice 7.0
 463
 464         <p>The value 100 means entirely transparent, while 0 means not transparent at all.</p>
 465     */
 466     [optional, property] short CharTransparence;
 467
 468     /** If available, keeps the color theme index, so that the character can
 469      *  be re-colored easily based on a theme.
 470      *
 471      *  @since LibreOffice 7.3
 472      **/
 473     [optional, property] short CharColorTheme;
 474
 475     /** Tint or shade of the character color.
 476      *
 477      *  @since LibreOffice 7.3
 478      **/
 479     [optional, property] short CharColorTintOrShade;
 480 };
 481
 482 }; }; }; };
 483
 484 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */