summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/FontDescriptor.idl
blob: 79470c7e657b71a9162500e0daaa26a3571252d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/*************************************************************************
 *
 *  $RCSfile: FontDescriptor.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:21:05 $
 *
 *  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 {

//=============================================================================

// DocMerge from xml: struct com::sun::star::awt::FontDescriptor
/** describes the characteristics of a font.



    <p>For example, this can be used to select a font.</p>
 */
struct FontDescriptor
{
    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Name
    /** specifies the exact name of the font ("Arial",
        "Courier", "Frutiger").
     */
    string Name;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Height
    /** specifies the height of the font in the measure of the
        destination.
     */
    short Height;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Width
    /** specifies the width of the font in the measure of the
        destination.
     */
    short Width;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::StyleName
    /** specifies the style name of the font ("Bold", "Fett", "Italic
        Bold").
     */
    string StyleName;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Family
    /** specifies the general style of the font.



        <p>Use one value out of the constant group
        <type>FontFamily</type>.</p>
     */
    short Family;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::CharSet
    /** 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;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Pitch
    /** 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;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::CharacterWidth
    /** 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;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Weight
    /** 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;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Slant
    /** specifies if there is a character slant (italic).
     */
    com::sun::star::awt::FontSlant Slant;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Underline
    /** use one value out of the constant group <type>FontUnderline</type>.
     */
    short Underline;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Strikeout
    /** use one value out of the constant group <type scope="com::sun::star::awt">FontStrikeout</type>.
     */
    short Strikeout;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Orientation
    /** specifies the rotation of the font.



        <p>The unit of measure is degrees; 0 is the baseline.</p>
     */
    float Orientation;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Kerning
    /** 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;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::WordLineMode
    /** specifies if only words get underlined.



        <p>
        <true></true> means that only non-space characters get underlined,
        <false></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;

    //-------------------------------------------------------------------------

    // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Type
    /** 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;

};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:34:49  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:04  mi
    documentation merged from XML

    Revision 1.3  2000/02/21 16:17:46  mi
    string documentation from stardiv...*.idl-files

    Revision 1.2  2000/02/07 11:24:11  mi
    zu #70728# missing documentation marked

    Revision 1.1.1.1  1999/11/11 09:48:40  jsc
    new


=============================================================================*/
#endif