File: mdraw_coordinates_position.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 (141 lines) | stat: -rw-r--r-- 2,952 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
.\" 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 "mdraw_coordinates_position" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mdraw_coordinates_position \- Return the character position nearest to the coordinates. 


.SH SYNOPSIS
int
\fBmdraw_coordinates_position\fP (\fBMFrame\fP *
\fIframe\fP, \fBMText\fP *
\fImt\fP, int
\fIfrom\fP, int
\fIto\fP, int
\fIx_offset\fP, int
\fIy_offset\fP, \fBMDrawControl\fP *
\fIcontrol\fP)


.SH DESCRIPTION
Return the character position nearest to the coordinates. The
.ft B
mdraw_coordinates_position()
.ft R
function checks which character is to be drawn at coordinate (\fBx\fP,
.ft R
.ft B
y\fP) when the text between
.ft B
from
.ft R
and
.ft B
to
.ft R
of M\-text
.ft B
mt
.ft R
is drawn at the coordinate (0, 0) using the
.ft B
mdraw_text_with_control()
.ft R
function with the drawing control object
.ft B
control\fP.
.ft R
Here, the character position means the number of characters that precede the character in question in
.ft B
mt\fP,
.ft R
that is, the character position of the first character is 0.
.PP
\fBframe
.ft R
is used only to get the default face information.
.PP
.SH RETURN VALUE
.PP
.RS 4
If the glyph image of a character covers coordinate (\fBx\fP,
.ft R
.ft B
y\fP),
.ft B
mdraw_coordinates_position()
.ft R
returns the character position of that character.
.br

.br
 If
.ft B
y
.ft R
is less than the minimum Y\-coordinate of the drawn area, it returns
.ft B
from\fP.
.ft R
.br

.br
 If
.ft B
y
.ft R
is greater than the maximum Y\-coordinate of the drawn area, it returns
.ft B
to\fP.
.ft R
.br

.br
 If
.ft B
y
.ft R
fits in with the drawn area but
.ft B
x
.ft R
is less than the minimum X\-coordinate, it returns the character position of the first character drawn on the line
.ft B
y\fP.
.ft R
.br

.br
 If
.ft B
y
.ft R
fits in with the drawn area but
.ft B
x
.ft R
is greater than the maximum X\-coordinate, it returns the character position of the last character drawn on the line
.ft B
y\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>.