offapi/com/sun/star/awt/FontDescriptor.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: FontDescriptor.idl,v $
  10  * $Revision: 1.12 $
  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_awt_FontDescriptor_idl__
  31 #define __com_sun_star_awt_FontDescriptor_idl__
  32
  33 #ifndef __com_sun_star_awt_FontSlant_idl__
  34 #include <com/sun/star/awt/FontSlant.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** describes the characteristics of a font.
  45
  46     <p>For example, this can be used to select a font.</p>
  47  */
  48 published struct FontDescriptor
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** specifies the exact name of the font.
  53      */
  54     string Name;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** specifies the height of the font in the measure of the
  59         destination.
  60      */
  61     short Height;
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** specifies the width of the font in the measure of the
  66         destination.
  67      */
  68     short Width;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** specifies the style name of the font.
  73      */
  74     string StyleName;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** specifies the general style of the font.
  79
  80         <p>Use one value out of the constant group
  81         <type scope="com::sun::star::awt">FontFamily</type>.</p>
  82      */
  83     short Family;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** specifies the character set which is supported by the font.
  88
  89         <p>Use one value out of the constant group
  90         <type scope="com::sun::star::awt">CharSet</type>.</p>
  91      */
  92     short CharSet;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** specifies the pitch of the font.
  97
  98         <p>Use one value out of the constant group
  99         <type scope="com::sun::star::awt">FontPitch</type>.</p>
 100      */
 101     short Pitch;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** specifies the character width.
 106
 107         <p>Depending on the specified width, a font that supports this
 108         width may be selected.</p>
 109
 110         <p>The value is expressed as a percentage.</p>
 111      */
 112     float CharacterWidth;
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** specifies the thickness of the line.
 117
 118         <p>Depending on the specified weight, a font that supports this
 119         thickness may be selected.</p>
 120
 121         <p>The value is expressed as a percentage.</p>
 122      */
 123     float Weight;
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** specifies the slant of the font.
 128      */
 129     com::sun::star::awt::FontSlant Slant;
 130
 131     //-------------------------------------------------------------------------
 132
 133     /** specifies the kind of underlining.
 134
 135         <p>Use one value out of the constant group
 136         <type scope="com::sun::star::awt">FontUnderline</type>.</p>
 137      */
 138     short Underline;
 139
 140     //-------------------------------------------------------------------------
 141
 142     /** specifies the kind of strikeout.
 143
 144         <p>Use one value out of the constant group
 145         <type scope="com::sun::star::awt">FontStrikeout</type>.</p>
 146      */
 147     short Strikeout;
 148
 149     //-------------------------------------------------------------------------
 150
 151     /** specifies the rotation of the font.
 152
 153         <p>The unit of measure is degrees; 0 is the baseline.</p>
 154      */
 155     float Orientation;
 156
 157     //-------------------------------------------------------------------------
 158
 159     /** For requesting, it specifies if there is a kerning table available.
 160         For selecting, it specifies if the kerning table is to be used.
 161      */
 162     boolean Kerning;
 163
 164     //-------------------------------------------------------------------------
 165
 166     /** specifies if only words get underlined.
 167
 168         <p><TRUE/> means that only non-space characters get underlined,
 169         <FALSE/> means that the spacing also gets underlined.</p>
 170
 171         <p>This property is only valid if the property
 172         <member scope="com::sun::star::awt">FontDescriptor::Underline</member>
 173         is not <const>FontUnderline::NONE</const>.</p>
 174      */
 175     boolean WordLineMode;
 176
 177     //-------------------------------------------------------------------------
 178
 179     /** specifies the technology of the font representation.
 180
 181         <p>One or more values out of the constant group
 182         <type scope="com::sun::star::awt">FontType</type> can be combined by
 183         an arithmetical or-operation.</p>
 184      */
 185     short Type;
 186
 187 };
 188
 189 //=============================================================================
 190
 191 }; }; }; };
 192
 193 #endif