X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_get_wch.3x;h=dd2b4c32e82c5fa19b1a3d52be97ac6fb2a9fcf4;hp=fe49849a2ecd613b26f35fd613ce69ac9b3a8cb2;hb=8d8a3537cd58af7879c6e1921235daeed2b74926;hpb=9bb12d03d854ce72b456e525f0c560f2fa91545d diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x index fe49849a..dd2b4c32 100644 --- a/man/curs_get_wch.3x +++ b/man/curs_get_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2017,2018 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,22 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wch.3x,v 1.7 2010/08/14 23:31:42 tom Exp $ +.\" $Id: curs_get_wch.3x,v 1.11 2018/07/28 22:20:54 tom Exp $ .TH curs_get_wch 3X "" +.na +.hy 0 +.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 \fR .sp @@ -76,13 +84,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\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 +95,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\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 @@ -132,7 +147,7 @@ is typed, the program may produce undesirable results. .PP All functions except \fBwget_wch\fR and \fBunget_wch\fR may be macros. -.SH RETURN VALUES +.SH RETURN VALUE When \fBget_wch\fR, \fBwget_wch\fR,