Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

getch(3cur) [ultrix man page]

getch(3cur)															       getch(3cur)

Name
       getch, mvgetch, mvwgetch, wgetch - read character

Syntax
       #include <cursesX.h>

       int getch()

       int wgetch(win)
       WINDOW *win;

       int mvgetch(y, x)
       int y, x;

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

Description
       The routine reads a character from the terminal associated with the default window.

       The routine reads a character from the terminal associated with the specified window.

       The routine reads a character from the terminal associated with the default window at the specified position.

       The routine reads a character from the terminal associated with the specified window at the specified position.

       The  following information applies to all the routines.	In mode, if there is no input waiting, the integer is returned.  In mode, the pro-
       gram waits until the system passes text through to the program.	Usually the program will restart after one character or  after	the  first
       newline, but this depends on how is set.  The character will be echoed on the designated window unless has been set.

       If is and a function key is pressed, the token for that function key is returned instead of the raw characters.	Possible function keys are
       defined in the header file with integers beginning with 0401.  The function key names begin with KEY_.  Function keys and their	respective
       integer values are described in the Guide to X/Open Curses Screen-Handling (R)

       If  a character is received that could be the beginning of a function key (such as escape), sets a timer.  If the remainder of the sequence
       does not come within the designated time, the character will be passed through, otherwise the  function	key  value  is	returned.   Conse-
       quently, there may be a delay after a user presses the escape key before the escape is returned to the program.

       Using the escape key for a single character function is discouraged.

       The routines and are macros.

Return Values
       Upon successful completion, the and functions return the character read.

       If in delay mode and no data is available, ERR is returned.

See Also
       cbreak(3cur), keypad(3cur), nodelay(3cur), noecho(3cur)
       Guide to X/Open Curses Screen-Handling

																       getch(3cur)

Check Out this Related Man Page

attroff(3cur)															     attroff(3cur)

Name
       attroff, attron, attrset, standend, standout, wstandend, wstandout, wattroff, wattron, wattrset - attribute manipulation

Syntax
       #include <cursesX.h>

       int attroff(attrs)
       int attrs;

       int wattroff(win, attrs)
       WINDOW *win;
       int attrs;

       int attron(attrs)
       int attrs;

       int wattron(win, attrs)
       WINDOW *win;
       int attrs;

       int attrset(attrs)
       int attrs;

       int wattrset(win, attrs)
       WINDOW *win;
       int attrs;

       int standend()

       wstandend(win)
       WINDOW *win;

       int standout()

       int wstandout(win)
       WINDOW *win;

Description
       These routines manipulate the current attributes of a window.

       The routine turns off the named attributes (of the default window without turning any other attributes on or off.

       The routine turns on the named attributes of the default window without affecting any other attributes.

       The  routine  sets  the	current attributes of the default window to the named attributes which is of the type and is defined in the header
       file.

       The routine switches on the best highlighting mode available on the terminal for the default window and it is functionally the same as

       The routine switches off all highlighting associated with the default window.  It is functionally the same as in  that  it  turns  off  all
       attributes.

       The routine switches off the named attributes, for the specified window.  Other attributes are not changed.

       The routine turns on the named attributes of the specified window without affecting any others.

       The routine sets the current attributes of the specified window to

       The routine switches on the best highlighting mode available on the terminal for the specified window.  Functionally it is the same as

       The  routine  switches off all highlighting associated with the specified window.  Functionally it is the same as that is, it turns off all
       attributes.

Attributes
       Attributes can be any combination of A_STANDOUT, A_REVERSE, A_BOLD, A_DIM, A_BLINK and A_UNDERLINE.  These constants  are  defined  in  the
       header  file.   They are also described in the Guide to X/Open Curses Screen-Handling.  (R)Attributes can be combined with the C language |
       operator.

       The current attributes of a window are applied to all characters that are written into the window with or Attributes are properties of  the
       character,  and	move with the character through any scrolling and insert/delete line/character operations.  Within the restrictions set by
       the terminal hardware they will be displayed as the graphic rendition of characters put on the screen.

       The routines and are macros.

Return Values
       The and functions return OK on success and ERR on error.

See Also
       addch(3cur)
       Guide to X/Open Curses Screen-Handling

																     attroff(3cur)
Man Page