diff options
Diffstat (limited to 'doc/html/man/curs_add_wchstr.3x.html')
| -rw-r--r-- | doc/html/man/curs_add_wchstr.3x.html | 119 |
1 files changed, 56 insertions, 63 deletions
diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html index d27ab8c772a4..8b4fe83d8b2f 100644 --- a/doc/html/man/curs_add_wchstr.3x.html +++ b/doc/html/man/curs_add_wchstr.3x.html @@ -1,7 +1,6 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 2002-2010,2012 Free Software Foundation, Inc. * + * Copyright (c) 2002-2017,2019 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * @@ -27,34 +26,32 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_add_wchstr.3x,v 1.10 2012/11/03 22:54:43 tom Exp @ + * @Id: curs_add_wchstr.3x,v 1.12 2019/11/30 21:06:30 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>curs_add_wchstr 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>curs_add_wchstr 3x</H1> -<HR> +<H1 class="no-header">curs_add_wchstr 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> +<STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> -</PRE> -<H2>NAME</H2><PRE> - <STRONG>add_wchstr</STRONG>, <STRONG>add_wchnstr</STRONG>, <STRONG>wadd_wchstr</STRONG>, <STRONG>wadd_wchnstr</STRONG>, - <STRONG>mvadd_wchstr</STRONG>, <STRONG>mvadd_wchnstr</STRONG>, <STRONG>mvwadd_wchstr</STRONG>, <STRONG>mvwadd_wchnstr</STRONG> - - add an array of complex characters (and attributes) to a - curses window +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + <STRONG>add_wchstr</STRONG>, <STRONG>add_wchnstr</STRONG>, <STRONG>wadd_wchstr</STRONG>, <STRONG>wadd_wchnstr</STRONG>, <STRONG>mvadd_wchstr</STRONG>, + <STRONG>mvadd_wchnstr</STRONG>, <STRONG>mvwadd_wchstr</STRONG>, <STRONG>mvwadd_wchnstr</STRONG> - add an array of complex + characters (and attributes) to a curses window -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> <STRONG>int</STRONG> <STRONG>add_wchstr(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>);</STRONG> @@ -67,76 +64,72 @@ <STRONG>int</STRONG> <STRONG>mvwadd_wchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wchstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> -</PRE> -<H2>DESCRIPTION</H2><PRE> - These functions copy the (null-terminated) array of com- - plex characters <EM>wchstr</EM> into the window image structure - starting at the current cursor position. The four func- - tions with <EM>n</EM> as the last argument copy at most <EM>n</EM> elements, - but no more than will fit on the line. If <STRONG>n</STRONG>=<STRONG>-1</STRONG> then the - whole array is copied, to the maximum number of characters - that will fit on the line. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + These functions copy the (null-terminated) array of complex characters + <EM>wchstr</EM> into the window image structure starting at the current cursor + position. The four functions with <EM>n</EM> as the last argument copy at most + <EM>n</EM> elements, but no more than will fit on the line. If <STRONG>n</STRONG>=<STRONG>-1</STRONG> then the + whole array is copied, to the maximum number of characters that will + fit on the line. - The window cursor is <EM>not</EM> advanced. These functions work - faster than <STRONG>waddnstr</STRONG>. On the other hand: + The window cursor is <EM>not</EM> advanced. These functions work faster than + <STRONG>waddnstr</STRONG>. On the other hand: - <STRONG>o</STRONG> they do not perform checking (such as for the newline, - backspace, or carriage return characters), + <STRONG>o</STRONG> they do not perform checking (such as for the newline, backspace, + or carriage return characters), <STRONG>o</STRONG> they do not advance the current cursor position, - <STRONG>o</STRONG> they do not expand other control characters to ^-es- - capes, and + <STRONG>o</STRONG> they do not expand other control characters to ^-escapes, and - <STRONG>o</STRONG> they truncate the string if it crosses the right mar- - gin, rather than wrapping it around to the new line. + <STRONG>o</STRONG> they truncate the string if it crosses the right margin, rather + than wrapping it around to the new line. - These functions end successfully on encountering a null - <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM>, or when they have filled the current line. If a - complex character cannot completely fit at the end of the - current line, the remaining columns are filled with the - background character and rendition. + These functions end successfully on encountering a null <EM>cchar</EM><STRONG>_</STRONG><EM>t</EM>, or + when they have filled the current line. If a complex character cannot + completely fit at the end of the current line, the remaining columns + are filled with the background character and rendition. -</PRE> -<H2>RETURN VALUE</H2><PRE> - All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> - on success. +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on success. - X/Open does not define any error conditions. This imple- - mentation returns an error if the window pointer is null. + X/Open does not define any error conditions. This implementation re- + turns an error if the window pointer is null. - Functions with a "mv" prefix first perform a cursor move- - ment using <STRONG>wmove</STRONG>, and return an error if the position is - outside the window, or if the window pointer is null. + Functions with a "mv" prefix first perform a cursor movement using + <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if + the window pointer is null. -</PRE> -<H2>NOTES</H2><PRE> +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> All functions except <STRONG>wadd_wchnstr</STRONG> may be macros. -</PRE> -<H2>PORTABILITY</H2><PRE> - These entry points are described in the XSI Curses stan- - dard, Issue 4. +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + These entry points are described in the XSI Curses standard, Issue 4. -</PRE> -<H2>SEE ALSO</H2><PRE> +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. - Comparable functions in the narrow-character (ncurses) li- - brary are described in <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>. + Comparable functions in the narrow-character (ncurses) library are de- + scribed in <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>. - <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> + <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> </PRE> -<HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +</ul> +</div> </BODY> </HTML> |