mirror/ncursesw-morphos
2
0
Fork 0
mirror of https://github.com/Aigor44/ncursesw-morphos.git synced 2024-12-15 07:30:12 +08:00
Code Issues Packages Projects Releases Wiki Activity
6830dca51a
ncursesw-morphos/man/curs_in_wchstr.3x

127 lines
4.6 KiB
Plaintext
Raw Normal View History

ncurses 5.3
2002-10-13 11:35:53 +08:00
.\"***************************************************************************
ncurses 6.2 - patch 20200212 + update release notes + minor build-fixes, mostly to test-package scripts + modify check for sizeof(wchar_t) to ensure it gives useful result when cross-compiling. + drop assumption in configure script that Cygwin's linker is broken. + define NCURSES_BROKEN_LINKER if the broken-linker feature is used, to simplify configure-checks for ncurses-examples. + reassert copyright on ncurses, per discussion in ncurses FAQ: https://invisible-island.net/ncurses/ncurses.faq.html#relicensed + modify comparison in make_hash.c to correct a special case in collision handling for Caps-hpux11 + add testing utility report_hashing to check hash-tables used for terminfo and termcap names. + fix a missing prototype for _nc_free_and_exit(). + update a few comments about tack 1.07 + use an awk script to split too-long pathnames used in Ada95 sample programs for explain.txt
2020-02-12 17:50:22 +08:00
.\" Copyright 2018-2019,2020 Thomas E. Dickey *
.\" Copyright 2002-2012,2017 Free Software Foundation, Inc. *
ncurses 5.3
2002-10-13 11:35:53 +08:00
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" copy of this software and associated documentation files (the *
.\" "Software"), to deal in the Software without restriction, including *
.\" without limitation the rights to use, copy, modify, merge, publish, *
.\" distribute, distribute with modifications, sublicense, and/or sell *
.\" copies of the Software, and to permit persons to whom the Software is *
.\" furnished to do so, subject to the following conditions: *
.\" *
.\" The above copyright notice and this permission notice shall be included *
.\" in all copies or substantial portions of the Software. *
.\" *
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
.\" *
.\" Except as contained in this notice, the name(s) of the above copyright *
.\" holders shall not be used in advertising or otherwise to promote the *
.\" sale, use or other dealings in this Software without prior written *
.\" authorization. *
.\"***************************************************************************
.\"
ncurses 6.2 - patch 20201017 + improve manpage typography. + improve discussion in curs_addch.3x of the use of unctrl to display nonprintable characters. + add a note in terminfo.5 explaining that no-parameter strings such as sgr0 or cnorm should not be used with tparm.
2020-10-18 09:25:54 +08:00
.\" $Id: curs_in_wchstr.3x,v 1.14 2020/10/17 23:19:44 tom Exp $
ncurses 5.3
2002-10-13 11:35:53 +08:00
.TH curs_in_wchstr 3X ""
ncurses 6.1 - patch 20191130 + add portability section to curs_getcchar manpage (prompted by discussion with Nick Black). + improve portability discussion of ACS characters in curs_addch manpage. + improve typography for double-quotes in manpages.
2019-12-01 09:27:53 +08:00
.ie \n(.g .ds `` \(lq
.el .ds `` ``
.ie \n(.g .ds '' \(rq
.el .ds '' ''
ncurses 5.5
2005-10-10 02:41:57 +08:00
.na
.hy 0
ncurses 5.3
2002-10-13 11:35:53 +08:00
.SH NAME
\fBin_wchstr\fR,
\fBin_wchnstr\fR,
\fBwin_wchstr\fR,
\fBwin_wchnstr\fR,
\fBmvin_wchstr\fR,
\fBmvin_wchnstr\fR,
\fBmvwin_wchstr\fR,
\fBmvwin_wchnstr\fR \- get an array of complex characters and renditions from a curses window
ncurses 5.5
2005-10-10 02:41:57 +08:00
.ad
.hy
ncurses 5.3
2002-10-13 11:35:53 +08:00
.SH SYNOPSIS
.nf
\fB#include <curses.h>\fR
ncurses 5.5
2005-10-10 02:41:57 +08:00
.sp
ncurses 5.3
2002-10-13 11:35:53 +08:00
\fBint in_wchstr(cchar_t *\fR\fIwchstr\fR\fB);\fR
.br
\fBint in_wchnstr(cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
.br
\fBint win_wchstr(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwchstr\fR\fB);\fR
.br
\fBint win_wchnstr(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
ncurses 6.2 - patch 20201017 + improve manpage typography. + improve discussion in curs_addch.3x of the use of unctrl to display nonprintable characters. + add a note in terminfo.5 explaining that no-parameter strings such as sgr0 or cnorm should not be used with tparm.
2020-10-18 09:25:54 +08:00
.sp
ncurses 5.3
2002-10-13 11:35:53 +08:00
\fBint mvin_wchstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR\fB);\fR
.br
\fBint mvin_wchnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
.br
\fBint mvwin_wchstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR\fB);\fR
.br
\fBint mvwin_wchnstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwchstr\fR, int \fIn\fR\fB);\fR
.fi
.SH DESCRIPTION
These functions return an array of complex characters in \fIwchstr\fR,
starting at the current cursor position in the named window.
Attributes (rendition) are stored with the characters.
.PP
The
\fBin_wchnstr\fR,
\fBmvin_wchnstr\fR,
\fBmvwin_wchnstr\fR
and
\fBwin_wchnstr\fR
fill the array
with at most
\fIn\fR
\fBcchar_t\fR
elements.
.br
.SH NOTES
Note that all routines except
\fBwin_wchnstr\fR
may be
macros.
.PP
Reading a line that overflows the array pointed to by
\fIwchstr\fR
with
\fBin_wchstr\fR,
\fBmvin_wchstr\fR,
\fBmvwin_wchstr\fR
or
\fBwin_wchstr\fR
ncurses 6.1 - patch 20180728 + improve documentation regarding feature-test macros in curses.h + improve documentation regarding the virtual and physical screens. + formatting fixes for manpages, regenerate man-html documentation.
2018-07-29 09:43:55 +08:00
causes undefined results.
Therefore, the use of
ncurses 5.3
2002-10-13 11:35:53 +08:00
\fBin_wchnstr\fR,
\fBmvin_wchnstr\fR,
\fBmvwin_wchnstr\fR, or
\fBwin_wchnstr\fR
is recommended.
ncurses 5.9 - patch 20121102 + realign these related pages: curs_add_wchstr.3x curs_addchstr.3x curs_addstr.3x curs_addwstr.3x and fix a long-ago error in curs_addstr.3x which said that a -1 length parameter would only write as much as fit onto one line (report by Reuben Thomas). + remove obsolete fallback _nc_memmove() for memmove()/bcopy(). + remove obsolete fallback _nc_strdup() for strdup(). + cancel any debug-rpm in package/ncurses.spec + reviewed vte-2012, reverted most of the change since it was incorrect based on testing with tack -TD + un-cancel the initc in vte-256color, since this was implemented starting with version 0.20 in 2009 -TD
2012-11-04 07:59:23 +08:00
.SH RETURN VALUE
ncurses 5.3
2002-10-13 11:35:53 +08:00
Upon successful completion, these functions return
\fBOK\fR.
Otherwise, they return
\fBERR\fR.
ncurses 5.7 - patch 20100814 + document in manpages that "mv" functions first use wmove() to check the window pointer and whether the position lies within the window (suggested by Poul-Henning Kamp). + fixes to curs_color.3x, curs_kernel.3x and wresize.3x manpages (patch by Tim van der Molen). + modify configure script to transform library names for tic- and tinfo-libraries so that those build properly with Mac OS X shared library configuration. + modify configure script to ensure that it removes conftest.dSYM directory leftover on checks with Mac OS X. + modify configure script to cleanup after check for symbolic links.
2010-08-15 08:45:51 +08:00
.PP
ncurses 6.1 - patch 20191130 + add portability section to curs_getcchar manpage (prompted by discussion with Nick Black). + improve portability discussion of ACS characters in curs_addch manpage. + improve typography for double-quotes in manpages.
2019-12-01 09:27:53 +08:00
Functions with a \*(``mv\*('' prefix first perform a cursor movement using
ncurses 5.7 - patch 20100814 + document in manpages that "mv" functions first use wmove() to check the window pointer and whether the position lies within the window (suggested by Poul-Henning Kamp). + fixes to curs_color.3x, curs_kernel.3x and wresize.3x manpages (patch by Tim van der Molen). + modify configure script to transform library names for tic- and tinfo-libraries so that those build properly with Mac OS X shared library configuration. + modify configure script to ensure that it removes conftest.dSYM directory leftover on checks with Mac OS X. + modify configure script to cleanup after check for symbolic links.
2010-08-15 08:45:51 +08:00
\fBwmove\fP, and return an error if the position is outside the window,
or if the window pointer is null.
ncurses 5.3
2002-10-13 11:35:53 +08:00
.SH PORTABILITY
The XSI Curses defines no error conditions.
This implementation checks for null pointers,
ncurses 6.0 - patch 20171125 + modify MKlib_gen.sh to avoid tracing result from getstr/getnstr before initialized. + add "-a" aspect-ratio option to picsmap. + add configure check for default path of rgb.txt, used in picsmap. + modify _nc_write_entry() to truncate too-long filename (report by Hosein Askari, Debian #882620). + build-fix for ncurses-examples with NetBSD curses: + it lacks the use_env() function. + it lacks libpanel; a recent change used the wrong ifdef symbol. + add a macro for is_linetouched() and adjust the function's return value to make it possible for most applications to check for an error-return (report by Midolikawa H). + additional manpage cleanup. + update config.guess, config.sub from http://git.savannah.gnu.org/cgit/config.git
2017-11-26 08:35:16 +08:00
returning \fBERR\fP in that case.
ncurses 5.3
2002-10-13 11:35:53 +08:00
.SH SEE ALSO
Functions:
\fBcurses\fR(3X),
ncurses 5.5
2005-10-10 02:41:57 +08:00
\fBcurs_in_wch\fR(3X),
ncurses 5.3
2002-10-13 11:35:53 +08:00
\fBcurs_instr\fR(3X),
\fBcurs_inwstr\fR(3X)
ncurses 5.6
2006-12-18 12:32:42 +08:00
\fBcurs_inchstr\fR(3X)
Reference in New Issue Copy Permalink