diff options
Diffstat (limited to 'man/curs_get_wch.3x')
| -rw-r--r-- | man/curs_get_wch.3x | 39 |
1 files changed, 29 insertions, 10 deletions
diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x index df9bc6a6e6c6..52c57c93baf4 100644 --- a/man/curs_get_wch.3x +++ b/man/curs_get_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2010,2012 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2018,2019 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,14 +26,26 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wch.3x,v 1.8 2012/11/03 23:03:59 tom Exp $ +.\" $Id: curs_get_wch.3x,v 1.12 2019/11/30 21:06:30 tom Exp $ .TH curs_get_wch 3X "" +.na +.hy 0 +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME \fBget_wch\fR, \fBwget_wch\fR, \fBmvget_wch\fR, \fBmvwget_wch\fR, \fBunget_wch\fR \- get (or push back) a wide character from curses terminal keyboard +.ad +.hy .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -76,13 +88,8 @@ If \fBkeypad\fR is enabled, these functions respond to the pressing of a function key by setting the object pointed to by \fIwch\fR -to the corresponding -\fBKEY_\fR -value defined -in -\fB<curses.h>\fR -and returning -\fBKEY_CODE_YES\fR. +to the keycode assigned to the function key, +and returning \fBKEY_CODE_YES\fR. If a character (such as escape) that could be the beginning of a function key is received, curses sets a timer. If the remainder @@ -92,6 +99,18 @@ For this reason, many terminals experience a delay between the time a user presses the escape key and the time the escape is returned to the program. .PP +The keycodes returned by these functions are the same as those +returned by \fBwgetch\fP: +.bP +The predefined function +keys are listed in \fB<curses.h>\fR as macros with values outside the range +of 8-bit characters. +Their names begin with \fBKEY_\fR. +.bP +Other (user-defined) function keys +which may be defined using \fBdefine_key\fP(3X) have no names, +but also are expected to have values outside the range of 8-bit characters. +.PP The \fBunget_wch\fR function pushes the wide character @@ -153,7 +172,7 @@ returns Otherwise, the function returns \fBERR\fR. .PP -Functions with a "mv" prefix first perform a cursor movement using +Functions with a \*(``mv\*('' prefix first perform a cursor movement using \fBwmove\fP, and return an error if the position is outside the window, or if the window pointer is null. .SH SEE ALSO |