office-gobmx/offapi/com/sun/star/awt/FontDescriptor.idl
Oliver Bolte 6e47de5ebc INTEGRATION: CWS sb18 (1.9.250); FILE MERGED
2004/05/21 14:55:26 sb 1.9.250.1: #i21150# Added published flag.
2004-06-03 16:04:56 +00:00

224 lines
7.2 KiB
Text

/*************************************************************************
*
* $RCSfile: FontDescriptor.idl,v $
*
* $Revision: 1.10 $
*
* last change: $Author: obo $ $Date: 2004-06-03 17:04:56 $
*
* 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_awt_FontDescriptor_idl__
#define __com_sun_star_awt_FontDescriptor_idl__
#ifndef __com_sun_star_awt_FontSlant_idl__
#include <com/sun/star/awt/FontSlant.idl>
#endif
//=============================================================================
module com { module sun { module star { module awt {
//=============================================================================
/** describes the characteristics of a font.
<p>For example, this can be used to select a font.</p>
*/
published struct FontDescriptor
{
//-------------------------------------------------------------------------
/** specifies the exact name of the font.
*/
string Name;
//-------------------------------------------------------------------------
/** specifies the height of the font in the measure of the
destination.
*/
short Height;
//-------------------------------------------------------------------------
/** specifies the width of the font in the measure of the
destination.
*/
short Width;
//-------------------------------------------------------------------------
/** specifies the style name of the font.
*/
string StyleName;
//-------------------------------------------------------------------------
/** specifies the general style of the font.
<p>Use one value out of the constant group
<type scope="com::sun::star::awt">FontFamily</type>.</p>
*/
short Family;
//-------------------------------------------------------------------------
/** specifies the character set which is supported by the font.
<p>Use one value out of the constant group
<type scope="com::sun::star::awt">CharSet</type>.</p>
*/
short CharSet;
//-------------------------------------------------------------------------
/** specifies the pitch of the font.
<p>Use one value out of the constant group
<type scope="com::sun::star::awt">FontPitch</type>.</p>
*/
short Pitch;
//-------------------------------------------------------------------------
/** specifies the character width.
<p>Depending on the specified width, a font that supports this
width may be selected.</p>
<p>The value is expressed as a percentage.</p>
*/
float CharacterWidth;
//-------------------------------------------------------------------------
/** specifies the thickness of the line.
<p>Depending on the specified weight, a font that supports this
thickness may be selected.</p>
<p>The value is expressed as a percentage.</p>
*/
float Weight;
//-------------------------------------------------------------------------
/** specifies the slant of the font.
*/
com::sun::star::awt::FontSlant Slant;
//-------------------------------------------------------------------------
/** specifies the kind of underlining.
<p>Use one value out of the constant group
<type scope="com::sun::star::awt">FontUnderline</type>.</p>
*/
short Underline;
//-------------------------------------------------------------------------
/** specifies the kind of strikeout.
<p>Use one value out of the constant group
<type scope="com::sun::star::awt">FontStrikeout</type>.</p>
*/
short Strikeout;
//-------------------------------------------------------------------------
/** specifies the rotation of the font.
<p>The unit of measure is degrees; 0 is the baseline.</p>
*/
float Orientation;
//-------------------------------------------------------------------------
/** For requesting, it specifies if there is a kerning table available.
For selecting, it specifies if the kerning table is to be used.
*/
boolean Kerning;
//-------------------------------------------------------------------------
/** specifies if only words get underlined.
<p><TRUE/> means that only non-space characters get underlined,
<FALSE/> means that the spacing also gets underlined.</p>
<p>This property is only valid if the property
<member scope="com::sun::star::awt">FontDescriptor::Underline</member>
is not <const>FontUnderline::NONE</const>.</p>
*/
boolean WordLineMode;
//-------------------------------------------------------------------------
/** specifies the technology of the font representation.
<p>One or more values out of the constant group
<type scope="com::sun::star::awt">FontType</type> can be combined by
an arithmetical or-operation.</p>
*/
short Type;
};
//=============================================================================
}; }; }; };
#endif