diff options
Diffstat (limited to 'man/curs_addch.3x')
| -rw-r--r-- | man/curs_addch.3x | 42 |
1 files changed, 28 insertions, 14 deletions
diff --git a/man/curs_addch.3x b/man/curs_addch.3x index c92d12b..43f426a 100644 --- a/man/curs_addch.3x +++ b/man/curs_addch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,7 +28,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addch.3x,v 1.51 2020/02/02 23:34:34 tom Exp $ +.\" $Id: curs_addch.3x,v 1.56 2021/06/17 21:30:22 tom Exp $ .TH curs_addch 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -48,17 +48,17 @@ .SH SYNOPSIS \fB#include <curses.h>\fR .PP -\fBint addch(const chtype ch);\fR +\fBint addch(const chtype \fP\fIch\fP\fB);\fR .br -\fBint waddch(WINDOW *win, const chtype ch);\fR +\fBint waddch(WINDOW *\fP\fIwin\fP\fB, const chtype \fP\fIch\fP\fB);\fR .br -\fBint mvaddch(int y, int x, const chtype ch);\fR +\fBint mvaddch(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const chtype \fP\fIch\fP\fB);\fR .br -\fBint mvwaddch(WINDOW *win, int y, int x, const chtype ch);\fR +\fBint mvwaddch(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const chtype \fP\fIch\fP\fB);\fR +.sp +\fBint echochar(const chtype \fP\fIch\fP\fB);\fR .br -\fBint echochar(const chtype ch);\fR -.br -\fBint wechochar(WINDOW *win, const chtype ch);\fR +\fBint wechochar(WINDOW *\fP\fIwin\fP\fB, const chtype \fP\fIch\fP\fB);\fR .br .SH DESCRIPTION .SS Adding characters @@ -94,11 +94,12 @@ scrolling the window if on the last line. Tabs are considered to be at every eighth column. The tab interval may be altered by setting the \fBTABSIZE\fR variable. .PP -If \fIch\fR is any other control character, it -is drawn in \fB^\fR\fIX\fR notation. +If \fIch\fR is any other nonprintable character, +it is drawn in printable form, +i.e., the \fB^\fR\fIX\fR notation used by \fBunctrl\fR(3X). Calling \fBwinch\fR after adding a -control character does not return the character itself, but instead returns -the ^-representation of the control character. +nonprintable character does not return the character itself, +but instead returns the printable representation of the character. .PP Video attributes can be combined with a character argument passed to \fBaddch\fR or related functions by logical-ORing them into the character. @@ -175,6 +176,19 @@ unless otherwise noted in the preceding routine descriptions. Functions with a \*(``mv\*('' prefix first perform a cursor movement using \fBwmove\fP, and return an error if the position is outside the window, or if the window pointer is null. +.PP +If it is not possible to add a complete character, +an error is returned: +.bP +If \fBscrollok\fR is not enabled, +writing a character at the lower right margin succeeds. +However, an error is returned because +it is not possible to wrap to a new line +.bP +If an error is detected when converting a multibyte character to a sequence +of bytes, +or if it is not possible to add all of the resulting bytes in the window, +an error is returned. .SH NOTES Note that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and \fBechochar\fR may be macros. @@ -229,7 +243,7 @@ to light. The ACS-prefixed names for them were invented for \fBncurses\fR(3X). .LP The \fIdisplayed\fP values for the \fIACS_\fP and \fIWACS_\fP constants -depend on +depend on .bP the library configuration, i.e., \fBncurses\fP versus \fBncursesw\fP, where the latter is capable of displaying Unicode while the former is not, and |