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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: CharacterProperties.idl,v $
  10  * $Revision: 1.32 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_style_CharacterProperties_idl__
  31 #define __com_sun_star_style_CharacterProperties_idl__
  32
  33 #ifndef __com_sun_star_lang_Locale_idl__
  34 #include <com/sun/star/lang/Locale.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_FontSlant_idl__
  42 #include <com/sun/star/awt/FontSlant.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_container_XNameContainer_idl__
  46 #include <com/sun/star/container/XNameContainer.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module style {
  53
  54 //=============================================================================
  55
  56 /** This is a set of properties to describe the style of characters.@see ParagraphProperties
  57  */
  58 published service CharacterProperties
  59 {
  60     //-------------------------------------------------------------------------
  61
  62     /** This property specifies the name of the font style.
  63
  64         <p>It may contain more than one name separated by comma.</p>
  65      */
  66     [property] string CharFontName;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** This property contains the name of the font style.
  71
  72         <p>This property may be empty.</p>
  73      */
  74     [property] string CharFontStyleName;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** This property contains font family.
  79         @see com::sun::star::awt::FontFamily
  80      */
  81     [property] short CharFontFamily;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** This property contains the text encoding of the font.
  86         @see com::sun::star::awt::CharSet
  87      */
  88     [property] short CharFontCharSet;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** This property contains the font pitch.
  93         @see com::sun::star::awt::FontPitch
  94      */
  95     [property] short CharFontPitch;
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** This property contains the value of the text color.
 100      */
 101     [property] com::sun::star::util::Color CharColor;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** specifies the percentage of raisement/lowerment of superscript/subscript
 106         characters.
 107
 108         <p>Negative values denote subscripts and positive values superscripts.</p>
 109
 110         @see CharEscapementHeight
 111      */
 112     [optional, property] short CharEscapement;
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** This value contains the height of the characters in point.
 117      */
 118     [property] float CharHeight;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** This property contains the value for the character underline.
 123         @see com::sun::star::awt::FontUnderline
 124      */
 125     [property] short CharUnderline;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** This property contains the value of the font weight.
 130         @see com::sun::star::awt::FontWeight
 131      */
 132     [property] float CharWeight;
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** This property contains the value of the posture of the document.
 137         @see com::sun::star::awt::FontSlant
 138      */
 139     [property] com::sun::star::awt::FontSlant CharPosture;
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** This optional property determines whether the kerning tables from the
 144         current font are used.
 145
 146         <p>Automatic <em>kerning</em> applies a spacing in between certain
 147         pairs of characters to make the text look better.</p>
 148      */
 149     [optional, property] boolean CharAutoKerning;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** This optional property contains the text background color.
 154      */
 155     [optional, property] com::sun::star::util::Color CharBackColor;
 156
 157     //-------------------------------------------------------------------------
 158
 159     /** This property determines if the text background color is set to
 160         transparent.
 161      */
 162     [optional, property] boolean CharBackTransparent;
 163
 164     //-------------------------------------------------------------------------
 165
 166     /** This optional property contains the value of the case-mapping of the
 167         text for formatting and displaying.
 168
 169         @see CaseMap
 170      */
 171     [optional, property] short CharCaseMap;
 172
 173     //-------------------------------------------------------------------------
 174
 175     /** This property is <TRUE/> if the characters are crossed out.
 176      */
 177     [optional, property] boolean CharCrossedOut;
 178
 179     //-------------------------------------------------------------------------
 180
 181     /** If this optional property is <TRUE/>, then the characters are flashing.
 182      */
 183     [optional, property] boolean CharFlash;
 184
 185     //-------------------------------------------------------------------------
 186
 187     /** This property determins the type of the strike out of the character.
 188         @see com::sun::star::awt::FontStrikeout
 189     */
 190     [optional, property] short CharStrikeout;
 191
 192     //-------------------------------------------------------------------------
 193
 194     /** If this property is <TRUE/>, the underline and strike-through
 195         properties are not applied to white spaces.
 196      */
 197     [optional, property] boolean CharWordMode;
 198
 199     //-------------------------------------------------------------------------
 200
 201     /** This optional property contains the value of the kerning of the
 202         characters.
 203      */
 204     [optional, property] short CharKerning;
 205
 206     //-------------------------------------------------------------------------
 207
 208     /** This property contains the value of the locale.
 209      */
 210     [property] com::sun::star::lang::Locale CharLocale;
 211
 212    //-------------------------------------------------------------------------
 213
 214     /** This optional property marks a range of characters to prevent it from
 215         being broken into two lines.
 216
 217         <p> A line break is applied before the range of characters if
 218         the layout makes a break necessary within the range.</p>
 219     */
 220     [optional, property] boolean CharKeepTogether;
 221
 222     //-------------------------------------------------------------------------
 223
 224     /** This optional property marks a range of characters to ignore a line
 225         break in this area.
 226
 227         <p> A line break is applied behind the range of characters if
 228         the layout makes a break necessary within the range. That means that
 229         the text may go through the border.</p>
 230      */
 231     [optional, property] boolean CharNoLineBreak;
 232
 233     //-------------------------------------------------------------------------
 234
 235     /** This optional property specifies if the characters are formatted and
 236         displayed with a shadow effect.
 237      */
 238     [optional, property] boolean CharShadowed;
 239
 240     //-------------------------------------------------------------------------
 241
 242     /** This optional property specifies the fundamental technology of the font.
 243         @see com::sun::star::awt::FontType
 244      */
 245     [optional, property] short CharFontType;
 246
 247     //-------------------------------------------------------------------------
 248
 249     /** This optional property specifies the name of the style of the font.
 250      */
 251     [optional, property] string CharStyleName;
 252
 253     //-------------------------------------------------------------------------
 254
 255     /** This optional property specifies if the characters are formatted and
 256         displayed with a contour effect.
 257      */
 258     [optional, property] boolean CharContoured;
 259
 260     //-------------------------------------------------------------------------
 261
 262     /** This optional property determins whether text is formatted in two lines.
 263
 264         <p>It is linked to the properties CharCombinePrefix and CharCombineSuffix.</p>
 265      */
 266     [optional, property] boolean CharCombineIsOn;
 267
 268     //-------------------------------------------------------------------------
 269
 270     /** This optional property contains the prefix (usually parenthesis) before
 271         text that is formatted in two lines.
 272
 273         <p>It is linked to the properties CharCombineIsOn and CharCombineSuffix.</p>
 274      */
 275     [optional, property] string CharCombinePrefix;
 276
 277     //-------------------------------------------------------------------------
 278
 279     /** This optional property contains the suffix (usually parenthesis) after
 280         text that is formatted in two lines.
 281
 282         <p>It is linked to the properties CharCombineIsOn and CharCombinePrefix.</p>
 283      */
 284     [optional, property] string CharCombineSuffix;
 285
 286     //-------------------------------------------------------------------------
 287
 288     /** This optional property contains the font emphasis value.
 289         @see com::sun::star::text::FontEmphasis
 290      */
 291     [optional, property] short CharEmphasis;
 292
 293     //-------------------------------------------------------------------------
 294
 295     /** This optional property contains the relief style of the characters.
 296         @see com::sun::star::text::FontRelief
 297      */
 298     [optional, property] short CharRelief;
 299
 300     //-------------------------------------------------------------------------
 301
 302     /** This optional property contains the text that is set as ruby.
 303      */
 304     [optional, property] string RubyText;
 305
 306     //-------------------------------------------------------------------------
 307
 308     /** This optional property determins the adjustment of the ruby .
 309         @see com::sun::star::text::RubyAdjust
 310      */
 311     [optional, property] short RubyAdjust;
 312
 313     //-------------------------------------------------------------------------
 314
 315     /** This optional property contains the name of the character style that is
 316         applied to RubyText.
 317      */
 318     [optional, property] string RubyCharStyleName;
 319
 320     //-------------------------------------------------------------------------
 321
 322     /** This optional property determins whether the ruby text is printed
 323         above/left or below/right of the text.
 324      */
 325     [optional, property] boolean RubyIsAbove;
 326
 327     //-------------------------------------------------------------------------
 328
 329     /** This optional property determins the rotation of a character in tenths
 330         of a degree.
 331
 332        <p>Depending on the implementation only certain values may be allowed.</p>
 333      */
 334     [optional, property] short CharRotation;
 335
 336     //-------------------------------------------------------------------------
 337
 338     /** This optional property determins whether the text formatting tries to
 339         fit rotated text into the surrounded line height.
 340      */
 341     [optional, property] boolean CharRotationIsFitToLine;
 342
 343     //-------------------------------------------------------------------------
 344
 345     /** This optional property determins the percentage value for scaling the
 346         width of characters.
 347
 348         <p>The value refers to the original width which is denoted by 100,
 349         and it has to be greater than 0.</p>
 350    */
 351     [optional, property] short CharScaleWidth;
 352
 353     //-------------------------------------------------------------------------
 354
 355     /** This optional property contains the URL of a hyperlink.
 356      */
 357     [optional, property] string HyperLinkURL;
 358
 359     //-------------------------------------------------------------------------
 360
 361     /** This optional property contains the name of the target for a hyperlink.
 362      */
 363     [optional, property] string HyperLinkTarget;
 364
 365     //-------------------------------------------------------------------------
 366
 367     /** This optional property contains the name of the hyperlink.
 368      */
 369     [optional, property] string HyperLinkName;
 370
 371     //-------------------------------------------------------------------------
 372
 373     /** This optional property contains the character style name for visited
 374         hyperlinks.
 375      */
 376     [optional, property] string VisitedCharStyleName;
 377
 378     //-------------------------------------------------------------------------
 379
 380     /** This optional property contains the character style name for unvisited
 381         hyperlinks.
 382      */
 383     [optional, property] string UnvisitedCharStyleName;
 384
 385     //-------------------------------------------------------------------------
 386
 387     /** This is the relative height used for subscript or superscript
 388         characters in units of percent.
 389
 390         <p>The value 100 denotes the original height of the characters.</p>
 391
 392         @see CharEscapement
 393      */
 394     [optional, property] byte CharEscapementHeight;
 395
 396     //-------------------------------------------------------------------------
 397
 398     /** This optional property determines if the word can be hyphenated at the
 399         character.
 400      */
 401     [optional, property] boolean CharNoHyphenation;
 402
 403     //-------------------------------------------------------------------------
 404
 405     /** This property contains the color of the underline for the characters.
 406         @see CharUnderlineHasColor
 407      */
 408     [property] com::sun::star::util::Color CharUnderlineColor;
 409
 410     //-------------------------------------------------------------------------
 411
 412     /** This property specifies if the property CharUnderlineColor is used for
 413         an underline.
 414         @see CharUnderlineColor
 415      */
 416     [property] boolean CharUnderlineHasColor;
 417
 418     //-------------------------------------------------------------------------
 419
 420     /** This optional property specifies the names of the all styles applied to
 421         the font.
 422
 423         <p> It is not guaranteed that the order in the sequence reflects
 424         the order of the evaluation of the character style attributes.</p>
 425
 426         @since OOo 1.1.2
 427      */
 428     [optional, property] sequence<string> CharStyleNames;
 429
 430     //-------------------------------------------------------------------------
 431
 432     /** If this optional property is <TRUE/>, then the characters are invisible.
 433
 434         @since OOo 2.0.0
 435      */
 436     [optional, property] boolean CharHidden;
 437
 438     //-------------------------------------------------------------------------
 439
 440     /** This property stores XML attributes. They will be saved to and restored
 441         from automatic styles inside XML files.
 442
 443         @see com::sun::star::xml::AttributeContainer
 444      */
 445     [optional, property] com::sun::star::container::XNameContainer  TextUserDefinedAttributes;
 446
 447 };
 448
 449 //=============================================================================
 450 }; }; }; };
 451
 452 #endif
 453