X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addch.3x.html;h=2c0f6e7b6bae3b2452b7f56108ee229e351f0235;hp=74fdef6e8f5f2e42f8a19302efd65e5c4b97a226;hb=46722468f47c2b77b3987729b4bcf2321cccfd01;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_addch.3x.html b/doc/html/man/curs_addch.3x.html index 74fdef6e..2c0f6e7b 100644 --- a/doc/html/man/curs_addch.3x.html +++ b/doc/html/man/curs_addch.3x.html @@ -1,77 +1,117 @@ + + + +curs_addch 3x + + + +

curs_addch 3x

NAME

-       addch,  waddch,  mvaddch,  mvwaddch, echochar, wechochar -
-       add a character (with attributes) to a curses window, then
+       addch,  waddch,  mvaddch,  mvwaddch, echochar, wechochar -
+       add a character (with attributes) to a curses window, then
        advance the cursor

SYNOPSIS

-       #include <curses.h>
+       #include <curses.h>
 
-       int addch(chtype ch);
-       int waddch(WINDOW *win, chtype ch);
-       int mvaddch(int y, int x, chtype ch);
-       int mvwaddch(WINDOW *win, int y, int x, chtype ch);
-       int echochar(chtype ch);
-       int wechochar(WINDOW *win, chtype ch);
+       int addch(const chtype ch);
+       int waddch(WINDOW *win, const chtype ch);
+       int mvaddch(int y, int x, const chtype ch);
+       int mvwaddch(WINDOW *win, int y, int x, const chtype ch);
+       int echochar(const chtype ch);
+       int wechochar(WINDOW *win, const chtype ch);

DESCRIPTION

-       The  addch,  waddch, mvaddch and mvwaddch routines put the
-       character ch into the given window at its  current  window
+       The  addch,  waddch, mvaddch and mvwaddch routines put the
+       character ch into the given window at its  current  window
        position,  which  is then advanced.  They are analogous to
-       putchar in stdio(3).  If the advance is at the right  mar-
+       putchar in stdio(3).  If the advance is at the right  mar-
        gin,  the  cursor  automatically wraps to the beginning of
        the next line.  At the bottom  of  the  current  scrolling
-       region,  if  scrollok  is enabled, the scrolling region is
+       region,  if  scrollok  is enabled, the scrolling region is
        scrolled up one line.
 
-       If ch is a tab, newline, or backspace, the cursor is moved
+       If ch is a tab, newline, or backspace, the cursor is moved
        appropriately within the window.  Backspace moves the cur-
        sor one character left; at the left edge of  a  window  it
-       does  nothing.   Newline  does  a clrtoeol, then moves the
+       does  nothing.   Newline  does  a clrtoeol, then moves the
        cursor to  the  window  left  margin  on  the  next  line,
        scrolling  the window if on the last line).  Tabs are con-
-       sidered to be at every eighth column.
+       sidered to be at every eighth column.   The  tab  interval
+       may be altered by setting the TABSIZE variable.
 
-       If ch is any control character other than tab, newline, or
-       backspace,  it  is  drawn  in  ^X notation.  Calling winch
+       If ch is any control character other than tab, newline, or
+       backspace, it is drawn  in  ^X  notation.   Calling  winch
        after adding a control character does not return the char-
-       acter  itself, but instead returns the ^-representation of
+       acter itself, but instead returns the ^-representation  of
        the control character.
 
        Video attributes can be combined with a character argument
-       passed to addch or related functions by logical-ORing them
-       into the character.  (Thus,  text,  including  attributes,
-       can  be  copied  from  one place to another using inch and
-       addch.).  See the curs_attr(3x) page for values of  prede-
+       passed to addch or related functions by logical-ORing them
+       into  the  character.   (Thus, text, including attributes,
+       can be copied from one place to  another  using  inch  and
+       addch.).   See the curs_attr(3x) page for values of prede-
        fined video attribute constants that can be usefully OR'ed
        into characters.
 
-       The echochar and wechochar routines are  equivalent  to  a
-       call  to addch followed by a call to refresh, or a call to
-       waddch followed by a call to wrefresh.  The knowledge that
-       only  a  single character is being output is used and, for
-       non-control characters, a  considerable  performance  gain
-       may  be  seen  by  using  these  routines instead of their
+       The  echochar  and  wechochar routines are equivalent to a
+       call to addch followed by a call to refresh, or a call  to
+       waddch followed by a call to wrefresh.  The knowledge that
+       only a single character is being output is used  and,  for
+       non-control  characters,  a  considerable performance gain
+       may be seen by  using  these  routines  instead  of  their
        equivalents.
 
-   Line Graphics
-       The following variables may be used to  add  line  drawing
-       characters  to  the screen with routines of the addch fam-
-       ily.  The default character listed below is  used  if  the
-       acsc   capability   doesn't   define  a  terminal-specific
+   Line Graphics
+       The  following  variables  may be used to add line drawing
+       characters to the screen with routines of the  addch  fam-
+       ily.   The  default  character listed below is used if the
+       acsc  capability  doesn't   define   a   terminal-specific
        replacement for it (but see the EXTENSIONS section below).
        The names are taken from VT100 nomenclature.
 
-       Name           Default   Description
+       Name           Default   Description
        --------------------------------------------------
        ACS_BLOCK      #         solid square block
        ACS_BOARD      #         board of squares
@@ -110,43 +150,41 @@

RETURN VALUE

-       All routines return the integer ERR upon failure and OK on
-       success (the SVr4 manuals specify only "an  integer  value
-       other than ERR") upon successful completion, unless other-
+       All routines return the integer ERR upon failure and OK on
+       success  (the  SVr4 manuals specify only "an integer value
+       other than ERR") upon successful completion, unless other-
        wise noted in the preceding routine descriptions.

NOTES

-       Note that addch, mvaddch, mvwaddch, and  echochar  may  be
+       Note  that  addch,  mvaddch, mvwaddch, and echochar may be
        macros.

PORTABILITY

-       All  these functions are described in the XSI Curses stan-
-       dard, Issue 4.  The defaults specified  for  forms-drawing
+       All these functions are described in the XSI Curses  stan-
+       dard,  Issue  4.  The defaults specified for forms-drawing
        characters apply in the POSIX locale.
 
-       Some  ACS symbols (ACS_S3, ACS_S7, ACS_LEQUAL, ACS_GEQUAL,
-       ACS_PI, ACS_NEQUAL, ACS_STERLING) were not  documented  in
-       any  publicly  released  System V.  However, many publicly
-       available terminfos include acsc strings  in  which  their
-       key  characters  (pryz{|}) are embedded, and a second-hand
-       list of their character descriptions has  come  to  light.
-       The   ACS-prefixed   names  for  them  were  invented  for
-       ncurses(3x).
+       Some ACS symbols (ACS_S3, ACS_S7, ACS_LEQUAL,  ACS_GEQUAL,
+       ACS_PI,  ACS_NEQUAL,  ACS_STERLING) were not documented in
+       any publicly released System V.   However,  many  publicly
+       available  terminfos  include  acsc strings in which their
+       key characters (pryz{|}) are embedded, and  a  second-hand
+       list  of  their  character descriptions has come to light.
+       The  ACS-prefixed  names  for  them  were   invented   for
+       ncurses(3x).
+
+       The  TABSIZE  variable  is implemented in some versions of
+       curses, but is not part of X/Open curses.