/************************************************************************* * * $RCSfile: CharacterProperties.idl,v $ * * $Revision: 1.25 $ * * last change: $Author: kz $ $Date: 2004-05-19 10:42:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (the "License"); You may not use this file * except in compliance with the License. You may obtain a copy of the * License at http://www.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __com_sun_star_style_CharacterProperties_idl__ #define __com_sun_star_style_CharacterProperties_idl__ #ifndef __com_sun_star_lang_Locale_idl__ #include #endif #ifndef __com_sun_star_util_Color_idl__ #include #endif #ifndef __com_sun_star_awt_FontSlant_idl__ #include #endif //============================================================================= module com { module sun { module star { module style { //============================================================================= /** This is a set of properties to describe the style of characters.@see ParagraphProperties */ service CharacterProperties { //------------------------------------------------------------------------- /** This property specifies the name of the font style.

It may contain more than one name separated by comma.

*/ [property] string CharFontName; //------------------------------------------------------------------------- /** This property contains the name of the font style.

This property may be empty.

*/ [property] string CharFontStyleName; //------------------------------------------------------------------------- /** This property contains font family as specified in com.sun.star.awt.FontFamily . */ [property] short CharFontFamily; //------------------------------------------------------------------------- /** This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. */ [property] short CharFontCharSet; //------------------------------------------------------------------------- /** This property contains the font pitch as specified in com.sun.star.awt.FontPitch. */ [property] short CharFontPitch; //------------------------------------------------------------------------- /** This property contains the value of the text color. */ [property] com::sun::star::util::Color CharColor; //------------------------------------------------------------------------- /** specifies the percentage of raisement/lowerment of superscript/subscript characters.

Negative values denote subscripts and positive values superscripts.

*/ [optional, property] short CharEscapement; //------------------------------------------------------------------------- /** This value contains the height of the characters in point. */ [property] float CharHeight; //------------------------------------------------------------------------- /** This property contains the value for the character underline.@see com::sun::star::awt::FontUnderline */ [property] short CharUnderline; //------------------------------------------------------------------------- /** This property contains the value of the font weight.@see com::sun::star::awt::FontWeight */ [property] float CharWeight; //------------------------------------------------------------------------- /** This property contains the value of the posture of the document.@see com::sun::star::awt::FontSlant */ [property] com::sun::star::awt::FontSlant CharPosture; //------------------------------------------------------------------------- /** optional property to determine whether the kerning tables from the current font are used.

Automatic kerning applies a spacing in between certain pairs of characters to make the text look better.

*/ [optional, property] boolean CharAutoKerning; //------------------------------------------------------------------------- /** optional property which contains the text background color. */ [optional, property] com::sun::star::util::Color CharBackColor; //------------------------------------------------------------------------- /** determines if the text background color is set to transparent. */ [optional, property] boolean CharBackTransparent; //------------------------------------------------------------------------- /** optional property which contains the value of the case-mapping of the text for formatting and displaying. @see CaseMap */ [optional, property] short CharCaseMap; //------------------------------------------------------------------------- /** This property is if the character(s) is(are) crossed out. */ [optional, property] boolean CharCrossedOut; //------------------------------------------------------------------------- /** If this optional property is , then the characters are flashing. */ [optional, property] boolean CharFlash; //------------------------------------------------------------------------- /** determins the type of the strike out of the character. @see com.sun.star.awt.FontStrikeout */ [optional, property] short CharStrikeout; //------------------------------------------------------------------------- /** If this property is , the underline and strike-through properties are not applied to white spaces. */ [optional, property] boolean CharWordMode; //------------------------------------------------------------------------- /** optional property which contains the value of the kerning of the characters. */ [optional, property] short CharKerning; //------------------------------------------------------------------------- /** contains the value of the locale. */ [property] com::sun::star::lang::Locale CharLocale; //------------------------------------------------------------------------- /** optional property which marks a range of characters to prevent it from being broken into two lines.

A line break is applied before the range of characters if the layout makes a break necessary within the range.

*/ [optional, property] boolean CharKeepTogether; //------------------------------------------------------------------------- /** optional property which marks a range of characters to ignore a line break in this area.

A line break is applied behind the range of characters if the layout makes a break necessary within the range. That means that the text may go through the border.

*/ [optional, property] boolean CharNoLineBreak; //------------------------------------------------------------------------- /** specifies if the characters are formatted and displayed with a shadow effect. */ [optional, property] boolean CharShadowed; //------------------------------------------------------------------------- /** optional property which specifies the fundamental technology of the font. @see com::sun::star::awt::FontType */ [optional, property] short CharFontType; //------------------------------------------------------------------------- /** specifies the name of the style of the font. */ [optional, property] string CharStyleName; //------------------------------------------------------------------------- /** specifies if the characters are formatted and displayed with a contour effect. */ [optional, property] boolean CharContoured; //------------------------------------------------------------------------- /** determins whether text is formatted in two lines.

It is linked to the properties CharCombinePrefix and CharCombineSuffix.

*/ [optional, property] boolean CharCombineIsOn; //------------------------------------------------------------------------- /** contains the prefix (usually parenthesis) before text that is formatted in two lines.

It is linked to the properties CharCombineIsOn and CharCombineSuffix.

*/ [optional, property] string CharCombinePrefix; //------------------------------------------------------------------------- /** contains the suffix (usually parenthesis) after text that is formatted in two lines.

It is linked to the properties CharCombineIsOn and CharCombinePrefix.

*/ [optional, property] string CharCombineSuffix; //------------------------------------------------------------------------- /** contains the font emphasis value as FontEmphasis. */ [optional, property] short CharEmphasis; //------------------------------------------------------------------------- /** contains the relief value as FontRelief. */ [optional, property] short CharRelief; //------------------------------------------------------------------------- /** contains the text that is set as ruby. */ [optional, property] string RubyText; //------------------------------------------------------------------------- /** determins the adjustment of the ruby text as RubyAdjust. */ [optional, property] short RubyAdjust; //------------------------------------------------------------------------- /** contains the name of the character style that is applied to RubyText. */ [optional, property] string RubyCharStyleName; //------------------------------------------------------------------------- /** determins whether the ruby text is printed above/left or below/right of the text. */ [optional, property] boolean RubyIsAbove; //------------------------------------------------------------------------- /** determins the rotation of a character in degree.

Depending on the implementation only certain values may be allowed.

*/ [optional, property] short CharRotation; //------------------------------------------------------------------------- /** determins whether the text formatting tries to fit rotated text into the surrounded line height. */ [optional, property] boolean CharRotationIsFitToLine; //------------------------------------------------------------------------- /** determins the percentage value for scaling the width of characters.

The value refers to the original width which is denoted by 100, and it has to be greater than 0.

*/ [optional, property] short CharScaleWidth; //------------------------------------------------------------------------- /** contains the URL of a hyperlink (if set). */ [optional, property] string HyperLinkURL; //------------------------------------------------------------------------- /** contains the name of the target for a hyperlink (if set). */ [optional, property] string HyperLinkTarget; //------------------------------------------------------------------------- /** contains the name of the hyperlink (if set). */ [optional, property] string HyperLinkName; //-------------------------------------------------------------------- /** contains the character style name for visited hyperlinks. */ [optional, property] string VisitedCharStyleName; //-------------------------------------------------------------------- /** contains the character style name for unvisited hyperlinks. */ [optional, property] string UnvisitedCharStyleName; //------------------------------------------------------------------------- /** This is the additional height used for subscript or superscript characters in units of percent. For subscript characters the value is negative and for superscript characters positive. */ [optional, property] byte CharEscapementHeight; //------------------------------------------------------------------------- /** determines if the word can be hyphenated at the character. */ [optional, property] boolean CharNoHyphenation; //------------------------------------------------------------------------- /** gives the color of the underline for that character. */ [property] com::sun::star::util::Color CharUnderlineColor; //------------------------------------------------------------------------- /** specifies if the CharUnderlineColor is used for an underline. */ [property] boolean CharUnderlineHasColor; //------------------------------------------------------------------------- /** specifies the names of the all styles applied to the font.

It is not guaranteed that the order in the sequence reflects the order of the evaluation of the character style attributes.

@since #107627# */ [optional, property] sequence CharStyleNames; //------------------------------------------------------------------------- /** If this optional property is , then the characters are invisible. @since #i23614# */ [optional, property] boolean CharHidden; }; //============================================================================= }; }; }; }; #endif