File: mfont_get_prop.3m17n

package info (click to toggle)
m17n-docs 1.6.2-2
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 22,492 kB
  • ctags: 1,495
  • sloc: sh: 1,032; makefile: 406; ansic: 206; perl: 108
file content (180 lines) | stat: -rw-r--r-- 2,744 bytes parent folder | download | duplicates (3)
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
.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mfont_get_prop" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mfont_get_prop \- Get a property value of a font. 


.SH SYNOPSIS
void*
\fBmfont_get_prop\fP (\fBMFont\fP *
\fIfont\fP, \fBMSymbol\fP
\fIkey\fP)


.SH DESCRIPTION
Get a property value of a font. The
.ft B
mfont_get_prop()
.ft R
function gets the value of
.ft B
key
.ft R
property of font
.ft B
font\fP.
.ft R
.ft B
key
.ft R
must be one of the following symbols:
.PP
\fCMfoundry\fP,
.ft R
.ft C
Mfamily\fP,
.ft R
.ft C
Mweight\fP,
.ft R
.ft C
Mstyle\fP,
.ft R
.ft C
Mstretch\fP,
.ft R
.ft C
Madstyle\fP,
.ft R
.ft C
Mregistry\fP,
.ft R
.ft C
Msize\fP,
.ft R
.ft C
Mresolution\fP,
.ft R
.ft C
Mspacing\fP.
.ft R
.PP
If
.ft B
font
.ft R
is a return value of
.ft B
mfont_find()\fP,
.ft R
.ft B
key
.ft R
can also be one of the following symbols:
.PP
\fBMfont_ascent\fP,
.ft R
.ft B
Mfont_descent\fP,
.ft R
.ft B
Mmax_advance\fP.
.ft R
.PP
.SH RETURN VALUE
.PP
.RS 4
If
.ft B
key
.ft R
is
.ft C
Mfoundry\fP,
.ft R
.ft C
Mfamily\fP,
.ft R
.ft C
Mweight\fP,
.ft R
.ft C
Mstyle\fP,
.ft R
.ft C
Mstretch\fP,
.ft R
.ft C
Madstyle\fP,
.ft R
.ft C
Mregistry\fP,
.ft R
or
.ft C
Mspacing\fP,
.ft R
this function returns the corresponding value as a symbol. If the font does not have
.ft B
key
.ft R
property, it returns
.ft C
Mnil\fP.
.ft R
If
.ft B
key
.ft R
is
.ft C
Msize\fP,
.ft R
.ft C
Mresolution\fP,
.ft R
.ft B
Mfont_ascent\fP,
.ft R
Mfont_descent, or
.ft B
Mmax_advance\fP,
.ft R
this function returns the corresponding value as an integer. If the font does not have
.ft B
key
.ft R
property, it returns 0. If
.ft B
key
.ft R
is something else, it returns
.ft C
NULL
.ft R
and assigns an error code to the external variable
.ft B
merror_code\fP.
.ft R
.RE
.PP

.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.