summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/FontDescriptor.idl
blob: 7c721531f79727759e4300eecb9477606793d002 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: FontDescriptor.idl,v $
 * $Revision: 1.12 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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