X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_termattrs.3x.html;h=81805d29255e5e64abfe65d7d9133d4e69f2f0a8;hp=daf3a76660e81d948cef089b103f9875fa4bb1c2;hb=HEAD;hpb=ca276baf720e3a44721b9e18955d3f546955c6c8 diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html index daf3a766..84f7a15b 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 2024-04-20 ncurses 6.4 Library calls + + -

curs_termattrs 3x

-
+

curs_termattrs 3x 2024-04-20 ncurses 6.4 Library calls

-
-curs_termattrs(3x)                                   curs_termattrs(3x)
+curs_termattrs(3x)               Library calls              curs_termattrs(3x)
 
 
 
 
-
-

NAME

-       baudrate, erasechar, erasewchar, has_ic, has_il, killchar,
-       killwchar, longname,  term_attrs,  termattrs,  termname  -
-       curses environment query routines
+

NAME

+       baudrate,  erasechar,  erasewchar, has_ic, has_il, killchar, killwchar,
+       longname, term_attrs, termattrs, termname -  curses  environment  query
+       routines
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
        int baudrate(void);
        char erasechar(void);
-       int erasewchar(wchar_t *ch);
+       int erasewchar(wchar_t *wc);
        bool has_ic(void);
        bool has_il(void);
        char killchar(void);
-       int killwchar(wchar_t *ch);
+       int killwchar(wchar_t *wc);
        char *longname(void);
        attr_t term_attrs(void);
        chtype termattrs(void);
        char *termname(void);
 
 
-
-

DESCRIPTION

-       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  does not support a video attribute
-       that an application program is trying to use,  curses  may
-       substitute  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_ constants respectively.  This information is  use-
-       ful  when a curses program needs complete control over the
-       appearance of the screen.
-
-       The termname routine returns the  terminal  name  used  by
-       setupterm.
+

DESCRIPTION

 
+

baudrate

+       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.
 
-
-

RETURN VALUE

+
+

erasechar, erasewchar

+       The erasechar routine returns the user's current erase character.
+
+       The  erasewchar  routine  stores  the  current  erase  character in the
+       location referenced by wc.  If no erase character has been defined, the
+       routine fails and the location referenced by wc is not changed.
+
+
+

has_ic, has_il

+       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(3x).
+
+
+

killchar, killwchar

+       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 wc.  If no line-kill character has been defined,
+       the routine fails and the location referenced by wc is not changed.
+
+
+

longname

+       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.
+
+
+

termattrs, term_attrs

+       If  a  given  terminal  does  not  support  a  video  attribute that an
+       application program is trying to use, curses may substitute 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_  constants  respectively.   This  information is useful when a
+       curses program needs  complete  control  over  the  appearance  of  the
+       screen.
+
+
+

termname

+       The termname routine returns the terminal name used by setupterm.
+
+
+

RETURN VALUE

        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
+       completion.
 
 
-
-

NOTES

+

NOTES

        Note that termattrs may be a macro.
 
 
-
-

PORTABILITY

-       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.
+

PORTABILITY

+       X/Open  Curses,  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.
 
 
-
-

SEE ALSO

+

SEE ALSO

        curses(3x), curs_initscr(3x), curs_outopts(3x)
 
 
 
-                                                     curs_termattrs(3x)
+ncurses 6.4                       2024-04-20                curs_termattrs(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +