summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/FontDescriptor.idl
blob: 3e83889e0346e11ad83de2ec8b974aba2e9f6e52 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_awt_FontDescriptor_idl__
#define __com_sun_star_awt_FontDescriptor_idl__

#include <com/sun/star/awt/FontSlant.idl>



 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
        com::sun::star::awt::FontFamily.</p>
     */
    short Family;


    /** specifies the character set which is supported by the font.

        <p>Use one value out of the constant group
        com::sun::star::awt::CharSet.</p>
     */
    short CharSet;


    /** specifies the pitch of the font.

        <p>Use one value out of the constant group
        com::sun::star::awt::FontPitch.</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
        com::sun::star::awt::FontUnderline.</p>
     */
    short Underline;


    /** specifies the kind of strikeout.

        <p>Use one value out of the constant group
        com::sun::star::awt::FontStrikeout.</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
        com::sun::star::awt::FontDescriptor::Underline
        is not FontUnderline::NONE.</p>
     */
    boolean WordLineMode;


    /** specifies the technology of the font representation.

        <p>One or more values out of the constant group
        com::sun::star::awt::FontType can be combined by
        an arithmetical or-operation.</p>
     */
    short Type;

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */