Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

chgat(3) [netbsd man page]

CURSES_CHGAT(3) 					   BSD Library Functions Manual 					   CURSES_CHGAT(3)

NAME
chgat, wchgat, mvchgat, mvwchgat -- curses on-screen attribute manipulation routines LIBRARY
Curses Library (libcurses, -lcurses) SYNOPSIS
#include <curses.h> int chgat(int n, attr_t attr, short color, const void *opts); int wchgat(WINDOW *win, int n, attr_t attr, short color, const void *opts); int mvchgat(int y, int x, int n, attr_t attr, short color, const void *opts); int mvwchgat(WINDOW *win, int y, int x, int n, attr_t attr, short color, const void *opts); DESCRIPTION
These functions modify the attributes of the drawn content on stdscr or on the specified window. The chgat() function sets the attributes of the next n characters to attr and the color pair to color. If n is negative or larger than the remainder of the line, it gets truncated. The wchgat() is the same as the chgat() function, excepting that the attributes are changed in the window specified by win. The mvchgat() and mvwchgat() functions are the same as the chgat() and wchgat() functions, respectively, excepting that they operate from the position specified by y, x. These functions do not perform wrapping. They do not update the cursor position. RETURN VALUES
The functions that return an int will return one of the following values: OK The function completed successfully. ERR An error occurred in the function. SEE ALSO
curses_attributes(3) STANDARDS
The chgat(), wchgat(), mvchgat(), and mvwchgat() functions conform to X/Open Curses Issue 4, Version 2 (``XCURSES4.2''). HISTORY
The Curses package appeared in 4.0BSD. Support for the chgat() family was added in NetBSD 6.0. BSD
July 6, 2009 BSD

Check Out this Related Man Page

curs_chgat(3)						     Library Functions Manual						     curs_chgat(3)

NAME
curs_chgat, chgat, wchgat, mvchgat, mvwchgat - Change renditions of characters in a Curses window SYNOPSIS
#include <curses.h> int chgat( int n, attr_t attr, short color_pair, const void *opts ); int wchgat( WINDOW *win, int n, attr_t attr, short color_pair, const void *opts ); int mvchgat( int y, int x, int n, attr_t attr, short color_pair, const void *opts ); int mvwchgat( WINDOW *win, int y, int x, int n, attr_t attr, short color_pair, const void *opts ); LIBRARY
Curses Library (libcurses) STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: chgat, wchgat, mvchgat, mvwchgat: XCURSES4.2 Refer to the standards(5) reference page for more information about industry standards and associated tags. DESCRIPTION
These functions change the renditions of the next n characters in the current or specified window (or of the remaining characters on the line if n is -1), starting at the current or specified cursor position. The attributes and colors are specified by attr and color_pair as in setcchar. These functions do not update the cursor and do not perform wrapping. A value of n that is greater than the remaining characters on a line is not an error. The opts argument is reserved for future use. Currently, the application must provide a null pointer as opts. NOTES
The header file <curses.h> automatically includes the header file <stdio.h>. Note that chgat, mvchgat, and mvwchgat may be macros. RETURN VALUES
Upon successful completion, these functions return OK. Otherwise, they return ERR. SEE ALSO
Functions: curses(3), curs_getcchar(3) Others: standards(5) curs_chgat(3)
Man Page