diff options
Diffstat (limited to 'doc/html/man/curs_getch.3x.html')
| -rw-r--r-- | doc/html/man/curs_getch.3x.html | 59 |
1 files changed, 31 insertions, 28 deletions
diff --git a/doc/html/man/curs_getch.3x.html b/doc/html/man/curs_getch.3x.html index 2bdcdc4..a0c57c3 100644 --- a/doc/html/man/curs_getch.3x.html +++ b/doc/html/man/curs_getch.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * + * Copyright (c) 1998-2012,2014 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 * @@ -28,7 +28,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_getch.3x,v 1.36 2011/01/22 19:38:51 tom Exp @ + * @Id: curs_getch.3x,v 1.39 2014/05/24 20:16:31 tom Exp @ --> <HTML> <HEAD> @@ -76,14 +76,24 @@ waits until a character is typed or the specified timeout has been reached. - Unless <STRONG>noecho</STRONG> has been set, then the character will also - be echoed into the designated window according to the fol- - lowing rules: if the character is the current erase char- - acter, left arrow, or backspace, the cursor is moved one - space to the left and that screen position is erased as if - <STRONG>delch</STRONG> had been called. If the character value is any oth- - er <STRONG>KEY_</STRONG> define, the user is alerted with a <STRONG>beep</STRONG> call. - Otherwise the character is simply output to the screen. + If <STRONG>echo</STRONG> is enabled, and the window is not a pad, then the + character will also be echoed into the designated window + according to the following rules: + + <STRONG>o</STRONG> If the character is the current erase character, left + arrow, or backspace, the cursor is moved one space to + the left and that screen position is erased as if + <STRONG>delch</STRONG> had been called. + + <STRONG>o</STRONG> If the character value is any other <STRONG>KEY_</STRONG> define, the + user is alerted with a <STRONG>beep</STRONG> call. + + <STRONG>o</STRONG> If the character is a carriage-return, and if <STRONG>nl</STRONG> is + enabled, it is translated to a line-feed after echo- + ing. + + <STRONG>o</STRONG> Otherwise the character is simply output to the + screen. If the window is not a pad, and it has been moved or modi- fied since the last call to <STRONG>wrefresh</STRONG>, <STRONG>wrefresh</STRONG> will be @@ -93,7 +103,7 @@ ken for that function key is returned instead of the raw characters. Possible function keys are defined in <STRONG><curs-</STRONG> <STRONG>es.h></STRONG> as macros with values outside the range of 8-bit - characters whose names begin with <STRONG>KEY_</STRONG>. Thus, a variable + characters whose names begin with <STRONG>KEY_</STRONG>. Thus, a variable intended to hold the return value of a function key must be of short size or larger. @@ -110,15 +120,14 @@ be returned by the next call to <STRONG>wgetch</STRONG>. There is just one input queue for all windows. - <STRONG>Function</STRONG> <STRONG>Keys</STRONG> The following function keys, defined in <STRONG><curses.h></STRONG>, might be returned by <STRONG>getch</STRONG> if <STRONG>keypad</STRONG> has been enabled. Note that not all of these are necessarily supported on any particular terminal. - <EM>Name</EM> <EM>Key</EM> <EM>name</EM> + ------------------------------------------------- KEY_BREAK Break key KEY_DOWN The four arrow keys ... KEY_UP @@ -169,6 +178,7 @@ KEY_MESSAGE Message key KEY_MOUSE Mouse event read KEY_MOVE Move key + KEY_NEXT Next object key KEY_OPEN Open key KEY_OPTIONS Options key @@ -180,7 +190,6 @@ KEY_RESIZE Screen resized KEY_RESTART Restart key KEY_RESUME Resume key - KEY_SAVE Save key KEY_SBEG Shifted beginning key KEY_SCANCEL Shifted cancel key @@ -233,21 +242,18 @@ sion of <STRONG>KEY_MOUSE</STRONG>. - </PRE> <H2>RETURN VALUE</H2><PRE> All routines return the integer <STRONG>ERR</STRONG> upon failure and an integer value other than <STRONG>ERR</STRONG> (<STRONG>OK</STRONG> in the case of ungetch()) upon successful completion. - <STRONG>ungetch</STRONG> - returns an error if there is no more room in - the FIFO. + <STRONG>ungetch</STRONG> + returns ERR if there is no more room in the FIFO. - <STRONG>wgetch</STRONG> - returns an error if the window pointer is - null, or if its timeout expires without having - any data. + <STRONG>wgetch</STRONG> + returns ERR if the window pointer is null, or if + its timeout expires without having any data. Functions with a "mv" prefix first perform a cursor move- ment using <STRONG>wmove</STRONG>, and return an error if the position is @@ -321,7 +327,7 @@ documentation. Under historical curses implementations, it varied depending on whether the operating system's im- plementation of handled signal receipt interrupts a - <STRONG><A HREF="read.2.html">read(2)</A></STRONG> call in progress or not, and also (in some imple- + <STRONG>read(2)</STRONG> call in progress or not, and also (in some imple- mentations) depending on whether an input timeout or non- blocking mode has been set. @@ -351,9 +357,6 @@ <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> </PRE> <HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> +Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> </BODY> </HTML> |