1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_FontDescriptor_idl__
24#define __com_sun_star_awt_FontDescriptor_idl__
25
26#ifndef __com_sun_star_awt_FontSlant_idl__
27#include <com/sun/star/awt/FontSlant.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module awt {
34
35//=============================================================================
36
37/** describes the characteristics of a font.
38
39	<p>For example, this can be used to select a font.</p>
40 */
41published struct FontDescriptor
42{
43	//-------------------------------------------------------------------------
44
45	/** specifies the exact name of the font.
46	 */
47	string Name;
48
49	//-------------------------------------------------------------------------
50
51	/** specifies the height of the font in the measure of the
52		destination.
53	 */
54	short Height;
55
56	//-------------------------------------------------------------------------
57
58	/** specifies the width of the font in the measure of the
59		destination.
60	 */
61	short Width;
62
63	//-------------------------------------------------------------------------
64
65	/** specifies the style name of the font.
66	 */
67	string StyleName;
68
69	//-------------------------------------------------------------------------
70
71	/** specifies the general style of the font.
72
73		<p>Use one value out of the constant group
74        <type scope="com::sun::star::awt">FontFamily</type>.</p>
75	 */
76	short Family;
77
78	//-------------------------------------------------------------------------
79
80	/** specifies the character set which is supported by the font.
81
82		<p>Use one value out of the constant group
83		<type scope="com::sun::star::awt">CharSet</type>.</p>
84	 */
85	short CharSet;
86
87	//-------------------------------------------------------------------------
88
89	/** specifies the pitch of the font.
90
91		<p>Use one value out of the constant group
92		<type scope="com::sun::star::awt">FontPitch</type>.</p>
93	 */
94	short Pitch;
95
96	//-------------------------------------------------------------------------
97
98	/** specifies the character width.
99
100		<p>Depending on the specified width, a font that supports this
101		width may be selected.</p>
102
103		<p>The value is expressed as a percentage.</p>
104	 */
105	float CharacterWidth;
106
107	//-------------------------------------------------------------------------
108
109	/** specifies the thickness of the line.
110
111		<p>Depending on the specified weight, a font that supports this
112        thickness may be selected.</p>
113
114		<p>The value is expressed as a percentage.</p>
115	 */
116	float Weight;
117
118	//-------------------------------------------------------------------------
119
120	/** specifies the slant of the font.
121	 */
122	com::sun::star::awt::FontSlant Slant;
123
124	//-------------------------------------------------------------------------
125
126	/** specifies the kind of underlining.
127
128        <p>Use one value out of the constant group
129        <type scope="com::sun::star::awt">FontUnderline</type>.</p>
130	 */
131	short Underline;
132
133	//-------------------------------------------------------------------------
134
135	/** specifies the kind of strikeout.
136
137        <p>Use one value out of the constant group
138        <type scope="com::sun::star::awt">FontStrikeout</type>.</p>
139	 */
140	short Strikeout;
141
142	//-------------------------------------------------------------------------
143
144	/** specifies the rotation of the font.
145
146		<p>The unit of measure is degrees; 0 is the baseline.</p>
147	 */
148	float Orientation;
149
150	//-------------------------------------------------------------------------
151
152	/** For requesting, it specifies if there is a kerning table available.
153		For selecting, it specifies if the kerning table is to be used.
154	 */
155	boolean Kerning;
156
157	//-------------------------------------------------------------------------
158
159	/** specifies if only words get underlined.
160
161		<p><TRUE/> means that only non-space characters get underlined,
162		<FALSE/> means that the spacing also gets underlined.</p>
163
164		<p>This property is only valid if the property
165		<member scope="com::sun::star::awt">FontDescriptor::Underline</member>
166        is not <const>FontUnderline::NONE</const>.</p>
167	 */
168	boolean WordLineMode;
169
170	//-------------------------------------------------------------------------
171
172	/** specifies the technology of the font representation.
173
174		<p>One or more values out of the constant group
175		<type scope="com::sun::star::awt">FontType</type> can be combined by
176        an arithmetical or-operation.</p>
177	 */
178	short Type;
179
180};
181
182//=============================================================================
183
184}; }; }; };
185
186#endif
187