curs_getwch man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]


       curs_getwch,  getwch,  wgetwch, mvgetwch, mvwgetwch, ungetwch - get (or
       push back) wchar_t characters from curses terminal keyboard

       cc [ flag ... ] file ... -lcurses [ library .. ]
       #include <curses.h>

       int getwch(void);

       int wgetwch(WINDOW *win);

       int mvgetwch(int y, int x);

       int mvwgetwch(WINDOW *win, int y, int x);

       int ungetwch(int wch);

       The  getwch(), wgetwch(), mvgetwch(), and mvwgetwch() routines read  an
       EUC  character  from the terminal associated with the window, transform
       it into a wchar_t character, and return a  wchar_t  character.  In  no-
       delay mode, if no input is waiting, the value ERR is returned. In delay
       mode, the program waits until the system passes	text  through  to  the
       program. Depending on the setting of  cbreak, this is after one charac‐
       ter ( cbreak mode ), or after the first newline (nocbreak  mode	).  In
       half-delay  mode,  the  program waits until a character is typed or the
       specified timeout has been reached. Unless  noecho has  been  set,  the
       character will also be echoed into the designated window.

       If the window is not a pad, and it has been moved or modified since the
       last call to wrefresh(3CURSES), wrefresh will be called before  another
       character is read.

       If  keypad  is  TRUE, and a function key is pressed, the token for that
       function key is returned instead of the raw characters. Possible	 func‐
       tion  keys are defined in <curses.h> with integers beginning with 0401,
       whose names begin with KEY_. If a character that could be the beginning
       of a function key (such as escape) is received,	curses(3CURSES) sets a
       timer. If the remainder of the sequence does not	 come  in  within  the
       designated  time, the character is passed through; otherwise, the func‐
       tion key value is returned. For this reason, many terminals  experience
       a  delay	 between the time a user presses the escape key and the escape
       is returned to the program.

       The ungetwch() routine places wch back  onto  the  input	 queue	to  be
       returned by the next call to wgetwch().

   Function Keys
       The  following function keys, defined in	 <curses.h>, might be returned
       by getwch() if  keypad has been enabled. Note that not all of these may
       be supported on a particular terminal if the terminal does not transmit
       a unique code when the key is pressed or if the definition for the  key
       is not present in the  terminfo(4) database.

       │    Name		    Key name		 │
       │KEY_BREAK	Break key			 │
       │KEY_DOWN	The four arrow keys ...		 │
       │KEY_UP						 │
       │KEY_LEFT					 │
       │KEY_RIGHT					 │
       │KEY_HOME	Home key (upward+left arrow)	 │
       │KEY_BACKSPACE	Backspace			 │
       │KEY_F0		Function keys; space for 64 keys │
       │		is reserved.			 │
       │KEY_F(n)	For 0 ≤ n ≤ 63			 │
       │KEY_DL		Delete line			 │
       │KEY_IL		Insert line			 │
       │KEY_DC		Delete character		 │
       │KEY_IC		Insert char or enter insert mode │
       │KEY_EIC		Exit insert char mode		 │
       │KEY_CLEAR	Clear screen			 │
       │KEY_EOS		Clear to end of screen		 │
       │KEY_EOL		Clear to end of line		 │
       │KEY_SF		Scroll 1 line forward		 │
       │ KEY_SR		Scroll 1 line backward (reverse) │
       │KEY_NPAGE	Next page			 │
       │KEY_PPAGE	Previous page			 │
       │KEY_STAB	Set tab				 │
       │KEY_CTAB	Clear tab			 │
       │KEY_CATAB	Clear all tabs			 │
       │KEY_ENTER	Enter or send			 │
       │KEY_SRESET	Soft (partial) reset		 │
       │KEY_RESET	Reset or hard reset		 │
       │KEY_PRINT	Print or copy			 │
       │KEY_LL		Home  down  or	 bottom	  (lower │
       │		left).	Keypad	is arranged like │
       │		this:	   A1 up    A3	    left │
       │		B2   right	C1   down   C3	 │
       │KEY_A1		Upper left of keypad		 │
       │KEY_A3		Upper right of keypad		 │
       │KEY_B2		Center of keypad		 │
       │KEY_C1		Lower left of keypad		 │
       │KEY_C3		Lower right of keypad		 │
       │KEY_BTAB	Back tab key			 │
       │KEY_BEG		Beg(inning) key			 │
       │KEY_CANCEL	Cancel key			 │
       │KEY_CLOSE	Close key			 │
       │KEY_COMMAND	Cmd (command) key		 │
       │KEY_COPY	Copy key			 │
       │KEY_CREATE	Create key			 │
       │KEY_END		End key				 │
       │KEY_EXIT	Exit key			 │
       │KEY_FIND	Find key			 │
       │KEY_HELP	Help key			 │
       │KEY_MARK	Mark key			 │
       │KEY_MESSAGE	Message key			 │
       │KEY_MOVE	Move key			 │
       │KEY_NEXT	Next object key			 │
       │KEY_OPEN	Open key			 │
       │KEY_OPTIONS	Options key			 │
       │KEY_PREVIOUS	Previous object key		 │
       │KEY_REDO	Redo key			 │
       │KEY_REFERENCE	Reference key			 │
       │KEY_REFRESH	Refresh key			 │
       │KEY_REPLACE	Replace key			 │
       │KEY_RESTART	Restart key			 │
       │KEY_RESUME	Resume key			 │
       │KEY_SAVE	Save key			 │
       │KEY_SBEG	Shifted beginning key		 │
       │KEY_SCANCEL	Shifted cancel key		 │
       │KEY_SCOMMAND	Shifted command key		 │
       │KEY_SCOPY	Shifted copy key		 │
       │KEY_SCREATE	Shifted create key		 │
       │KEY_SDC		Shifted delete char key		 │
       │KEY_SDL		Shifted delete line key		 │
       │KEY_SELECT	Select key			 │
       │KEY_SEND	Shifted end key			 │
       │KEY_SEOL	Shifted clear line key		 │
       │KEY_SEXIT	Shifted exit key		 │
       │KEY_SFIND	Shifted find key		 │
       │KEY_SHELP	Shifted help key		 │
       │KEY_SHOME	Shifted home key		 │
       │KEY_SIC		Shifted input key		 │
       │KEY_SLEFT	Shifted left arrow key		 │
       │KEY_SMESSAGE	Shifted message key		 │
       │KEY_SMOVE	Shifted move key		 │
       │KEY_SNEXT	Shifted next key		 │
       │KEY_SOPTIONS	Shifted options key		 │
       │KEY_SPREVIOUS	Shifted prev key		 │
       │KEY_SPRINT	Shifted print key		 │
       │KEY_SREDO	Shifted redo key		 │
       │KEY_SREPLACE	Shifted replace key		 │
       │KEY_SRIGHT	Shifted right arrow		 │
       │KEY_SRSUME	Shifted resume key		 │
       │KEY_SSAVE	Shifted save key		 │
       │KEY_SSUSPEND	Shifted suspend key		 │
       │KEY_SUNDO	Shifted undo key		 │
       │KEY_SUSPEND	Suspend key			 │
       │KEY_UNDO	Undo key			 │

       All  routines  return the integer ERR upon failure and an integer value
       other than ERR upon successful completion.

       See attributes(5) for descriptions of the following attributes:

       │MT-Level       │ Unsafe		 │

       curses(3CURSES),	  curs_inopts(3CURSES),	   curs_move(3CURSES),	  wre‐
       fresh(3CURSES), terminfo(4), attributes(5)

       The  header  file  <curses.h>  automatically  includes the header files
       <stdio.h>, <unctrl.h> and <widec.h>.

       Use of the escape key by a programmer for a single  character  function
       is discouraged.

       When  using   getwch(), wgetwch(), mvgetwch(), or mvwgetwch(), nocbreak
       mode and	 echo mode should not be used at the same time.	 Depending  on
       the  state  of the tty driver when each character is typed, the program
       may produce undesirable results.

       Note that  getwch(), mvgetwch(), and mvwgetwch() may be macros.

				 Dec 31, 1996		  CURS_GETWCH(3CURSES)

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net