.\" 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>.