X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_termattrs.3x.html;h=81805d29255e5e64abfe65d7d9133d4e69f2f0a8;hb=84cf9f63bf604413fa5714ef91f83076ac8f236b;hp=9b9cdae96fab14239dc81c45aa53bae6e6b40f33;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;p=ncurses.git diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html index 9b9cdae9..81805d29 100644 --- a/doc/html/man/curs_termattrs.3x.html +++ b/doc/html/man/curs_termattrs.3x.html @@ -1,7 +1,7 @@ - +
+ +- -curs_termattrs(3x) curs_termattrs(3x) +curs_termattrs(3x) curs_termattrs(3x) --
- baudrate, erasechar, erasewchar, has_ic, has_il, killchar, - killwchar, longname, term_attrs, termattrs, termname - - curses environment query routines +
+ baudrate, erasechar, erasewchar, has_ic, has_il, killchar, killwchar, + longname, term_attrs, termattrs, termname - curses environment query + routines --
+
#include <curses.h> int baudrate(void); @@ -69,93 +68,108 @@ char *termname(void); --
- The baudrate routine returns the output speed of the ter- - minal. The number returned is in bits per second, for - example 9600, and is an integer. - - The erasechar routine returns the user's current erase - character. - - The erasewchar routine stores the current erase character - in the location referenced by ch. If no erase character - has been defined, the routine fails and the location ref- - erenced by ch is not changed. - - The has_ic routine is true if the terminal has insert- and - delete- character capabilities. - - The has_il routine is true if the terminal has insert- and - delete-line capabilities, or can simulate them using - scrolling regions. This might be used to determine if it - would be appropriate to turn on physical scrolling using - scrollok. - - The killchar routine returns the user's current line kill - character. - - The killwchar routine stores the current line-kill charac- - ter in the location referenced by ch. If no line-kill - character has been defined, the routine fails and the - location referenced by ch is not changed. - - The longname routine returns a pointer to a static area - containing a verbose description of the current terminal. - The maximum length of a verbose description is 128 charac- - ters. It is defined only after the call to initscr or - newterm. The area is overwritten by each call to newterm - and is not restored by set_term, so the value should be - saved between calls to newterm if longname is going to be - used with multiple terminals. - - If a given terminal doesn't support a video attribute that - an application program is trying to use, curses may sub- - stitute a different video attribute for it. The termattrs - and term_attrs functions return a logical OR of all video - attributes supported by the terminal using A_ and WA_ con- - stants respectively. This information is useful when a - curses program needs complete control over the appearance - of the screen. - - The termname routine returns the terminal name used by - setupterm. +
+
+ The baudrate routine returns the output speed of the terminal. The + number returned is in bits per second, for example 9600, and is an + integer. --
+ +
+ The erasechar routine returns the user's current erase character. + + The erasewchar routine stores the current erase character in the loca- + tion referenced by ch. If no erase character has been defined, the + routine fails and the location referenced by ch is not changed. + + +
+ The has_ic routine is true if the terminal has insert- and delete- + character capabilities. + + The has_il routine is true if the terminal has insert- and delete-line + capabilities, or can simulate them using scrolling regions. This might + be used to determine if it would be appropriate to turn on physical + scrolling using scrollok. + + +
+ The killchar routine returns the user's current line kill character. + + The killwchar routine stores the current line-kill character in the + location referenced by ch. If no line-kill character has been defined, + the routine fails and the location referenced by ch is not changed. + + +
+ The longname routine returns a pointer to a static area containing a + verbose description of the current terminal. The maximum length of a + verbose description is 128 characters. It is defined only after the + call to initscr or newterm. The area is overwritten by each call to + newterm and is not restored by set_term, so the value should be saved + between calls to newterm if longname is going to be used with multiple + terminals. + + +
+ If a given terminal does not support a video attribute that an applica- + tion program is trying to use, curses may substitute a different video + attribute for it. The termattrs and term_attrs functions return a log- + ical OR of all video attributes supported by the terminal using A_ and + WA_ constants respectively. This information is useful when a curses + program needs complete control over the appearance of the screen. + + +
+ The termname routine returns the terminal name used by setupterm. + + +
longname and termname return NULL on error. - Routines that return an integer return ERR upon failure - and OK (SVr4 only specifies "an integer value other than - ERR") upon successful completion. + Routines that return an integer return ERR upon failure and OK (SVr4 + only specifies "an integer value other than ERR") upon successful com- + pletion. --
+
Note that termattrs may be a macro. --
- The XSI Curses standard, Issue 4 describes these func- - tions. It changes the return type of termattrs to the new - type attr_t. Most versions of curses truncate the result - returned by termname to 14 characters. +
+ The XSI Curses standard, Issue 4 describes these functions. It changes + the return type of termattrs to the new type attr_t. Most versions of + curses truncate the result returned by termname to 14 characters. --
+
curses(3x), curs_initscr(3x), curs_outopts(3x) - curs_termattrs(3x) + curs_termattrs(3x)-