- dinates from stdscr-relative coordinates to screen-rela-
- tive coordinates or vice versa. Please remember, that
- stdscr-relative coordinates are not always identical to
- screen-relative coordinates due to the mechanism to
- reserve lines on top or bottom of the screen for other
- purposes (ripoff() call, see also slk_... functions). If
- the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must
- reference the coordinates of a location inside the window
- <STRONG>win</STRONG>. They are converted to screen-relative coordinates
- and returned through the pointers. If the conversion was
- successful, the function returns <STRONG>TRUE</STRONG>. If one of the
- parameters was NULL or the location is not inside the win-
- dow, <STRONG>FALSE</STRONG> is returned. If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the point-
- ers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference screen-relative coordinates.
- They are converted to stdscr-relative coordinates if the
- window <STRONG>win</STRONG> encloses this point. In this case the function
- returns <STRONG>TRUE</STRONG>. If one of the parameters is NULL or the
- point is not inside the window, <STRONG>FALSE</STRONG> is returned. Please
- notice, that the referenced coordinates are only replaced
- by the converted coordinates if the transformation was
- successful.
+ dinates from stdscr-relative coordinates to coordinates
+ relative to the given window or vice versa. Please remem-
+ ber, that stdscr-relative coordinates are not always iden-
+ tical to window-relative coordinates due to the mechanism
+ to reserve lines on top or bottom of the screen for other
+ purposes (see the <STRONG>ripoffline()</STRONG> and <STRONG>slk_init</STRONG> calls, for ex-
+ ample). If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers
+ <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference the coordinates of a location inside
+ the window <STRONG>win</STRONG>. They are converted to window-relative co-
+ ordinates and returned through the pointers. If the con-
+ version was successful, the function returns <STRONG>TRUE</STRONG>. If one
+ of the parameters was NULL or the location is not inside
+ the window, <STRONG>FALSE</STRONG> is returned. If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the
+ pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference window-relative coordi-
+ nates. They are converted to stdscr-relative coordinates
+ if the window <STRONG>win</STRONG> encloses this point. In this case the
+ function returns <STRONG>TRUE</STRONG>. If one of the parameters is NULL
+ or the point is not inside the window, <STRONG>FALSE</STRONG> is returned.
+ Please notice, that the referenced coordinates are only
+ replaced by the converted coordinates if the transforma-
+ tion was successful.
+
+ The <STRONG>mouse_trafo</STRONG> function performs the same translation as
+ <STRONG>wmouse_trafo</STRONG>, using stdscr for <STRONG>win</STRONG>.