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
|
.\" 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 "mface_put_prop" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mface_put_prop \- Set a value of a face property.
.SH SYNOPSIS
int
\fBmface_put_prop\fP (\fBMFace\fP *
\fIface\fP, \fBMSymbol\fP
\fIkey\fP, void *
\fIval\fP)
.SH DESCRIPTION
Set a value of a face property. The
.ft B
mface_put_prop()
.ft R
function assigns
.ft B
val
.ft R
to the property whose key is
.ft B
key
.ft R
in face
.ft B
face\fP.
.ft R
.ft B
key
.ft R
must be one the followings:
.PP
\fBMforeground\fP,
.ft R
.ft B
Mbackground\fP,
.ft R
.ft B
Mvideomode\fP,
.ft R
.ft B
Mhline\fP,
.ft R
.ft B
Mbox\fP,
.ft R
.ft B
Mfoundry\fP,
.ft R
.ft B
Mfamily\fP,
.ft R
.ft B
Mweight\fP,
.ft R
.ft B
Mstyle\fP,
.ft R
.ft B
Mstretch\fP,
.ft R
.ft B
Madstyle\fP,
.ft R
.ft B
Msize\fP,
.ft R
.ft B
Mfontset\fP,
.ft R
.ft B
Mratio\fP,
.ft R
.ft B
Mhook_func\fP,
.ft R
.ft B
Mhook_arg
.ft R
.PP
Among them, font related properties (\fBMfoundry
.ft R
through
.ft B
Msize\fP) are used as the default values when a font in the fontset of
.ft B
face
.ft R
does not specify those values.
.PP
The actual type of the returned value depends of
.ft B
key\fP.
.ft R
See documentation of the above keys.
.PP
.SH RETURN VALUE
.PP
.RS 4
If the operation was successful,
.ft B
mface_put_prop()
.ft R
returns 0. Otherwise it returns \-1 and assigns an error code to the external variable
.ft B
merror_code\fP.
.ft R
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmface_get_prop()
.ft R
.RE
.PP
.SH ERRORS
.PP
.RS 4
\fCMERROR_FACE
.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>.
|
